Skip to navigation
REST APIOrganizationsTenant

Get a list of tenants.

View as Markdown
Retrieve a list of tenants and their details.

Authentication

AuthorizationBearer
Bearer authentication

Query parameters

deletedbooleanOptionalDefaults to false

Include soft-deleted tenants in the response when true.

namestringOptional
Filter tenants by name
aliasstringOptional
Filter tenants by alias

Response

Executed successfully.
idinteger
The id of the tenant.
uuidstringformat: "uuid"
The universally unique identifier of the tenant.
namestring
The internal system name of the tenant.
smgboolean
statusenum

The current status of the tenant. Possible values:

  • Creating
  • Failed
  • Updating
  • Deleted
  • Deleting
  • Ready
createdAtdatetime
The date and time when the tenant was created.
updatedAtdatetime
The date and time when the tenant was last updated.
contractTypeenum
Allowed values:
mimirIdstringOptional
displayNamestringOptional
The name of the tenant as shown to users within the tenant.
aliasstringOptional
An optional alias for the tenant.
diagnosticsstringOptional

Most recent provisioning failure message. Only populated by GET /tenants/{id} when status is Failed.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
503
Service Unavailable Error