List tenants

GEThttps://api.trillet.ai/partner/v1/tenants

Lists tenants, newest first. Deleted tenants are not listed. Needs tenants:read.

Loading code example

Loading code example

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

limitintegerdefault: 20

Required range: x >= 1, x <= 100

Default: 20

starting_afterstring

The id of the last tenant on the previous page. A value that is not a tenant ID returns 400 invalid_cursor.

status"active" | "suspended" | "provisioning_failed"

Allowed values: "active" | "suspended" | "provisioning_failed"

externalIdstring

Length: <= 128

application/json

A page of tenants.

objectstringrequired

dataarray<object>required

data.objectstringrequired

data.idstringrequired

Use it in paths and as x-workspace-id on standard endpoints.

Pattern: ^[a-fA-F0-9]{24}$

data.externalIdstringrequired

Your ID for this customer.

data.namestringrequired

data.status"active" | "suspended" | "deleted" | "provisioning_failed"required

Allowed values: "active" | "suspended" | "deleted" | "provisioning_failed"

data.region"us" | "au"required

Allowed values: "us" | "au"

data.metadataobjectrequired

data.limitsobjectrequired

data.suspendedAtstring | null<date-time>

data.suspendedReasonstring | null

data.deletedAtstring | null<date-time>

data.createdAtstring<date-time>required

hasMorebooleanrequired