CRM V4
Leads
GET
Retorna leads do CRM V4 com etapa, temperatura, responsável e timestamps do ciclo de vida.
Filtros:
organizationId(obrigatório)integrationId(opcional)boardId,columnId,phaseTypetemperature,ownerIdcreatedStart,createdEnd
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)
boardId?stringIdentificador do board (pipeline) (opcional)
columnId?stringIdentificador da etapa (coluna) (opcional)
phaseType?stringTipo de fase da etapa (opcional)
temperature?stringTemperatura do lead (opcional)
ownerId?stringIdentificador do responsável (usuário) (opcional)
createdStart?stringInício do intervalo de data de criação (opcional)
Formato
date-timecreatedEnd?stringFim do intervalo de data de criação (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/leads?organizationId=organization_123"{ "data": [ { "id": "string", "board_id": "string", "title": "string", "company_name": "string", "email": "string", "phone": "string", "tax_id": "string", "temperature": "string", "column_id": "string", "column_title": "string", "phase_type": "string", "owner_id": "string", "owner_name": "string", "owner_email": "string", "company_nationality": "string", "company_revenue_tier": "string", "labels": "string", "virtual_deleted": true, "lost_reason": "string", "lost_description": "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 }}