Skip to content

List tenants

Request

Retrieve the tenants managed by your partner account. Tenants that are being deleted are included, flagged with deleteInProgress. Results are paginated: when paging.moreResults is true, pass paging.nextToken as the nextToken query parameter to fetch the next page.

Security
x-api-key
Query
limitinteger, [ 1 .. 100 ]

Used for pagination. Number of tenants to return.

Default:100
nextTokenstring

Used for pagination. The paging.nextToken returned with the previous page.

curl -i -X GET \
  https://eu1.partner-api.pushsecurity.com/v1/tenants \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
resultArray of objects(Tenant)
pagingobject
Response
{
  "result": [
    {
      "id": "0c2e1b84-ee1d-4ef9-a3b3-4b2e1d5c8f27",
      "name": "Acme Corporation",
      "metadata": {
        "customerRef": "ACME-001",
        "region": "emea"
      },
      "creationTimestamp": 1718100000,
      "deleteInProgress": false
    }
  ],
  "paging": {
    "moreResults": false,
    "nextToken": "string"
  }
}