Contacts
List contacts
Retrieves a paginated list of contacts sorted newest first. Requires crm:read scope.
GET
List Contacts
Retrieves a paginated list of contacts sorted newest first.
Query parameters
page(integer, optional): The page number to retrieve. Defaults to1.limit(integer, optional): The number of records to return per page. Defaults to20. Maximum permitted limit is200.search(string, optional): A keyword matching contact name, email, or phone.
Required permissions
Requires an API key with thecrm:read scope.Authorizations
Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.
Query Parameters
Page number to retrieve
Number of records per page (default: 20, max: 200)
Required range:
x <= 200Search keyword matching contact name, email, or phone
Response
Contacts retrieved successfully
Standard envelope returned by all GET (read) endpoints
List Contacts
