Middesk APISub Accounts

List sub-accounts

Lists sub-accounts owned by the caller, newest first. q performs a case-insensitive substring search on name only; percent and underscore characters are treated literally.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

qstringOptional

Case-insensitive name substring

enabledenumOptional

Filter by active or inactive sub-accounts

Allowed values:
pageintegerOptional
Page number, from 1 through 65,535
per_pageintegerOptional
Items per page, from 1 through 100
sort_byenumOptional

Accepted sort field; results are currently returned newest first

Allowed values:
sort_orderenumOptional

Accepted sort direction; results are currently returned newest first

Allowed values:

Response

sub-accounts list

objectstring
has_moreboolean
datalist of objectsOptional
total_countintegerOptional

Errors

400
List Sub Accounts Request Bad Request Error
403
List Sub Accounts Request Forbidden Error
422
List Sub Accounts Request Unprocessable Entity Error