List All Pix Entries

Use this endpoint to list all Pix entries for an account with optional filters. Returns empty array [] if no entries match the criteria.

GET /v1/dict/entries

List All Pix Entries

cURL

curl --request GET \
  --url https://api.example.com/v1/dict/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

200

{
  "items": [
    {
      "account": {
        "branch": "0001",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "number": "123456789",
        "openingDate": "2020-01-15T10:30:00Z",
        "participant": "12345678",
        "type": "TRAN"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "holderId": "550e8400-e29b-41d4-a716-446655440001",
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "keyCreationDate": "2024-01-15T10:30:00Z",
      "keyOwnershipDate": "2024-01-15T10:30:00Z",
      "keyType": "EMAIL",
      "keyValue": "[e-mail]",
      "owner": {
        "document": "52998224725",
        "name": "John Doe",
        "tradeName": "John's Business",
        "type": "NATURAL_PERSON"
      },
      "requestId": "680e8400-e29b-41d4-a716-446655440002",
      "status": "ACTIVE",
      "updatedAt": "2024-01-20T14:45:00Z",
      "metadata": {}
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 42
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id · string<uuid> · requerido

Account ID (UUID format) - required

Parámetros de consulta

page · integer<int64> · predeterminado: 1

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

limit · integer<int64> · predeterminado: 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)

Respuesta

200

application/json

OK

items · object[] · requerido

Array of entries for the current page

Show child attributes

limit · integer<int64> · requerido

Number of items per page

Ejemplo:

10

page · integer<int64> · requerido

Current page number

Ejemplo:

1

total · integer<int64> · requerido

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

Ejemplo:

42