Pular para o conteúdo principal
GET
/
v1
/
organizations
/
{organization_id}
/
holders
Listar Titulares
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders
import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders"

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders")
.asString();
require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "items": "<unknown>",
  "limit": 123,
  "next_cursor": "<string>",
  "page": 123,
  "prev_cursor": "<string>"
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Cabeçalhos

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization
string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de caminho

organization_id
string<uuid>
obrigatório

O identificador único da Organização associada ao Ledger.

Parâmetros de consulta

metadata
string

String JSON para filtrar titulares por campos de metadata

limit
string

Máximo de itens por página (1-100, padrão 10)

page
string

Número da página (padrão 1)

sort_order
string

Direção da ordenação (asc, desc)

include_deleted
string

O retorno inclui titulares excluídos logicamente (true,false)

external_id
string

Filtrar titulares por externalID

document
string

Filtrar titulares por documento

Resposta

OK

items
any
obrigatório
limit
integer<int64>
obrigatório
Exemplo:

10

next_cursor
string
Exemplo:

"eyJpZCI6IjAxOTI..."

page
integer<int64>
Exemplo:

1

prev_cursor
string
Exemplo:

"eyJpZCI6IjAxOTE..."