Sign in

v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB
Account

List accounts

Retrieves a paginated list of accounts in results according to the passed in rpp, page and search parameters alongside the total number of items matching the search query (total).

get/v3/accounts

Query parameters

rppnumber
Example:15

The number of results per page you want to retrieve.

pagenumber
Example:15

The page number for which you want to retrieve results.

searchstring
Example:My account

The search query that searches accounts by their names

Response

OK - Accounts have been retrieved successfully

totalnumber

The total number of items out of which only a subset was returned in the paginated results.

Example response

{
  "results": [
    {
      "tenant_id": "my-tenant",
      "account_id": "10549fef-cddb-4b1f-92e4-27ab7cb2e555",
      "name": "My Company",
      "number_of_seats": 7,
      "email_address": "company@email.com"
    }
  ],
  "total": 30
}