Skip to main content
GET
Listar os contatos

Authorizations

Authorization
string
header
required

A chave de API da organização, no cabeçalho Authorization: Bearer <chave>. A chave começa com qx_.

Query Parameters

limit
integer
default:25

A quantidade de itens da página, de 1 a 100. O padrão é 25.

Required range: 1 <= x <= 100
cursor
string

O valor de next_cursor da página anterior. Sem este parâmetro, a lista começa no item mais novo.

tax_id
string

O CPF ou o CNPJ do contato, com ou sem pontuação.

email
string

O e-mail do contato. A busca compara o endereço inteiro e ignora a diferença entre maiúscula e minúscula.

name
string

Uma parte do nome do contato. A busca ignora a diferença entre maiúscula e minúscula.

type
enum<string>

Com person, a lista traz só as pessoas. Com company, a lista traz só as empresas.

Available options:
person,
company
created_from
string<date>

A primeira data de criação, no formato AAAA-MM-DD. A data usa o fuso horário da organização, e o dia inteiro entra na lista.

created_to
string<date>

A última data de criação, no formato AAAA-MM-DD. A data usa o fuso horário da organização, e o dia inteiro entra na lista.

Response

Uma página de contatos.

data
object[]
required
has_more
boolean
required

Com true, a lista tem mais itens depois desta página.

next_cursor
string | null
required

O valor do parâmetro cursor para a próxima página. Na última página, o valor é null.