Retrieve tenants

GET/v1/tenants

Retrieves a list of all available tenants. If you haven't created any tenants, the response will include an empty array.

Analytics Events

TENANT_RETRIEVE_LIST_STARTTENANT_RETRIEVE_LIST_SUCCESSTENANT_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

`text/plain`

curl -X GET "https://example.com/v1/tenants"

{  "data": [    {      "id": "86cb97a9-5e80-4ed7-af13-a170752bb1ea",      "name": "My Tenant",      "subdomain": "my-tenant.vii.au01.mattr.global",      "environment": {        "id": "fa605282-0223-4ae0-831d-af368bc39a55",        "name": "MATTR Public Sydney, Australia",        "domain": "vii.au01.mattr.global",        "authorizationServerDomain": "manage.auth.auth0.com",        "deploymentModel": "public",        "region": {          "id": "70bb433a-f0ec-4297-ad76-3b09c71311f3",          "name": "AU01",          "displayName": "Sydney, Australia"        }      },      "membership": {        "roles": [          "dts-provider",          "issuer"        ]      }    }  ],  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}

GET/v1/tenants

Retrieves a list of all available tenants. If you haven't created any tenants, the response will include an empty array.

Analytics Events

TENANT_RETRIEVE_LIST_STARTTENANT_RETRIEVE_LIST_SUCCESSTENANT_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

`text/plain`

curl -X GET "https://example.com/v1/tenants"

{  "data": [    {      "id": "86cb97a9-5e80-4ed7-af13-a170752bb1ea",      "name": "My Tenant",      "subdomain": "my-tenant.vii.au01.mattr.global",      "environment": {        "id": "fa605282-0223-4ae0-831d-af368bc39a55",        "name": "MATTR Public Sydney, Australia",        "domain": "vii.au01.mattr.global",        "authorizationServerDomain": "manage.auth.auth0.com",        "deploymentModel": "public",        "region": {          "id": "70bb433a-f0ec-4297-ad76-3b09c71311f3",          "name": "AU01",          "displayName": "Sydney, Australia"        }      },      "membership": {        "roles": [          "dts-provider",          "issuer"        ]      }    }  ],  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}

Analytics Events

Authorization

Query Parameters

Response Body

200application/json

400application/json

401text/plain

403

500

Retrieve tenants

Analytics Events

Authorization

Query Parameters

Response Body

200application/json

400application/json

401text/plain

403

500

`application/json`

`application/json`

`text/plain`

`application/json`

`application/json`

`text/plain`