v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Account Holders

List account holders

List and filter account holders.

get/account_holders

Query parameters

limitinteger

starting_afterstring uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the account holder.

end_datestring date

The creation date of the account holder.

namestring

The name of the account holder.

disabledboolean

If true, only disabled account holders will be fetched.

external_account_idstring uuid

The ID of the related external account.

internal_account_idstring uuid

The ID of the related internal account.

Response

200

Example response

{
  "records": [
    {
      "name": "EndCustomerCo",
      "object": "account_holder",
      "metadata": {
        "property_a": true,
        "property_b": "some text"
      }
    }
  ]
}