v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Accounts

get/accounts

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

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

entity_idstring

Filter Accounts for those belonging to the specified Entity.

informational_entity_idstring

Filter Accounts for those belonging to the specified Entity as informational.

program_idstring

Filter Accounts for those in a specific Program.

status.instring[]

Filter Accounts for those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

Account List

next_cursorstring nullable required

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.

Example response

{
  "data": [
    {
      "account_revenue_rate": null,
      "bank": "first_internet_bank",
      "closed_at": null,
      "created_at": "2020-01-31T23:59:59Z",
      "currency": "USD",
      "entity_id": "entity_n8y8tnk2p9339ti393yi",
      "funding": "deposits",
      "id": "account_in71c4amph0vgo2qllky",
      "idempotency_key": null,
      "informational_entity_id": null,
      "interest_rate": "0.055",
      "loan": null,
      "name": "My first account!",
      "program_id": "program_i2v2os4mwza1oetokh9i",
      "status": "open",
      "type": "account"
    }
  ],
  "next_cursor": "v57w5d"
}