Requests, filtering and pagination

Every resource in the API follows the same REST conventions, so once you know them for one resource you know them for all.

Methods

OperationHTTPPathBody
ListGET/<resource>none, use the query string
Get oneGET/<resource>/:idnone
CreatePOST/<resource>JSON object
Update (partial)PATCH/<resource>/:idJSON with only the fields to change
DeleteDELETE/<resource>/:idnone
Custom actionPOST/<resource> + header X-Service-Method: <action>JSON for the action

DELETE
is a soft delete: the record gets a deleted_at timestamp and stops appearing in list and get responses.

Query string, never a body, on GET

GET
requests ignore any JSON body. Filters, sorting and pagination go in the query string. With curl, -G plus --data-urlencode builds it for you:

curl turns that into this URL:

https://integrations.achieveapex.com/contacts?email=jane%40example.com&$limit=25&$sort[created_at]=-1

Pagination

List endpoints return a page object:

json
ParameterDescription
$limitPage size. Default 10, maximum 50.
$skipNumber of records to skip. Next page: $skip = skip + limit while skip + limit < total.

Filtering

Filter by any field of the resource with field=value. Operators:

OperatorExampleMeaning
equalitystatus=openequals
$nestatus[$ne]=closednot equal
$in / $ninid[$in][]=1&id[$in][]=2in / not in a list
$gt $gte $lt $ltecreated_at[$gte]=2026-01-01T00:00:00Zcomparisons (numbers, dates)
$or$or[0][email]=a@x.com&$or[1][phone]=5551234any of the conditions

Sorting and selecting fields

ParameterExampleDescription
$sort[field]$sort[created_at]=-11 ascending, -1 descending. Several allowed.
$select[]$select[]=id&$select[]=emailReturn only these fields.

Unknown query parameters are rejected with 400 Bad Request. Text search and extra flags (for example searchTerm or fastJoinForContactList=true on contacts) exist only where a resource's List page documents them.

Dates, IDs and money

  • Dates are ISO 8601 strings in UTC, for example 2026-11-11T15:04:05.000Z.
  • IDs are integers unless a page says otherwise.
  • Monetary amounts are numbers in the record's currency; see the currency fields of each resource.

Custom fields

CRM resources (contacts, companies, deals, support tickets, reservations) return custom_fields_by_name and custom_fields_by_key. To set custom fields, send custom_fields_by_key (an object of field key to value) in POST/PATCH; set a value to null to clear it. custom_fields_by_name is read-only and is rebuilt from the keys. Discover the available fields with Custom fields.

Report an issue with this documentation

Please log in to report issues with our documentation.