Get a tenant by external ID

GEThttps://api.trillet.ai/partner/v1/tenants/by-external-id/{externalId}

Looks up a live tenant by your own customer ID. 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.

externalIdstringrequired

Length: >= 1, <= 128

application/json

The tenant.

objectstringrequired

idstringrequired

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

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

externalIdstringrequired

Your ID for this customer.

namestringrequired

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

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

region"us" | "au"required

Allowed values: "us" | "au"

metadataobjectrequired

limitsobjectrequired

limits.monthlySpendCapnumber | null

Monthly spend cap in USD. null means no cap. 0 blocks all paid work.

Required range: x >= 0

suspendedAtstring | null<date-time>

suspendedReasonstring | null

deletedAtstring | null<date-time>

createdAtstring<date-time>required