Skip to main content
GET
/
leads
Listar leads
curl --request GET \
  --url https://api.cordialy.ai/integrations/v1/leads \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "store_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "customer_phone": "<string>",
      "seller_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "interaction_count": 123,
      "ai_paused_until": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123
}

Authorizations

​
X-API-Key
string
header
required

Chave de API gerada na plataforma em Integrações → API Keys

Query Parameters

​
status
enum<string>

Filtrar por status

Available options:
pending,
in_progress,
converted,
lost
​
seller_id
string<uuid>

Filtrar por vendedor

​
since
string<date-time>

Retorna leads criados/atualizados após esta data (ISO 8601)

​
page
integer
default:1
​
limit
integer
default:50
Required range: x <= 200

Response

200 - application/json

Lista de leads

​
data
object[]
​
total
integer
​
page
integer
​
limit
integer