List Leads
Em desenvolvimento
GET
https://{{baseUrl}}/v1/account/{accountId}/lead
Requisição
Authorization
Adicionar parâmetro em header
X-API-Key
Exemplo:
X-API-Key: ********************Parâmetros de Caminho
Parâmetros de Consulta
Códigos de solicitação
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://{{baseUrl}}/v1/account/{{accountId}}/lead?from=2025-01-01T00:00:00Z&pagination.limit=10&pagination.page=1&to=2025-02-01T00:00:00Z' \
--header 'X-API-Key: <api-key>'Respostas
🟢200Success
application/json
Body
Exemplo
{
"data": [
{
"accountId": "string",
"activities": [
{
"accountId": "string",
"attributionUser": {
"accountId": "string",
"email": "string",
"globalAutoAttributionDisabled": true,
"id": "string",
"isRealUser": true,
"phoneNumber": "string",
"userId": "string",
"userName": "string"
},
"completedAt": 0,
"createdAt": 0,
"description": "string",
"dueAt": 0,
"id": "string",
"isComplete": true,
"kind": "string",
"leadId": "string",
"name": "string",
"referenceLead": {
"accountId": "string",
"attributionUser": {
"accountId": "string",
"email": "string",
"globalAutoAttributionDisabled": true,
"id": "string",
"isRealUser": true,
"phoneNumber": "string",
"userId": "string",
"userName": "string"
},
"email": "string",
"leadId": "string",
"name": "string",
"phoneNumber": "string",
"source": "string",
"status": "string",
"type": "string"
}
}
],
"address": "string",
"aiData": {
"hasCollectedData": true,
"isActive": true
},
"callAudioUrl": "string",
"callDuration": 0,
"callId": "string",
"callStatus": "string",
"campaignIdData": {
"ctwaClid": "string",
"hasCtwaClid": true,
"hasFacebookLeadId": true,
"hasGoogleLeadId": true
},
"cnpj": "string",
"companyName": "string",
"conversionSteps": {
"property1": true,
"property2": true
},
"conversionStepTimestamps": {
"property1": 0,
"property2": 0
},
"cpf": "string",
"createdDate": 0,
"customLeadSourceId": "string",
"customLeadTypeId": "string",
"deletedAt": 0,
"department": {
"accountId": "string",
"id": "string",
"name": "string",
"unitId": "string"
},
"dialog360Info": {
"channelId": "string",
"expadAccountId": "string",
"expadLeadId": "string",
"lastLeadMessageAt": 0,
"name": "string",
"phoneNumber": "string",
"unreadCount": 0
},
"duplicate": 0,
"email": "string",
"facebookAdgroupId": "string",
"facebookAdId": "string",
"facebookAdsPixelData": "string",
"facebookFormId": "string",
"facebookFormName": "string",
"facebookLeadId": "string",
"facebookPageId": "string",
"facebookPageName": "string",
"fields": [
{
"id": "string",
"leadId": "string",
"name": "string",
"value": "string"
}
],
"formId": "string",
"googleAdgroupId": 0,
"googleCampaignId": 0,
"googleCreativeId": 0,
"googleFormId": 0,
"googleLeadId": "string",
"hasAttributionUser": true,
"hasLeadCalls": true,
"hasLeadMessages": true,
"helenaLastSessionId": "string",
"id": "string",
"interest": {
"accountId": "string",
"departmentId": "string",
"id": "string",
"name": "string",
"unitId": "string"
},
"keyword": "string",
"lastMessage": {
"audio": {
"hasTranscription": true,
"transcription": "string",
"url": "string"
},
"contact": {
"company": "string",
"email": "string",
"name": "string",
"phoneNumber": "string",
"url": "string"
},
"content": "string",
"createdAt": 0,
"file": {
"id": "string",
"lengthSeconds": 0,
"mimeType": "string",
"sizeBytes": 0,
"url": "string"
},
"id": "string",
"leadId": "string",
"messageSender": "string",
"messageType": "string",
"through": "string"
},
"leadActivityReason": {
"id": "string",
"name": "string"
},
"leadAttributionUser": {
"accountId": "string",
"email": "string",
"globalAutoAttributionDisabled": true,
"id": "string",
"isRealUser": true,
"phoneNumber": "string",
"userId": "string",
"userName": "string"
},
"leadCart": {
"leadProducts": [
{
"amount": 0,
"product": {
"id": "string",
"name": "string",
"value": 0
},
"value": 0
}
],
"value": 0
},
"leadDate": 0,
"leadLossReson": {
"id": "string",
"name": "string"
},
"markedForDeletion": true,
"name": "string",
"navEndedAt": 0,
"navStartedAt": 0,
"note": "string",
"phoneNumber": "string",
"referrer": "string",
"saleValue": 0,
"source": "CUSTOM",
"startUrl": "string",
"status": "string",
"tags": [
{
"accountId": "string",
"color": "string",
"createdAt": 0,
"id": "string",
"name": "string"
}
],
"thermometer": "string",
"through": "string",
"type": "LEAD_TYPE_UNSPECIFIED",
"unit": {
"accountId": "string",
"id": "string",
"name": "string"
},
"userAgent": "string",
"utmCampaign": "string",
"utmContent": "string",
"utmMedium": "string",
"utmSource": "string",
"utmTerm": "string"
}
],
"found": 0,
"pages": 0
}Modificado em 2025-09-27 19:52:21