CRM V4
Empresas
GET
Retorna empresas do CRM V4 com segmento, faixa de receita, responsável e dados de atividade.
Filtros:
organizationId(obrigatório)integrationId(opcional)segment,tierType,ownerIdlastActivityStart,lastActivityEnd
ClientIdAuthClientSecretAuthheader
x-client-id<token>Client ID
header
x-client-secret<token>Client secret
organizationId*stringIdentificador da organização (obrigatório)
integrationId?stringIdentificador da integração (opcional)
segment?stringSegmento da empresa (opcional)
tierType?stringTipo de faixa de receita (opcional)
ownerId?stringIdentificador do responsável (usuário) (opcional)
lastActivityStart?stringInício do intervalo da última atividade (opcional)
Formato
date-timelastActivityEnd?stringFim do intervalo da última atividade (opcional)
Formato
date-timepage?integerNúmero da página (padrão: 1)
Intervalo
1 <= valuePadrão
1limit?integerResultados por página (padrão: 500, máx.: 5000)
Intervalo
1 <= value <= 5000Padrão
500Resposta de sucesso
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 }}