Skip to content
API/
/v1

Retornar as pessoas por filtro

Request

Permite consultar as pessoas cadastradas, com suporte a filtros como página, tamanho, ordenação, busca por nome, documento, email, tipo de perfil, entre outros. Essa funcionalidade facilita a listagem, o monitoramento de pessoas no sistema.

Security
BearerAuth
Query
paginainteger

Página

Default:1
tamanho_paginainteger

Tamanho da página

Default:10
Enum:1020501002005001000
tipo_ordenacaostring

Tipo de ordenação

Default:"NOME"
Enum:"NOME""EMAIL""DOCUMENTO""ATIVO"
ordem_ordenacaostring

Ordem de ordenação

Default:"ASC"
Enum:"ASC""DESC"
buscastring

Busca textual pelo documento ou nome do cliente/empresa

idsstring

IDs das pessoas

documentosstring

Documentos das pessoas (CPF/CNPJ)

paisesstring

Países das pessoas

cidadesstring

Cidades das pessoas

ufsstring

Abreviações das unidades federativas (estados) das pessoas

codigos_pessoastring

Códigos de cadastro das pessoas

emailsstring

Emails das pessoas

tipos_pessoastring

Tipos de pessoa

Default:"Física"
Enum:"Física""Jurídica""Estrangeira"
nomesstring

Nomes das pessoas, pode ser pessoa física, jurídica ou estrangeira

telefonesstring

Telefones das pessoas

data_criacao_iniciostring

Data de início para filtrar pessoas criadas a partir dessa data, obrigatório se data_criacao_fim for preenchido

data_criacao_fimstring

Data de fim para filtrar pessoas criadas até essa data, obrigatório se data_criacao_inicio for preenchido

data_alteracao_destring

Data de alteracao de (ISO 8601, São Paulo/GMT-3)

data_alteracao_atestring

Data de alteracao até (ISO 8601, São Paulo/GMT-3)

tipo_perfilstring

Tipo de perfil da pessoa

Default:"Cliente"
Enum:"Cliente""Fornecedor""Transportadora"
com_enderecoboolean

Indica se deve retornar pessoas com endereço

Default:false
curl -i -X GET \
  'https://api-v2.contaazul.com/v1/pessoas?pagina=1&tamanho_pagina=10&tipo_ordenacao=NOME&ordem_ordenacao=ASC&busca=string&ids=string&documentos=string&paises=string&cidades=string&ufs=string&codigos_pessoa=string&emails=string&tipos_pessoa=F%C3%ADsica&nomes=string&telefones=string&data_criacao_inicio=string&data_criacao_fim=string&data_alteracao_de=string&data_alteracao_ate=string&tipo_perfil=Cliente&com_endereco=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
itemsArray of objects(ItemResumoDePessoasPorFiltro)

Lista de itens do resumo de pessoas

totalItemsinteger

Total de itens encontrados

Example:150
Response
{
  "items": [
    { … }
  ],
  "totalItems": 150
}