Pular para o conteúdo principal
GET
/
leads
Listar leads
curl --request GET \
  --url https://api.meuassistente.rdstationmentoria.com.br/rest/leads \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "agentId": null,
      "name": null,
      "email": null,
      "phone": null,
      "company": null,
      "site": null,
      "custom": {},
      "utm": {},
      "capture": "completed",
      "createdAt": "2025-11-26T20:01:11.950Z",
      "updatedAt": "2025-11-26T20:01:11.950Z"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "size": 123,
    "first": 123,
    "last": 123,
    "next": 123,
    "previous": 123
  }
}

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

page
number
padrão:1

Número da página

Intervalo obrigatório: x >= 1
size
number
padrão:20

Tamanho da página

Intervalo obrigatório: 1 <= x <= 100

Termo de pesquisa (full-text search)

name
string

Nome

email
string

Email

phone
string

Telefone

orderBy
padrão:createdAtDesc

Ordenação da lista de leads

createdAtStart
string<date-time>

Data de criação

agentId
string

Identificador do assistente

capture
enum<string>

Status da captura de dados do lead

Opções disponíveis:
completed,
partial

Resposta

Successful response

Página de registros

data
object[]
obrigatório

Lista de registros da página

meta
object
obrigatório

Metadados da página