Get tenant details API Reference

GET

/tenants/{tenant}

curl --request GET \
  --url https://api.kupe.cloud/api/v1/tenants/acme \
  --header 'Authorization: <Authorization>'

Retrieve full details for a tenant including plan, members, resource usage, and status. The response includes an ETag header for use with optimistic locking on subsequent PATCH requests.

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

Responses

200

Tenant details

Media type application/json

object

contactEmail

string

createdAt

string

displayName

string

members

Array<object>

object

email

string

role

string

name

string

resourceVersion

string

status

object

allocatedResources

object

cpu

string

memory

string

storage

string

clusterCount

integer

phase

string

poolResources

object

cpu

string

memory

string

storage

string

Example

{
  "contactEmail": "admin@acme.com",
  "createdAt": "2026-01-15T10:30:00Z",
  "displayName": "Acme Corp",
  "members": [
    {
      "email": "alice@acme.com",
      "role": "admin"
    }
  ],
  "name": "acme",
  "resourceVersion": "184920",
  "status": {
    "allocatedResources": {
      "cpu": "8",
      "memory": "32",
      "storage": "200"
    },
    "clusterCount": 3,
    "phase": "Active",
    "poolResources": {
      "cpu": "8",
      "memory": "32",
      "storage": "200"
    }
  }
}

Headers

ETag

string

Resource version for optimistic locking

400

Invalid tenant name

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

401

Missing or invalid authentication

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

Not a member of this tenant

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

404

Tenant not found

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

429

Rate limit exceeded

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}