Retrieve a tenant.

GET

/tenants/{tenant_id}

const url = 'https://shiftagent.example.com/tenants/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://shiftagent.example.com/tenants/example \
  --header 'Authorization: Bearer <token>'

Fetch a tenant by its internal tnt_ ID.

Authorizations

integrationKey

Parameters

Path Parameters

tenant_id

required

string

/^tnt_[A-Za-z0-9]+$/

Internal tenant ID.

Responses

200

The tenant.

application/json

Unit of isolation mirroring one host-system tenant. Child of the integration key’s root tenant.

object

object

required

string

Allowed value: tenant

required

string

/^tnt_[A-Za-z0-9]+$/

external_id

required

Host system’s tenant ID (namespaced by the adapter). Unique across the integration; natural key for upsertTenantByExternalId. Null only for tenants created via plain createTenant without one.

string | null

<= 255 characters

name

required

Display name. Nullable — external-ID-only creation is valid.

string | null

<= 255 characters

status

required

Suspended tenants reject conversation/message writes with 403 tenant-suspended; reads keep working.

string

Allowed values: active suspended

default_repository_id

required

Tenant default repository — the fall-through of the resolution cascade (message → conversation → user → role → tenant default). Must reference an attached repository.

string | null

/^rep_[A-Za-z0-9]+$/

settings

required

Tenant-level runtime defaults and caps. Downstream scopes (conversation, message) may only narrow within these.

object

filler_enabled

Default filler-agent enablement — root of the filler cascade (tenant → conversation → message; most specific wins).

boolean

default: true

default_agent_type

Default runtime.agent_type for new conversations (open enum; e.g. claude-agent-sdk, codex, deepagent).

string

default: claude-agent-sdk

max_sticky_ttl_seconds

Cap on any conversation’s sticky lease TTL.

integer

default: 3600

max_concurrent_sticky

Cap on simultaneously leased sticky sandboxes.

integer

default: 5

metadata

required

Free-form string key–value map for host/adapter bookkeeping (e.g. a host-side reference ID). Max 50 keys; values max 500 chars. Replaced wholesale when provided in updates.

object

<= 50 properties

key

additional properties

string

<= 500 characters

created_at

required

RFC 3339 / ISO 8601 timestamp, UTC.

string format: date-time

updated_at

required

RFC 3339 / ISO 8601 timestamp, UTC.

string format: date-time

Example

{
  "object": "tenant",
  "status": "active",
  "settings": {
    "filler_enabled": true,
    "default_agent_type": "claude-agent-sdk",
    "max_sticky_ttl_seconds": 3600,
    "max_concurrent_sticky": 5
  }
}

401

Missing or invalid credentials — no bearer token, an unknown/revoked sk_int_ key, or an expired platform JWT.

application/problem+json

RFC 9457 problem+json error envelope. type is a URI under https://shiftagent.example.com/problems/{slug} (deployment host substituted); see the API-level problem registry for every slug.

object

type

required

Problem type URI (registry slug).

string format: uri-reference

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer format: int32

detail

Human-readable explanation specific to this occurrence.

string

instance

URI reference identifying this occurrence.

string format: uri-reference

request_id

Correlation ID for support and log lookup.

string

conflicting_resource_id

On name-conflict, external-id-conflict, and resource-in-use: the ID of the existing/depended-on resource — fetch it and continue (replay recovery).

string

errors

On validation-error, field-level details.

Array<object>

object

pointer

required

JSON pointer to the offending field.

string

message

required

What failed.

string

Examples

unauthorized

Missing or invalid bearer token

{
  "type": "https://shiftagent.example.com/problems/insufficient-scope",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Provide a valid sk_int_ service key or platform JWT.",
  "request_id": "req_01hzx8auth001"
}

404

Not found — the resource does not exist, was deprovisioned, or lies outside the integration key’s subtree (indistinguishable by design).

application/problem+json

RFC 9457 problem+json error envelope. type is a URI under https://shiftagent.example.com/problems/{slug} (deployment host substituted); see the API-level problem registry for every slug.

object

type

required

Problem type URI (registry slug).

string format: uri-reference

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer format: int32

detail

Human-readable explanation specific to this occurrence.

string

instance

URI reference identifying this occurrence.

string format: uri-reference

request_id

Correlation ID for support and log lookup.

string

conflicting_resource_id

On name-conflict, external-id-conflict, and resource-in-use: the ID of the existing/depended-on resource — fetch it and continue (replay recovery).

string

errors

On validation-error, field-level details.

Array<object>

object

pointer

required

JSON pointer to the offending field.

string

message

required

What failed.

string

Examples

not_found

Unknown resource

{
  "type": "https://shiftagent.example.com/problems/not-found",
  "title": "Not found",
  "status": 404,
  "detail": "No tenant with external_id acme:tenant:999999.",
  "request_id": "req_01hzx8nf001"
}