List your accounts

Get every account under your partner, with owner email, status, location count, active-plan count, and current plan name. Add call_for=dropdown to get a simple name/ID list instead. Results are paginated and can be sorted, searched, and filtered to accounts with an active plan; what you see is limited to the accounts and locations assigned to your user.

Prerequisites: none beyond the token.

Authentication: Partner token. Lists the accounts in your partner's tree, including those under your sub-partners. account_id must be inside your tree (otherwise 422); any other token gets 403.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 10

Page size, 10 to 100. Default 10. Values below 10 are raised to 10; above 100 returns 422. With call_for=dropdown, at most 50 entries are returned, and with no limit the whole list is returned.

integer
Defaults to 1

Page number. Default 1.

string
enum
Defaults to company_name

company_name, email, status or plan_name. Default company_name.

Allowed:
string
enum
Defaults to asc

asc or desc (either case). Default asc.

Allowed:
string
enum
Defaults to company_name

company_name, email, status or plan_name. Use with search_value. company_name also matches your client_account_id.

Allowed:
string
Defaults to Acme

The text to search for (part of the value is enough). With search_field=status, the exact status number.

integer
enum
Defaults to 1

1 to list only accounts that have a location on an active plan.

Allowed:
string
enum
Defaults to dropdown

dropdown to get a label/value list instead of the paginated list.

Allowed:
integer
Defaults to 5994

Return only this account (our id).

string
Defaults to docs-test-acct-001

Return only the account with this id of yours. Max 255 characters.

Responses

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