Endpoint

Listar clientes

GET/api/v1/{escritorio}/clientes

Lista os clientes e os leads, do mais recentemente atualizado ao mais antigo. Com Atendimento: Acessar, todos; só com Operacional: Acessar, os clientes que têm processo em departamento que a pessoa alcança, sem documento nem celular (para ver, use ler_cliente). q procura por nome, código, CPF, CNPJ ou celular.

Permissão exigida

Ficha do cliente: Acessar; com Atendimento: Acessar, todos os clientes, senão só os com processo no alcance

Parâmetros de caminho

escritoriotextoobrigatório
Código do escritório, com 5 dígitos. Os escritórios em que o token vale estão em GET /api/v1/eu.

Parâmetros de consulta

qtexto
Texto a procurar.
limitnúmero inteiro
Quantos itens vir por vez (1 a 100; padrão 50).
Padrão: 50
cursortexto
O proximo da resposta anterior, para ver a página seguinte.

Testar

Exemplo

cURL

curl -X GET "https://developer.jur.ia2s.com.br/api/v1/10345/clientes" \
  -H "Authorization: Bearer SEU_TOKEN"

Node

// Node 18 ou mais novo, em um arquivo .mjs
const resposta = await fetch("https://developer.jur.ia2s.com.br/api/v1/10345/clientes", {
  method: "GET",
  headers: {
    Authorization: "Bearer SEU_TOKEN",
  },
});
console.log(resposta.status, await resposta.json());

Python

import requests

resposta = requests.get(
    "https://developer.jur.ia2s.com.br/api/v1/10345/clientes",
    headers={"Authorization": "Bearer SEU_TOKEN"},
)
print(resposta.status_code)
print(resposta.json())

Respostas

200

Sucesso.

{
  "itens": [
    {
      "codigo": "EX-0001",
      "nome": "Maria Oliveira",
      "tipo": "PF",
      "documento": null,
      "celular": "11900000000",
      "areaId": "0190a000-0000-7000-8000-000000000002",
      "statusId": "0190a000-0000-7000-8000-000000000001",
      "contratoEm": null,
      "atualizadoEm": "2026-11-06T12:00:00.000Z"
    }
  ],
  "proximo": null
}

Campos da resposta

itenslista de objetosobrigatório
- codigotextoobrigatório
- nometextoobrigatório
  Nome, ou razão social na pessoa jurídica.
- tipotextoobrigatório
  Valores: PFPJ
- documentotexto ou nulo
  CPF ou CNPJ, só dígitos. Fora da lista de quem só tem Operacional.
- celulartexto ou nulo
  Fora da lista de quem só tem Operacional.
- areaIdtexto ou nuloobrigatório
- statusIdtextoobrigatório
- contratoEmtexto ou nuloobrigatório
- atualizadoEmtextoobrigatório
proximotexto ou nuloobrigatório
Cursor da página seguinte; nulo na última.

400

Corpo ou parâmetro inválido.

INVALIDO

{
  "codigo": "INVALIDO",
  "mensagem": "Confira os dados informados.",
  "campos": {
    "departamentoId": "Valor inválido."
  }
}

CHAVE_IDEMPOTENCIA_INVALIDA

{
  "codigo": "CHAVE_IDEMPOTENCIA_INVALIDA",
  "mensagem": "A Idempotency-Key deve ter de 1 a 255 caracteres visíveis, sem espaços."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

401

Sem token, ou token revogado ou expirado, ou pessoa desativada.

TOKEN_INVALIDO

{
  "codigo": "TOKEN_INVALIDO",
  "mensagem": "Token de API inválido, expirado ou revogado."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

403

A pessoa não pode fazer isto, o token é só de leitura, foi bloqueado neste escritório, não tem esta operação, quem o gerou saiu do escritório ou o acesso ao escritório está suspenso.

SEM_PERMISSAO

{
  "codigo": "SEM_PERMISSAO",
  "mensagem": "Sem permissão para esta alteração."
}

TOKEN_SO_LEITURA

{
  "codigo": "TOKEN_SO_LEITURA",
  "mensagem": "Este token é só de leitura."
}

TOKEN_SEM_ESCOPO

{
  "codigo": "TOKEN_SEM_ESCOPO",
  "mensagem": "Este token não tem permissão para esta operação."
}

TOKEN_BLOQUEADO

{
  "codigo": "TOKEN_BLOQUEADO",
  "mensagem": "Este token foi bloqueado pela administração deste escritório."
}

TOKEN_AUTOR_INATIVO

{
  "codigo": "TOKEN_AUTOR_INATIVO",
  "mensagem": "Quem gerou este token não está mais ativo neste escritório."
}

ESCRITORIO_SUSPENSO

{
  "codigo": "ESCRITORIO_SUSPENSO",
  "mensagem": "O acesso a este escritório está suspenso. Fale com a IA2S."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

404

Não existe, está fora do alcance da pessoa, ou o escritório do caminho não é dela.

NAO_ENCONTRADO

{
  "codigo": "NAO_ENCONTRADO",
  "mensagem": "Não encontrado."
}

ESCRITORIO_NAO_ENCONTRADO

{
  "codigo": "ESCRITORIO_NAO_ENCONTRADO",
  "mensagem": "Escritório não encontrado."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

409

Conflito: veja o campo `codigo`.

TENTE_NOVAMENTE

{
  "codigo": "TENTE_NOVAMENTE",
  "mensagem": "Outra pessoa alterou isto ao mesmo tempo. Tente novamente."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

429

Limite de 120 requisições por minuto.

Cabeçalho Retry-After: Segundos até poder tentar de novo.

LIMITE_TOKEN

{
  "codigo": "LIMITE_TOKEN",
  "mensagem": "Muitas requisições com este token. Tente de novo em um minuto."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

503

O sistema está ocupado. Tente em instantes.

SISTEMA_OCUPADO

{
  "codigo": "SISTEMA_OCUPADO",
  "mensagem": "O sistema está ocupado. Tente em instantes."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório