SYSLED DevelopersTodos os métodos
POST

leads.list

Lista leads com total real, contagem por status e paginação.

Grupo: LeadsRevisão: Escopo recomendado: leads.list
Exemplos seguros e fictícios. O domínio example.invalid e a credencial demonstrativa abaixo não funcionam. Use o token real somente no servidor da sua integração e nunca o inclua em páginas públicas.

Parâmetros

Parâmetros aceitos por leads.list
CampoTipoObrigatoriedadeDescriçãoExemplo fictício
statusstringOpcionalStatus: new, converted ou junk. Sem filtro inclui todos."new"
status_instring[] | string CSVOpcionalStatus aceitos; pode combinar com status.["new","converted"]
searchstringOpcionalBusca parcial em nome, título, telefone e e-mail."Exemplo"
assigned_tostring (uuid)OpcionalID do responsável."00000000-0000-4000-8000-000000000001"
assigned_to_instring[] | string CSVOpcionalIDs de responsáveis.["00000000-0000-4000-8000-000000000001"]
source_id_ininteger[] | string CSVOpcionalIDs de origens.[1,2]
created_fromstring (date/date-time)OpcionalData inicial inclusiva."2026-09-01"
created_tostring (date/date-time)OpcionalInclui até o dia final; implementação usa limite menor que data + 1 dia."2026-09-01"
junked_fromstring (date/date-time)OpcionalData inicial inclusiva."2026-09-01"
junked_tostring (date/date-time)OpcionalInclui até o dia final; implementação usa limite menor que data + 1 dia."2026-09-01"
converted_fromstring (date/date-time)OpcionalData inicial inclusiva."2026-09-01"
converted_tostring (date/date-time)OpcionalInclui até o dia final; implementação usa limite menor que data + 1 dia."2026-09-01"
opportunity_minnumberOpcionalValor mínimo inclusivo.100
opportunity_maxnumberOpcionalValor máximo inclusivo.2000
has_conversationbooleanOpcionaltrue com conversa; false sem conversa.true
pageintegerOpcionalPágina iniciada em 1; padrão 1.1
limitintegerOpcionalPadrão 50; máximo 200. Use valores positivos; limite negativo não é validado corretamente.50
order_bystringOpcionalcreated_at_desc (padrão), created_at_asc, opportunity_desc, opportunity_asc ou name_asc."created_at_desc"

Exemplos fictícios

Os exemplos documentam o formato; eles não executam nenhuma operação.

Requisição

cURL demonstrativo
curl --request POST \
  'https://example.invalid/api/v1/CREDENCIAL_FICTICIA_SEM_VALOR/leads.list' \
  --header 'Content-Type: application/json' \
  --data '{"status":"new","page":1,"limit":50}'
Corpo JSON
{
  "status": "new",
  "page": 1,
  "limit": 50
}
Resposta HTTP 200
{
  "ok": true,
  "method": "leads.list",
  "result": {
    "rows": [
      {
        "id": 101,
        "name": "Pessoa Exemplo",
        "status": "new",
        "opportunity": "1500.00",
        "phone": [
          {
            "value": "+5585000000000",
            "type": "WORK"
          }
        ],
        "email": [
          {
            "value": "pessoa@example.com",
            "type": "WORK"
          }
        ]
      }
    ],
    "total": 1,
    "by_status": {
      "new": 1,
      "converted": 0,
      "junk": 0
    },
    "page": 1,
    "limit": 50
  }
}

Erros

Não há uma condição de erro específica publicada para este método. Os erros globais de autenticação, permissão, limite e falha interna continuam aplicáveis.

Consulte também os erros globais e limites.

Observações