CRM V4

Contacts

GET
/v1/crm-v4/contacts

Retrieve CRM V4 contacts with their primary company and owner.

Filters:

  • organizationId (required)
  • integrationId (optional)
  • companyId, ownerId

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string

Organization identifier (required)

integrationId?string

Integration identifier (optional)

companyId?string

Primary company identifier (optional)

ownerId?string

Owner (responsible user) identifier (optional)

page?integer

Page number (default: 1)

Range1 <= value
Default1
limit?integer

Results per page (default: 500, max: 5000)

Range1 <= value <= 5000
Default500

Response Body

Successful response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/crm-v4/contacts?organizationId=organization_123"
{  "data": [    {      "id": "string",      "name": "string",      "email": "string",      "phone": "string",      "secondary_phone": "string",      "tax_id": "string",      "position": "string",      "owner_id": "string",      "owner_name": "string",      "company_id": "string",      "company_name": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "tenant_id": "string",      "integration_id": "string",      "organization_id": "string",      "user_id": "string",      "document_id": "string",      "inserted_at": "2019-08-24T14:15:22Z",      "integration_name": "string"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}