Saltar al contenido 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
}

Autorizaciones

​
Authorization
string
header
requerido

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

Encabezados

​
X-Account-Id
string
requerido

Identificador único de la cuenta del Ledger de Midaz (formato UUID).

Parámetros de consulta

​
page
integer
predeterminado:1

Número de página para la paginación.

Rango requerido: x >= 1
​
limit
integer
predeterminado:10

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

Rango requerido: 1 <= x <= 100
​
key_type
enum<string>

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

Opciones disponibles:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
​
key_value
string

Filtrar por valor de la clave (por ejemplo, dirección de correo electrónico o número de teléfono).

​
entry_id
string

Filtrar por ID de entrada (formato UUID).

​
sort_order
enum<string>
predeterminado:asc

Dirección de ordenamiento: asc o desc.

Opciones disponibles:
asc,
desc

Respuesta

Lista de entradas Pix recuperada correctamente.

​
items
object[]
requerido
​
page
integer
requerido

Número de página actual.

Ejemplo:

1

​
limit
integer
requerido

Cantidad de elementos por página.

Ejemplo:

10