Show list of accounts for active user.

get

https://example.com/accounts/private/v1/accounts

Responds with accounts collection associated with current user. Has includes of related models, filters, sortings, pagination.

Query Params

include

string

enum

Used to load nested resources associated with account.

Allowed:

sort

string

enum

Sorts records. Can be sorted in DESC direction by adding "-" prefix.

Allowed:

filter[numberContains]

string

Applies filter by number. Checks if number contains passed value. Can be used for search.

filter[typeId]

string

Applies filter by typeId.

filter[isActive]

string

Applies filter by isActive.

filter[allowDeposits]

string

Applies filter by allowDeposits.

filter[allowWithdrawals]

string

Applies filter by allowWithdrawals.

filter[userId]

string

Applies filter by userId.

filter[accountType.currencyCode]

string

Applies filter by currencyCode in account type.

filter[accountType.currencyType]

string

enum

Applies filter by currencyType in account type.

Allowed:

filter[isMitInstructionsAvailable]

boolean

Return accounts which have MIT bank account.

filter[createdAtFrom]

string

Applies filter by createdAt. Returns records where date >= passed.

filter[createdAtTo]

string

Applies filter by createdAt. Returns records where date < passed.

page[size]

string

Specifies count of objects returned in response. Default value is 20.

page[number]

string

Specifies page number to be shown in response. size + number makes offset for records. Default value is 1.

Responses

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful request

400Bad Request

403Forbidden