Skip to main content
GET
List the contacts

Authorizations

Authorization
string
header
required

The API key of the organization, in the Authorization: Bearer <key> header. The key starts with qx_.

Query Parameters

limit
integer
default:25

The number of items on the page, from 1 to 100. The default is 25.

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

The next_cursor value of the previous page. Without this parameter, the list starts at the newest item.

tax_id
string

The CPF or the CNPJ of the contact, with or without punctuation.

email
string

The email of the contact. The search compares the full address and ignores the difference between uppercase and lowercase.

name
string

A part of the name of the contact. The search ignores the difference between uppercase and lowercase.

type
enum<string>

With person, the list includes only the people. With company, the list includes only the companies.

Available options:
person,
company
created_from
string<date>

The first creation date, in the YYYY-MM-DD format. The date uses the time zone of the organization, and the list includes the whole day.

created_to
string<date>

The last creation date, in the YYYY-MM-DD format. The date uses the time zone of the organization, and the list includes the whole day.

Response

A page of contacts.

data
object[]
required
has_more
boolean
required

With true, the list has more items after this page.

next_cursor
string | null
required

The value of the cursor parameter for the next page. On the last page, the value is null.