v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Account

List Accounts

get/account

Query parameters

account_numberstring

Bank account number. Filterable.

account_typestring

One of checking or savings. Filterable.

closed_datestring

Timestamp of the account closure, ISO 8601 format ('YYYY-MM-DDThh:mm:ssZ'). Limited availability. Always in UTC. Filterable.

org_idstring

ID of organization that is associated with the account. Filterable.

statusstring

The status of the account. One of open, closed, or close_pending. Filterable.

tagsstring[]

Array of tags associated with this account. Filterable.

page_cursorstring

Pagination cursor, value is the object ID.

page_sizeinteger

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

from_datestring

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_datestring

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

A dictionary with a data property that contains a list of up to page_size account elements, starting after the account described by page_cursor. If no more accounts are available, the resulting list will be empty.