CRM V4

Contatos

GET
/v1/crm-v4/contacts

Retorna contatos do CRM V4 com sua empresa principal e responsável.

Filtros:

  • organizationId (obrigatório)
  • integrationId (opcional)
  • companyId, ownerId

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Identificador da organização (obrigatório)

integrationId?string

Identificador da integração (opcional)

companyId?string

Identificador da empresa principal (opcional)

ownerId?string

Identificador do responsável (usuário) (opcional)

page?integer

Número da página (padrão: 1)

Intervalo1 <= value
Padrão1
limit?integer

Resultados por página (padrão: 500, máx.: 5000)

Intervalo1 <= value <= 5000
Padrão500

Corpo da resposta

Resposta de sucesso

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  }}