Skip to main content
GET
List customers
Page with limit and next: pass the next cursor of one page to get the following one; the last page has no next. Sort with order and orderBy. search looks for the text, case-insensitively, anywhere in the customer’s name, trade name or document, and in the text values of its custom fields (a number or yes/no value is never matched). A term with at least one letter is searched as typed. A term with no letter keeps only its digits, so a CPF typed as 529.982.247-25 finds the stored 52998224725, and 10-20 is searched as 1020. documents looks up up to 100 documents at once, comma-separated: ?documents=52998224725,11144477735 (repeating the parameter works too). A repeated document counts once, more than 100 is rejected and a blank value is ignored. It combines with search, status and documentType, but it answers every match in one response, oldest first and with no next: limit, next, order and orderBy don’t apply.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose customers you want to list.

Format: UUID

Query Parameters

Free-text search over the customer's name, trade name, document and the text values of its custom fields (case-insensitive, any part of the text).

status
enum<string>[]

Only customers in one of these statuses.


Example (comma-separated list): ?status=ACTIVE,DEACTIVATED

Available options:
ACTIVE,
DEACTIVATED
documentType
enum<string>[]

Only customers whose document is of one of these kinds: CPF (people) or CNPJ (companies).


Example (comma-separated list): ?documentType=CPF,CNPJ

Available options:
CPF,
CNPJ
documents
string[]

Only the customers with these documents (exact match, CPF or CNPJ without formatting).


Example (comma-separated list): ?documents=52998224725,11144477735

Required array length: 1 - 100 elements
Minimum string length: 1
order
enum<string>
default:ASC

Sort direction: ASC (oldest first, by default) or DESC.

Available options:
ASC,
DESC
orderBy
string
default:createdAt

Name of the customer field to sort by. Defaults to createdAt.

limit
number
default:25

Page size. Defaults to 25.

next
string

Cursor returned as next by the previous page. Omit it to get the first page.

Response

Successful response

A page of customers.

items
object[]
required

The customers of this page.

next
string

Cursor for the next page: pass it as next to get it. Absent on the last page, and when the list was filtered by documents.

Example:

"NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy"