Skip to main content
POST
/
v1
/
tenants
/
list
go
cr, err := client.Tenancy.List(context.Background(), &v1.TenantListRequest{
    PageSize: 20,
    ContinuousToken: "",
})
{
  "tenants": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "continuous_token": "<string>"
}

Body

application/json

TenantListRequest is the message used for the request to list all tenants.

TenantListRequest is the message used for the request to list all tenants.

​
page_size
integer<int64>

page_size is the number of tenants to be returned in the response. The value should be between 1 and 100.

​
continuous_token
string

continuous_token is an optional parameter used for pagination. It should be the value received in the previous response.

Response

A successful response.

TenantListResponse is the message returned from the request to list all tenants.

​
tenants
object[]

tenants is a list of tenants.

​
continuous_token
string

continuous_token is a string that can be used to paginate and retrieve the next set of results.