Accounts

Get Accounts

get
/v1/accounts

Retrieve a list of accounts with optional filtering and pagination.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
accountStatusstring · enumOptional

Filter accunts by status

Possible values:
accountTypestring · enumOptional

Filter account by type

Possible values:
createDateStartstring · date-timeOptional

Filter account by creation date lower bound, exclusive

createDateEndstring · date-timeOptional

Filter accounts by creation date upper bound, inclusive

recentCreditHistorystring · enumOptionalPossible values:
customerIdstring · uuidOptional

Filter accounts by customer ID

afterstringOptional

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring · integerOptional

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

sortFieldstring · enumOptional

Will sort the returned data using the specified field.

Possible values:
sortDirectionstring · enumOptional

Specifies the sort direction for the sortField.

Possible values:
Responses
200

OK

application/json
get
/v1/accounts

Last updated