Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Assets API

List Assets

Use this endpoint to retrieve the details of all Assets in your Ledger.

get/v1/organizations/{organization_id}/ledgers/{ledger_id}/assets

Path parameters

organization_idstring uuid required

The unique identifier of the Organization associated with the Ledger.

ledger_idstring uuid required

The unique identifier of the associated Ledger.

Query parameters

limitinteger

The maximum number of items to include in the response. Max: 100

start_datestring

The beginning of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.

end_datestring

The end of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.

sort_order'asc' | 'desc'

The order used to sort the results.

pageinteger

The number of the page that you want to retrieve.

metadata.keystring

Filter by metadata using dot-notation. Replace key with your metadata field name (e.g. metadata.costCenter=BR_11101997).

codestring

The code used to refer to the Asset.

Headers

Content-Typestring

The type of media of the resource. Recommended value is application/json.

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Response

Indicates that the request was successful and the response contains the expected data.

pageinteger

The number of pages returned.

limitinteger

The maximum number of items included in the response.