Skip to main content

List/search records of an entity

GET 
/v1/objects/:entity

List or search records of a CRM entity — contacts, companies, deals, tasks and the rest all share this one endpoint, with {entity} naming the object you want.

Page with limit (up to 200) and offset, order with sort and order, and search every text field at once — custom fields included — with q.

Arbitrary field filters are expressed as query parameters of the form ?field__op=value: ?lead_score__gte=50, ?lead_status__in=new,qualified, ?cf.tier=gold for a custom field. Filters are combined with AND by default; pass match=any to OR them instead.

Requires the matching {entity}:read scope.

Request​

Responses​

A page of records

Last updated on