Skip to main content
GET
/
v1
/
dict
/
entries
List Entries
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
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Account-Id
string
required

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

Query Parameters

​
page
integer
default:1

Page number for pagination.

Required range: x >= 1
​
limit
integer
default:10

Maximum number of items per page.

Required range: 1 <= x <= 100
​
key_type
enum<string>

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

Available options:
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>
default:asc

Sort direction: asc or desc.

Available options:
asc,
desc

Response

List of Pix entries retrieved successfully.

​
items
object[]
required
​
page
integer
required

Current page number.

Example:

1

​
limit
integer
required

Number of items per page.

Example:

10