Search the accounts of the tenant by name, number or external id, one page at a time.

This endpoint finds the accountId that other endpoints require when you only know an account name,
number or external id. search matches any part of the account name, number or external id; leave it empty
to browse all accounts. Each account comes with its id, name, number, company id, external id and archived
flag. total is the number of matching accounts: while pageNumber multiplied by pageSize is below total,
call again with pageNumber + 1 to get the next page. Only active accounts are returned unless
includeArchived is true. To read the full configuration of one account, call GET api/v1/accounts/{accountId}.

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

Text to look for; the fields it is matched against are listed by each endpoint. Leave empty to list everything.

int32
1 to 10000

The page to return, starting at 1.

int32
1 to 200

The number of items per page, 50 by default and 200 at most.

boolean
Defaults to false

When true, archived accounts are included in the results.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

500

An error occurred while trying to search the accounts.

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