Skip to main content
GET
List accounts
Each Account is a financial product that contains one or more virtual accounts. Use account retrieval for its balance breakdown.

Authorizations

X-API-Key
string
header
required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

x-legal-entity
string
required

The legal entity to act on. Required on every request except GET /v2/legal-entities, which lists the ids a user API key can send here: those of every legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Query Parameters

cursor
string

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limit
integer

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

Required range: 1 <= x <= 100
sort
enum<string>
default:createdAt

Field to order the page by. createdAt is descending unless sortDirection is passed. See Sorting.

Available options:
createdAt
sortDirection
enum<string>

Direction of the ordering selected by sort. When omitted, each sort value uses its own default; see Sorting.

Available options:
asc,
desc
includeClosed
boolean
default:false

Include closed Accounts. Defaults to false.

Response

A page of Accounts.

items
Account · object[]
required
metadata
PaginationMetadata · object
required