List Entries - Lerian

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>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "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
}

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>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "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

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

Parámetros de consulta

page

integer

predeterminado:1

Page number for pagination.

Rango requerido: x >= 1

limit

integer

predeterminado:10

Maximum number of items per page.

Rango requerido: 1 <= x <= 100

key_type

enum<string>

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

Opciones disponibles:

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>

predeterminado:asc

Sort direction: asc or desc.

Opciones disponibles:

asc,

desc

Respuesta

List of Pix entries retrieved successfully.

items

object[]

requerido

Show child attributes

page

integer

requerido

Current page number.

Ejemplo:

1

limit

integer

requerido

Number of items per page.

Ejemplo:

10