Skip to main content
GET
cURL with fictitious data

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id
string
required

UUID of the account associated with the operation.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Query Parameters

key_type
string

Filter by key type (case-insensitive)

Example:

"CPF"

key_value
string

Filter by key value

Example:

"52998224725"

page
string

Page number (1-based, default 1)

Example:

"1"

limit
string

Rows per page (default 10, max 100)

Example:

"10"

sort_order
string

Sort direction (default asc, case-insensitive)

Example:

"desc"

Response

OK

items
object[] | null
required
limit
integer<int64>
required
Example:

10

page
integer<int64>
required
Example:

1

total
integer<int64>
required
Example:

1