Saltar al contenido principal
GET
/
v1
/
organizations
/
{organization_id}
/
instruments
Listar instrumentos
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/instruments
import requests

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

response = requests.get(url)

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

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/instruments', 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}/instruments",
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}/instruments"

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}/instruments")
.asString();
require 'uri'
require 'net/http'

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

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

Encabezados

X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization
string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

Parámetros de ruta

organization_id
string<uuid>
requerido

El identificador único de la Organización asociada al Ledger.

Parámetros de consulta

holder_id
string

Filter instruments by holder ID (UUID) Filtra los instrumentos por ID de titular (UUID)

metadata
string

JSON string to filter instruments by metadata fields Cadena JSON para filtrar instrumentos por campos de metadatos

limit
string

Max items per page (1-100, default 10) Máximo de elementos por página (1-100, predeterminado 10)

page
string

Page number (default 1) Número de página (predeterminado 1)

sort_order
string

Sort direction (asc, desc) Dirección de ordenamiento (asc, desc)

include_deleted
string

Return includes logically deleted instruments (true,false) La respuesta incluye los instrumentos eliminados lógicamente (true,false)

account_id
string

Filter instrument by accountID Filtra el instrumento por accountID

ledger_id
string

Filter instrument by ledgerID Filtra el instrumento por ledgerID

document
string

Filter instrument by document Filtra el instrumento por documento

Respuesta

OK

items
any
requerido
limit
integer<int64>
requerido
Ejemplo:

10

next_cursor
string
Ejemplo:

"eyJpZCI6IjAxOTI..."

page
integer<int64>
Ejemplo:

1

prev_cursor
string
Ejemplo:

"eyJpZCI6IjAxOTE..."