List Accounts (Individuals & Legal Entities)

get

https://onboarding-api.lemonway.com/accounts

Retrieve a list of all individual (and/or corporate) accounts

🚧
Important
The filter parameters documented for this endpoint are not currently functional in production. This is a known issue under active investigation. Until a fix is deployed, filter parameters will be ignored and the endpoint will return all accounts.

Query Params

$searchTerm

string

Search term to filter accounts by

$searchFields

array of strings

Fields to search in accounts using search terms

$searchFields

$filter

string

A way to filter accounts based on certain criteria.

Syntax:

• Colon (:): Assigns a value to an attribute (e.g., key:value).

• Pipe (|): Logical OR separator for multiple values of the same attribute (e.g., key:val1|val2).

• Comma (,): Logical AND separator between different attribute filters (e.g., key1:val,key2:val).

Example: $filter=profiles.solutionName:'Test1'|'Test2',identity.firstName:'test' will return records matching solution name('Test1' OR 'Test2') AND having the first name 'test'.

$size

string

Page size — number of accounts to return per request

$orderBy

string

enum

Which field to order the results by. Allowed values here are createdAt (date account was created) or type (account type)

Allowed:

$select

string

enum

Restrict the returned fields to only those specified. Allowed fields: createdAt, type, id, externalAccountId, status, profiles

Allowed:

$sort

string

enum

Sort order: ascending (asc) or descending (desc)

Allowed:

$skipToken

string

A token for retrieving the next or previous page of results in pagination

$skipDirection

string

enum

Whether to paginate forwards (next) or backwards (prev)

Allowed:

Response

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

Important

200