logo
LeadsListar leads
Leads

Listar leads

Retorna uma lista paginada de leads. Você controla quais campos são retornados através do parâmetro fields (obrigatório).

Suporta filtros por status e datas de criação/atualização.

curl -X GET "https://sandbox-partner-api.keyspot.com.br/v1/leads?fields=id,name,email,phone,status,source,createdAt&page=25&limit=42&status=NEW_LEAD&createdAfter=2026-01-01T00:00:00Z&createdBefore=2024-12-25T10:00:00Z&updatedAfter=2026-03-01T00:00:00Z&updatedBefore=2024-12-25T10:00:00Z" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)"
{
  "data": [
    {
      "id": "clx1abc23def456",
      "name": "João Silva",
      "email": "joao@example.com",
      "phone": "11999999999",
      "status": "NEW_LEAD",
      "source": "WEBSITE",
      "createdAt": "2026-03-13T10:30:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}
GET
/v1/leads
GET
Bearer Token (JWT)
Bearer Tokenstring
Required

Token JWT obtido via POST /v1/auth/token. Válido por 1 hora.

Token JWT obtido via POST /v1/auth/token. Válido por 1 hora.
query
fieldsstring
Required

Campos a serem retornados, separados por vírgula. Use GET /v1/fields para consultar campos disponíveis. Exemplo: name,email,phone,status

query
pageinteger

Número da página (começa em 1)

Min: 1
query
limitinteger

Quantidade de itens por página (máximo 100)

Min: 1 • Max: 100
query
statusstring

Filtrar por status do lead

Options: NEW_LEAD, IN_SERVICE, VISIT_SCHEDULED, VISIT_COMPLETED, PROPOSAL_MADE, CONVERTED, LOST
query
createdAfterstring

Retornar leads criados após esta data (ISO 8601)

Format: date-time
query
createdBeforestring

Retornar leads criados antes desta data (ISO 8601)

Format: date-time
query
updatedAfterstring

Retornar leads atualizados após esta data (ISO 8601). Útil para sincronização incremental.

Format: date-time
query
updatedBeforestring

Retornar leads atualizados antes desta data (ISO 8601)

Format: date-time
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). Token JWT obtido via POST /v1/auth/token. Válido por 1 hora.

Query Parameters

fieldsstring
Required

Campos a serem retornados, separados por vírgula. Use GET /v1/fields para consultar campos disponíveis. Exemplo: name,email,phone,status

pageinteger

Número da página (começa em 1)

limitinteger

Quantidade de itens por página (máximo 100)

statusstring

Filtrar por status do lead

Allowed values:NEW_LEADIN_SERVICEVISIT_SCHEDULEDVISIT_COMPLETEDPROPOSAL_MADECONVERTEDLOST
createdAfterstring

Retornar leads criados após esta data (ISO 8601)

createdBeforestring

Retornar leads criados antes desta data (ISO 8601)

updatedAfterstring

Retornar leads atualizados após esta data (ISO 8601). Útil para sincronização incremental.

updatedBeforestring

Retornar leads atualizados antes desta data (ISO 8601)

Responses

dataarray
metaobject

Metadados de paginação