Skip to content

API Endpoints

CRUD Operations

Read Record (GET)

GET /api/v1/{entityType}/{id}

Parameters:

Parameter Type Description
entityType string Entity type (Contact, Account...)
id string Record ID

Response:

{
  "id": "123abc",
  "name": "John Doe",
  "emailAddress": "john@example.com",
  "phoneNumber": "+420123456789",
  "createdAt": "2024-01-15T10:30:00+01:00",
  "modifiedAt": "2024-01-20T14:45:00+01:00"
}

List Records (GET)

GET /api/v1/{entityType}

Query Parameters:

Parameter Type Description Example
select string Fields to return select=id,name,email
where array Filter conditions where[0][type]=equals&where[0][attribute]=status&where[0][value]=Active
orderBy string Sort field orderBy=createdAt
order string Sort direction order=desc
offset integer Starting position offset=0
maxSize integer Max. record count maxSize=50

Response:

{
  "total": 150,
  "list": [
    {
      "id": "123abc",
      "name": "John Doe"
    },
    {
      "id": "456def",
      "name": "Jane Smith"
    }
  ]
}

Create Record (POST)

POST /api/v1/{entityType}

Request Body:

{
  "name": "John Doe",
  "emailAddress": "john@example.com",
  "phoneNumber": "+420123456789",
  "accountId": "acc123"
}

Response:

{
  "id": "789ghi",
  "name": "John Doe",
  "emailAddress": "john@example.com",
  "createdAt": "2024-01-25T09:00:00+01:00"
}

Update Record (PUT)

PUT /api/v1/{entityType}/{id}

Request Body:

{
  "phoneNumber": "+420987654321",
  "description": "Updated description"
}

Delete Record (DELETE)

DELETE /api/v1/{entityType}/{id}

Response: 200 OK (empty body)

Relationships

GET /api/v1/{entityType}/{id}/{link}

Example:

GET /api/v1/Account/123/contacts

POST /api/v1/{entityType}/{id}/{link}

Request Body:

{
  "id": "contact456"
}

DELETE /api/v1/{entityType}/{id}/{link}

Query Parameter:

?id=contact456

Bulk Operations

Mass Update

PUT /api/v1/{entityType}/action/massUpdate

Request Body:

{
  "ids": ["id1", "id2", "id3"],
  "attributes": {
    "status": "Active",
    "assignedUserId": "user123"
  }
}

Mass Delete

POST /api/v1/{entityType}/action/massDelete

Request Body:

{
  "ids": ["id1", "id2", "id3"]
}

Special Actions

Lead Conversion

POST /api/v1/Lead/{id}/action/convert

Request Body:

{
  "records": {
    "Account": {
      "name": "New Company"
    },
    "Contact": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "Opportunity": {
      "name": "New Opportunity",
      "amount": 100000
    }
  }
}

Send Email

POST /api/v1/Email

Request Body:

{
  "to": "recipient@example.com",
  "subject": "Email Subject",
  "body": "<p>Email content in HTML</p>",
  "isHtml": true,
  "parentType": "Contact",
  "parentId": "contact123"
}