List financial accounts

Returns a list of financial accounts.

Authentication

AuthorizationBearer

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

Query parameters

program_idstringOptional
The unique identifier for the program
page_limitintegerOptional

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

next_page_tokenstringOptional
A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls and the value of this field should be from the nextPageToken in the previous response.

Response

The response for FinancialAccounts.list
resultslist of objects or null
next_page_tokenstring or null

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only substituting the pageToken with this value). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Errors