Sales CRMCompanies

Get all Companies

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

filtersstringOptional

Filter by attrbutes. If you have filter for owner on your side please send it as {“attributes.owner”:“6299dcf3874a14eacbc65c46”}

linkedContactsIdslongOptional
Filter by linked contacts ids
linkedDealsIdsstringOptionalformat: "objectID"
Filter by linked Deals ids
modifiedSincestringOptional

Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

createdSincestringOptional

Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

pagelongOptional
Index of the first document of the page
limitlongOptional
Number of documents per page
sortenumOptional

Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed

Allowed values:
sortBystringOptional
The field used to sort field names.

Response

Returns companies list with filters
itemslist of objects or null
List of companies

Errors