Sign in

v49

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-294147162.3 KB
financial_accounts

List financial accounts

Returns a list of financial accounts.

get/v1/financial_accounts

Query parameters

program_idstring

The unique identifier for the program

page_limitinteger

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

next_page_tokenstring

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

next_page_tokenstring

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.

Example response

{
  "results": [
    {
      "id": "account_01jpjenf5q6cawy43yxfcrxhct",
      "account_type": "disbursements",
      "program_id": "program_01jpjenf5q6cawy43yxfcrxhct",
      "bank_provider": "mock_alpha",
      "created_at": "2020-01-31T23:00:00Z",
      "updated_at": "2020-01-31T23:00:00Z"
    }
  ]
}