List repayment hierarchies

Lists the repayment hierarchies available within the caller's tenant, with page-number
pagination (page / perPage / order) and optional filters. Enables discovery and reuse
of existing repayment hierarchy configurations (for example, by Control Center) without
knowing a hierarchy code in advance.

Results are always scoped to the caller's tenant, and hierarchies with status DELETED are
never returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number to retrieve (starts with 1 and increments by 1)

integer
≥ 1
Defaults to 10

Number of items per page

string
enum
Defaults to ASC

Sort direction by hierarchy code, use ASC for ascending and DESC for descending.

Allowed:
string
length between 1 and 80

Filter by repayment hierarchy code

string
enum

Filter by repayment hierarchy status. Note: DELETED hierarchies are always excluded from the results.

Allowed:
date

Search for hierarchies created from this date (inclusive). If provided without endDate, endDate defaults to the current date (UTC).

date

Search for hierarchies created until this date (inclusive). Note: if endDate is provided, startDate must also be provided, and startDate must be before or equal to endDate.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json