Integration: API V4

All GET requests are limited to 100 records at a time and defaulted to 10. You can change this limit by passing limit in the URL.

GET /accounts?limit=50
      

Due to the limits above, you can also pass a page number.

GET /accounts?page=2
      

This will return your accounts starting from the 20th record by default. You can combine limits and pages together to get more results for a particular page.

GET /accounts?limit=100&page=4
      

This will return your accounts starting at the 400th record.

If the page cannot be found, no records will be returned.

You can return the line items for an opportunity inline under the key of ‘lines’ by passing the request parameter of lines=true

GET /opportunities?lines=true
      

GET /opportunities/{id}?lines=true
      

The returned JSON will include the ‘lines’ key similar to below.

"lines": [
  {
    "id": 1,
    "opportunityid": 1,
    "product": "User Subscription",
    "quantity": 30,
    "unitprice": 420
  }
]
      

Filtering is as simple as sending a request with the query parameter set in the URL. The parameter consists of fields and operators in JSON format that make up a complete query. The field or fields you provide must match a field in the object’s data dictionary.

Quick example:

GET /accounts?q={"name": "Test"}
      

Which is the same as asking for all accounts with the name “Test”.

You can match on a single field:

?q={"name": "Test"}
      

Or you can match on multiple fields:

?q={"name": "Test", "sector": "Design"}
      

In addition to simple fields, you can use special operators to provide more complex queries.

The following logic operators can be used in queries:

The following conditional operators can be used in queries:

You can pass in the query parameter of ?order to order the results. This needs to be in JSON format and consist of a field and direction. The direction can be either asc (ascending) or desc (descending).

Quick example:

GET /accounts?order={"field": "asc"}
      

You can order by many fields by passing multiple into the query.

GET /accounts?order={"field": "asc", "field2": "asc", ...}
      

This will only ever return information to you.

To get a list of all your records for a certain type, send a GET request for the record using the object name.

GET /{object_name}
      

Above will return a list of all your accounts based on your permission level.

GET /{object_name}/12345
      

Above will return the record which has the ID of 12345 or nothing. Refer to the example tab above to see what this would look like.

You can use POST requests when you wish to create records. You POST a JSON encoded string to the servers and it will return a single instance of the record.

POST /{object_name}
      

If all the validation and subscription limit checks pass, the newly created record will be returned. Refer to the example tab above to see what this would look like.

N.B. It is required to include all mandatory fields in an API call which creates a new CRM record, via POST.

These are used to update records that already exist within your CRM system. It still requires a JSON encoded string to be submitted to the servers, but the URL must include the ID of the record to be updated.

PATCH /{object_name}/123456
      

Without the ID, the request will fail.

If the request is successful, a single instance of the record will be returned.

Similar to a PATCH request, but this doesn’t need any content. It just needs the ID of the record you wish to delete.

DELETE /{object_name}/12345
      

The request will fail without the ID.

If successful, it will also not return any content, just a status code of 200.

GET /accounts

POST /accounts
{
  "name": "testing API",
  "ownerid": 1
}

PATCH /accounts/95950731
{
  "name": "testing API Updated"
}

DELETE /accounts/95950731