GET
Search accounts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

programId
string
required

The program to scope results to. Required on every request — including when you pass allPrograms=true. A request without it is rejected before it reaches the search.

customerId
string

Filter by customer ID. Comma-separated for multi-select.

custodianId
string

Filter by custodian ID. Comma-separated for multi-select. Ignored for guardian-bound roles, which are always scoped to their own guardian.

status
string

Filter by status. Comma-separated for multi-select.

fromDate
string<date-time>

Lower bound (inclusive) on record date, ISO 8601.

toDate
string<date-time>

Upper bound (inclusive) on record date, ISO 8601.

page
integer
default:1

1-based page number. Defaults to 1.

Required range: x >= 1
limit
integer

Maximum number of items per page.

Required range: x >= 1
sortBy
string

Field to sort results by.

sortOrder
enum<string>

Sort direction.

Available options:
asc,
desc
resultType
enum<string>
default:json

Result format. json (default) returns inline results; file returns a presigned S3 CSV URL (valid 1 hour) in place of the data array.

Available options:
json,
file
filePrefix
string

Customises the filename of the exported CSV when resultType=file.

accountId
string

Filter by Orenda account ID. Comma-separated for multi-select.

accountProviderAccountId
string

Filter by the provider's own account identifier. Comma-separated for multi-select.

accountName
string

Filter by account name. Comma-separated for multi-select.

accountType
string

Filter by account type. Comma-separated for multi-select.

iban
string

Filter by IBAN. Comma-separated for multi-select.

accountNumber
string

Filter by account number. Comma-separated for multi-select.

sortCode
string

Filter by sort code. Comma-separated for multi-select.

provider
string

Filter by account provider. Comma-separated for multi-select.

currency
string

Filter by currency (ISO 4217), e.g. EUR, GBP. Comma-separated for multi-select.

created
string

Filter by exact creation timestamp. Comma-separated for multi-select. For ranges use fromDate / toDate.

reportType
enum<string>

Returns available-balance report rows (with human column labels) instead of accounts: as JSON, or as a CSV export with resultType=file.

Available options:
available-balance-report

Response

Matching accounts, or a presigned export URL when resultType=file.

Inline JSON results, or — when resultType=file — a presigned CSV export URL.

success
boolean
Example:

true

data
object[]
total
integer

Total number of matching records across all pages.

Example:

42

page
integer

The 1-based page returned.

Example:

1

limit
integer

Page size used for this response.

Example:

10