GET/accounts

List Accounts

Lists Accounts, with optional filters for their Entity, Program, status, creation time, or idempotency key. Use cursor and limit to page through the results; limit defaults to 100 and cannot exceed 100.

11 parameters
cursorstringoptional
Return the page of entries after this cursor.
limitintegeroptional
Maximum number of Accounts to return. Defaults to 100 when omitted; must be at least 1 and cannot exceed 100.
Default:100
entity_idstringoptional
Filter Accounts to those belonging to this Entity.
informational_entity_idstringoptional
Filter Accounts to those associated with this Entity as informational.
program_idstringoptional
Filter Accounts to those in this Program.
status.inarray<string>optional
Filter by Account status. Values are `closed` or `open`; encode multiple values as a comma-delimited string.
created_at.afterstringoptional
Return Accounts created after this ISO 8601 timestamp.
created_at.beforestringoptional
Return Accounts created before this ISO 8601 timestamp.
created_at.on_or_afterstringoptional
Return Accounts created at or after this ISO 8601 timestamp.
created_at.on_or_beforestringoptional
Return Accounts created at or before this ISO 8601 timestamp.
idempotency_keystringoptional
Filter by the idempotency key used for the Account. Must contain 1 to 200 characters.

3 status codes
200Returns a page of Account objects in `data` and a `next_cursor` for retrieving the next page, or null when there are no more results.
dataarray<Account>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request encounters a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

limit must be at least 1 and no greater than 100. status.in accepts closed and open; creation-time filters must use ISO 8601 timestamps, and idempotency_key must contain 1 to 200 characters.