latestOpenAPI 3.0.32026-07-24214879985.1 KB

df57313de545

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.

get/accounts

Query parameters

includestring[]

Allows clients to request optional information such us URLs necessary to configure third party IDPs.

sortstring[]

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
id__instring[]

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

name__containsstring

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

customerId__containsstring

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

Response

OK

ApiPaginatedEndUserAccountResponse required— unresolved $ref