/accounts

Retrieves a list of accounts the user has access to. This will include the user's own account, but can contain others such as when the user is a reseller.

Query Params
include
array of strings

Some includes may not be available due to account type or missing Feature Flag

include
sort
array of strings
Defaults to +name

Comma separated list of of fields that should be sorted.

  • sort= - not providing any value will result in error 400
  • sort=+name,+name - same values will result in error 400
  • sort=-name,+name - mutially exclusive values will return error 400
  • maxItem=3 - Only Three values will be accepted, more will return error 400
  • qRelevance is optional ordering parameter which is available if q filter is used, if q filter is not passed qRelevance as ordering parameter will return error 400
sort
id__in
array of strings

Filter to get the accounts whose id is on the provided list. The lookup is exact and case insensitive.

id__in
string

Filter to get the accounts whose name contains the provided substring. The lookup is exact and case insensitive.

string

Filter to get the accounts whose customer ID contains the provided substring. The lookup is exact and case-insensitive.

Responses

Language
Credentials
Bearer
JWT
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json