Skip to main content
GET
List Entries

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

X-Account-Id
string
obrigatório

Unique identifier of the Midaz Ledger Account (UUID format).

Parâmetros de consulta

page
integer
padrão:1

Page number for pagination.

Intervalo obrigatório: x >= 1
limit
integer
padrão:10

Maximum number of items per page.

Intervalo obrigatório: 1 <= x <= 100
key_type
enum<string>

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

Opções disponíveis:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
key_value
string

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

entry_id
string

Filter by entry ID (UUID format).

sort_order
enum<string>
padrão:asc

Sort direction: asc or desc.

Opções disponíveis:
asc,
desc

Resposta

List of Pix entries retrieved successfully.

items
object[]
obrigatório
page
integer
obrigatório

Current page number.

Exemplo:

1

limit
integer
obrigatório

Number of items per page.

Exemplo:

10