Skip to main content
GET
Listar pessoas

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.1.

Parâmetros de consulta

page
integer
padrão:1

Número da página.

Intervalo necessário: x >= 1
per_page
integer
padrão:50

Quantidade de registros por página. Máximo: 50.

Intervalo necessário: 1 <= x <= 50
order_by
enum<string>
padrão:created_at

Campo para ordenação.

Opções disponíveis:
created_at,
updated_at,
full_name
order
enum<string>
padrão:desc

Direção da ordenação.

Opções disponíveis:
asc,
desc
full_name
string

Filtrar por nome (contém, sem distinção de maiúsculas).

email
string<email>

Filtrar por endereço de e-mail (contém). Busca parcial em todos os e-mails do contato.

phone
string

Filtrar por número de telefone (contém). Busca parcial em todos os telefones do contato.

company_id
string<uuid>

Filtrar por UUID de empresa. Retorna apenas pessoas vinculadas à empresa informada.

has_email
boolean

Filtrar para retornar apenas pessoas que possuem email (true) ou que não possuem email (false).

has_phone
boolean

Filtrar para retornar apenas pessoas que possuem telefone (true) ou que não possuem telefone (false).

created_after
string<date-time>

Retorna registros criados a partir desta data ISO 8601.

created_before
string<date-time>

Retorna registros criados até esta data ISO 8601.

updated_after
string<date-time>

Retorna registros atualizados a partir desta data ISO 8601.

updated_before
string<date-time>

Retorna registros atualizados até esta data ISO 8601.

Resposta

Pessoas retornadas com sucesso.

data
object[]
meta
object