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
| Operation | HTTP | Path | Body |
|---|---|---|---|
| List | GET | /<resource> | none, use the query string |
| Get one | GET | /<resource>/:id | none |
| Create | POST | /<resource> | JSON object |
| Update (partial) | PATCH | /<resource>/:id | JSON with only the fields to change |
| Delete | DELETE | /<resource>/:id | none |
| Custom action | POST | /<resource> + header X-Service-Method: <action> | JSON for the action |
Query string, never a body, on GET
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
| Parameter | Description |
|---|---|
$limit | Page size. Default 10, maximum 50. |
$skip | Number 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:
| Operator | Example | Meaning |
|---|---|---|
| equality | status=open | equals |
$ne | status[$ne]=closed | not equal |
$in / $nin | id[$in][]=1&id[$in][]=2 | in / not in a list |
$gt $gte $lt $lte | created_at[$gte]=2026-01-01T00:00:00Z | comparisons (numbers, dates) |
$or | $or[0][email]=a@x.com&$or[1][phone]=5551234 | any of the conditions |
Sorting and selecting fields
| Parameter | Example | Description |
|---|---|---|
$sort[field] | $sort[created_at]=-1 | 1 ascending, -1 descending. Several allowed. |
$select[] | $select[]=id&$select[]=email | Return 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.