Skip to main content
GET
List banks

Authorizations

Authorization
string
header
required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Query Parameters

include
string

Comma-separated list of relationships to include.

Available options: country, state, creator

Example:

"country,state"

filter[id]
string

Comma-separated list of IDs to filter by

filter[name]
string

Filter by bank name (partial match)

filter[code]
string

Filter by bank code (partial match)

filter[city]
string

Filter by city (partial match)

filter[country_id]
integer

Filter by country ID

filter[state_id]
integer

Filter by state ID

filter[trashed]
string

Filter by trashed status. Options: with, only

sort
string
required

Sort field

Example:

"name"

page
integer
required

Page number

Example:

1

Response

Success