CRM V4
Companies
GET
Retrieve CRM V4 companies with segment, revenue tier, owner, and activity data.
Filters:
organizationId(required)integrationId(optional)segment,tierType,ownerIdlastActivityStart,lastActivityEnd
ClientIdAuthClientSecretAuthheader
x-client-id<token>Client ID
header
x-client-secret<token>Client secret
organizationId*stringOrganization identifier (required)
integrationId?stringIntegration identifier (optional)
segment?stringCompany segment (optional)
tierType?stringRevenue tier type (optional)
ownerId?stringOwner (responsible user) identifier (optional)
lastActivityStart?stringLast activity range start (optional)
Format
date-timelastActivityEnd?stringLast activity range end (optional)
Format
date-timepage?integerPage number (default: 1)
Range
1 <= valueDefault
1limit?integerResults per page (default: 500, max: 5000)
Range
1 <= value <= 5000Default
500Successful response
application/json- response
data?array<>meta?curl -X GET "https://example.com/v1/crm-v4/companies?organizationId=organization_123"{ "data": [ { "id": "string", "name": "string", "legal_name": "string", "tax_id": "string", "email": "string", "site": "string", "address": "string", "tier_type": "string", "revenue": "string", "segment": "string", "owner_id": "string", "owner_name": "string", "opportunity_count": 0, "contacts_count": 0, "last_activity": "2019-08-24T14:15:22Z", "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 }}