Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
x) Accounts

List accounts for an organisation

Returns all accounts for the organisation matching the given filters. Pass fields=accountHolders to include account holder details.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/accounts

Path parameters

tenantIdinteger required
organisationIdinteger required

Query parameters

accountHolderOrganisationIdinteger
accountHolderUserIdinteger
ascendingboolean

If true, sort results in ascending order. Defaults to descending.

fieldsstring

Comma-delimited list of additional fields to include. Pass 'accountHolders' to include account holder details.

limitinteger
modestring
offsetinteger
orderBystring

Column to sort results by, e.g. 'created'.

Response

OK

accountHolderOrganisationIdinteger
accountHolderUserIdinteger
accountIdinteger
balancenumber
createdstring date-time
currencystring
deallocatedAmountnumber
lastModifiedstring date-time
merchantOrganisationIdinteger required
modestring
tenantIdinteger
versioninteger

Example response

[
  {
    "created": "2022-03-10T12:15:50-04:00",
    "lastModified": "2022-03-10T12:15:50-04:00"
  }
]