Skip to main content
GET
List All Pix Entries

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id
string<uuid>
required

Account ID (UUID format) - required

Query Parameters

page
integer<int64>
default:1

Page number for pagination (default: 1, minimum: 1)

limit
integer<int64>
default:10

Maximum number of items per page (default: 10, range: 1-100)

key_type
string

Filter by key type: CPF, CNPJ, EMAIL, PHONE, EVP

key_value
string

Filter by key value (e.g., email address or phone number)

id
string<uuid>

Filter by entry ID (UUID format)

status
string[]

Filter by operational status (comma-separated, OR-matched): ACTIVE, INACTIVE

sort_order
string

Sort direction: asc or desc (default: asc)

Response

OK

items
object[]
required

Array of entries for the current page

limit
integer<int64>
required

Number of items per page

Example:

10

page
integer<int64>
required

Current page number

Example:

1

total
integer<int64>
required

Total number of entries matching the filters (across all pages)

Example:

42