Skip to main content
GET
Get all subledgers

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials
Token URL
https://api-sandbox.orum.io/oauth/token
Scopes1
read:subledgers
Read subledgers

Headers

Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Query Parameters

index
integer
default:0

Index for paginated results

Required range: x >= 0
size
integer
default:100

Max number of results to return

Required range: 0 <= x <= 500
subledger_reference_id
string

Filter results by subledger reference id Unique reference id for the subledger resource. Generated by you.

Required string length: 1 - 255

Response

200 response.

subledgers
object[]
required

List of subledgers.