Listar pessoas

GET /person

Listar pessoas

cURL

curl --request GET \
  --url https://api.juridiq.com.br/person/ \
  --header 'x-juridiq-api-key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "personOrigin": "<string>",
      "isPrivate": true,
      "ownerId": "<string>",
      "legalRepresentant": "<string>",
      "corretor": "<string>",
      "code": "<string>",
      "govPassword": "<string>"
    }
  ],
  "totalResults": 123,
  "totalPages": 123
}

Authorizations

x-juridiq-api-key · string · header · required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key.

Query Parameters

page · string

Página. Começa em 1

limit · string

Itens por página

name · string

Filtra por nome

type · string

Filtra por origem

phone · string

Filtra por telefone

email · string

Filtra por e-mail

document · string

Filtra por documento

code · string

Filtra por código

orderBy · enum<string>

Ordenação. asc ou desc

Available options: asc, desc

orderByField · string

Campo de ordenação. createdAt, updatedAt, name, email

fullQuery · string

true para resposta completa com processos e tarefas

isPrivate · string

true ou false

legalRepresentant · string

Filtra por representante legal

ownerId · string

Filtra por ID do responsável

corretor · string

Filtra por corretor

tag · string string[]

ID da tag ou lista de IDs

Response

200

application/json

Default Response

data · object[] · required

Lista de pessoas

Show child attributes

totalResults · number · required

Total de registros

totalPages · number · required

Total de páginas