Skip to content
Kindgi

List tenants

View as Markdown
GET
/v1/system/tenants
curl --request GET \
  --url 'https://example.com/v1/system/tenants?limit=25' \
  --header 'Authorization: Bearer <token>'

Newest first; purged tenants are left out. Takes system:tenants. Never a tenant’s content.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Where the previous page ended: its nextCursor, as it came. A runtime that seals cursors takes one only for the same list, filters and caller, within a day; otherwise 400 bad-input, and the list starts again without it. Absent → first page.

Responses

Section titled “Responses”

200

Section titled “200”

The tenants.

Media typeapplication/json
object
data
required
Array<object>

A tenant, as the operator sees it: never its content.

object
id
required
string format: uuid
name
required
string
slug
required
string
state
required

closing: readable and exportable with its own keys for its window, nothing runs. suspended: the same, reversibly. closing wins over suspended.

string
Allowed values: active suspended closing
createdAt
required
string format: date-time
test
required

A test tenant: left out of usage, invoices and counts.

boolean
productionAllowed
required
boolean
imagePrefix

The repository its deployments’ images must sit at or under, <host>/<path>.

string
closingAt
string format: date-time
suspendedAt
string format: date-time
suspendedReason
string
hasMore
required
boolean
nextCursor

Opaque; absent when hasMore is false.

string
Example
{
  "data": [
    {
      "state": "active"
    }
  ]
}

400

Section titled “400”

A limit out of range, or a cursor this route did not give.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Section titled “403”

A tenant’s key or session (system-principal-required), or a system key without system:tenants (system-scope-missing).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also