Saltar al contenido principal
GET
Listar Portafolios

Encabezados

Content-Type
string

El tipo de medio del recurso. El valor recomendado es application/json.

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.

ledger_id
string<uuid>
requerido

El identificador único del Ledger asociado.

Parámetros de consulta

limit
integer
predeterminado:10

El número máximo de elementos a incluir en la respuesta. Máx: 100

Rango requerido: 1 <= x <= 100
start_date
string

El inicio del período que desea recuperar. start_date y end_date son todo o nada: proporcionar solo uno devuelve 400. Si se omiten ambos, se utiliza una ventana predeterminada del último 1 mes.

end_date
string

El final del período que desea recuperar. start_date y end_date son todo o nada: proporcionar solo uno devuelve 400. Si se omiten ambos, se utiliza una ventana predeterminada del último 1 mes.

sort_order
enum<string>
predeterminado:asc

El orden utilizado para ordenar los resultados.

Opciones disponibles:
asc,
desc
page
integer
predeterminado:1

El número de página que desea recuperar.

Rango requerido: x >= 1
metadata.key
string

Filtrar por metadatos usando notación de puntos. Reemplaza key con el nombre de tu campo de metadatos (p. ej. metadata.costCenter=BR_11101997).

entity_id
string

Filtrar los portafolios por el identificador único de la entidad responsable de ellos.

status
string

Filtrar los portafolios por su código de estado.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

items
object[]
page
integer

El número de páginas devueltas.

limit
integer

El número máximo de elementos incluidos en la respuesta.