Pular para o conteúdo principal
GET
/
v1
/
dict
/
entries
Listar entradas
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'
{
  "items": [
    {
      "id": "019c96a0-0c0c-7221-8cf3-13313fb60081",
      "key": "john.doe@example.com",
      "keyType": "EMAIL",
      "status": "ACTIVE",
      "account": {
        "branch": "0001",
        "number": "123456789",
        "participant": "12345678",
        "type": "TRAN"
      },
      "owner": {
        "name": "John Doe",
        "taxIdNumber": "12345678901",
        "type": "NATURAL_PERSON"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "page": 1,
  "limit": 10
}

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

Identificador único da Conta do Ledger Midaz (formato UUID).

Parâmetros de consulta

​
page
integer
padrão:1

Número da página para paginação.

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

Número máximo de itens por página.

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

Filtrar por tipo de chave: CPF, CNPJ, EMAIL, PHONE, EVP.

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

Filtrar pelo valor da chave (por exemplo, endereço de e-mail ou número de telefone).

​
entry_id
string

Filtrar pelo ID da entrada (formato UUID).

​
sort_order
enum<string>
padrão:asc

Direção da ordenação: asc ou desc.

Opções disponíveis:
asc,
desc

Resposta

Lista de entradas Pix recuperada com sucesso.

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

Número da página atual.

Exemplo:

1

​
limit
integer
obrigatório

Número de itens por página.

Exemplo:

10