> ## Documentation Index
> Fetch the complete documentation index at: https://cadenya.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# List tenants
> Every tenant asserted in a workspace, newest first. The census of who your agents have worked for.
You never create a tenant. One appears the first time you assert it: on an objective, or when you [mint a widget session](/docs/api-reference/widgetsessionservice/create-a-widget-session). This list is the census of what those assertions have produced.
```typescript TypeScript theme={null}
const tenants = await client.tenants.list({ workspaceId, includeInfo: true });
for await (const tenant of tenants) {
console.log(tenant.metadata.name, tenant.state, tenant.info?.objectiveCount);
}
// Acme Corp STATE_ACTIVE 214
// Initech STATE_ACTIVE 87
// Globex STATE_ERASING 0
```
```go Go theme={null}
tenants := client.Tenants.ListAutoPaging(ctx, cadenya.TenantListParams{
WorkspaceID: cadenya.String(workspaceID),
IncludeInfo: cadenya.Bool(true),
})
for tenants.Next() {
t := tenants.Current()
fmt.Println(t.Metadata.Name, t.State, t.Info.ObjectiveCount)
}
```
```ruby Ruby theme={null}
tenants = cadenya.tenants.list(workspace_id: workspace_id, include_info: true)
tenants.auto_paging_each do |t|
puts "#{t.metadata.name} #{t.state} #{t.info&.objective_count}"
end
```
```bash cURL theme={null}
curl "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/tenants?includeInfo=true" \
-H "Authorization: Bearer ${CADENYA_API_KEY}"
```
## A tenant is a record, not a configuration
There is no `spec` on a tenant, because there is nothing to configure. Everything lives in the metadata envelope: `external_id` is the key you asserted it under, `name` is the most recent name you asserted, and `updated_at` is when you last asserted it. Assert a new name and the record updates in place.
## `info` costs extra, so ask for it
`includeInfo=true` populates three counts per tenant: `subjectCount`, `objectiveCount`, and `widgetSessionCount`. `objectiveCount` spans every surface, widget conversations and direct API objectives alike, so it is the footprint an [erase](/docs/api-reference/tenantservice/erase-a-tenant) would destroy. Each count is a query per tenant, which is why the field stays empty unless you ask.
## Filtering
`query` does a substring match against each tenant's `name` and `external_id`. It exists for type-ahead pickers, where the operator knows the customer's own identifier rather than Cadenya's. `labels` filters by metadata labels with AND semantics (`env=prod,team=ai`). `sortOrder`, `limit`, and `cursor` page the list the usual way; the SDK iterators follow the cursor for you.
## Related
Fetch one by canonical ID or `external_id:` form.
The people asserted under each tenant.
Destroy everything the counts describe.
One of the two places a tenant gets asserted.
## OpenAPI
````yaml get /v1/workspaces/{workspaceId}/tenants
openapi: 3.1.0
info:
title: Cadenya API
description: API for the Cadenya Agent Runtime platform.
version: '1.0'
servers:
- url: https://api.cadenya.com
description: Production server
security:
- bearerAuth: []
tags:
- name: AIProviderKeyService
- name: APIKeyService
description: |-
Issue, rotate, disable, and revoke a workspace's API keys. Every key
belongs to exactly one workspace; the system-managed global account key is
managed via GlobalAPIKeyService instead.
- name: AccountService
description: >-
Manage the authenticated account. Accounts are the top-level
organizational
unit and contain one or more workspaces.
- name: AgentScheduleService
description: >-
Manage recurring schedules attached to agents. Schedules trigger
objectives
on a cadence defined by AgentScheduleSpec.Schedule.
- name: AgentService
description: >-
Manage AI agents within a workspace. Agents define AI behavior and tool
access.
- name: AgentVariationService
description: >-
Manage variations of an agent and their tool, sub-agent, and memory layer
assignments.
- name: GlobalAPIKeyService
description: |-
Manage the account's system-provisioned global API key. The global key is
the only key that spans every workspace; it is created by the system and
cannot be deleted, so the surface is retrieve, rotate, and the
disable/enable kill switch.
- name: MemoryService
description: >-
Manage memory layers and their entries. Layers are named containers that
can
be composed into an objective's memory cascade; entries are the keyed values
within a layer. System-managed layers (e.g., episodic layers created by the
runtime) cannot be mutated through this API.
- name: ModelService
description: |-
Manage LLM models available to a workspace. Models represent provider and
family pairs (e.g., "anthropic/claude-sonnet-4.6"). Workspaces are seeded
with the supported models and you can enable or disable each one.
- name: ObjectiveEventStreamsService
- name: ObjectiveService
- name: ProfilesService
description: |-
Operations on profiles, the account-level principals (users, API keys,
system) that authenticate against the API.
- name: SearchService
- name: TenantService
description: >-
Read and erase tenants and the subjects under them. Tenants and subjects
are
created by assertion — on objective creation or widget session mint — never
directly, so this service has no create or update: it exists to enumerate what
assertions have produced, and to destroy it on request.
- name: ToolService
description: >-
Manage tool sets and the tools they contain. Tool sets group related
tools,
and tools define specific capabilities available to agents.
When a tool set is managed, only API key actors can modify its tools; human
(profile) actors cannot.
- name: UploadService
description: |-
Issue short-lived presigned URLs for direct client-to-object-storage
uploads. Created uploads can be referenced by id when creating or updating
resources that accept binary content (e.g., MemoryEntry).
- name: WidgetService
description: |-
Manage embeddable chat widgets. A widget binds an agent to a globally
unique hostname with a per-widget origin allowlist; browsers reach it with
session tokens minted via WidgetSessionService.
- name: WidgetSessionService
description: >-
Mint and manage widget sessions. Session creation is server-to-server
only:
the customer's backend authenticates its visitor, asserts tenant/subject
context, attaches any per-visitor secrets, and receives a short-lived
bearer token the browser uses against the widget host.
- name: WorkspaceAdminService
description: >-
Administer workspaces across the account: create and archive workspaces
and
manage their membership. These operations are account-scoped and require the
admin role (a token whose profile holds the WorkOS admin role); they live
under /v1/account/workspaces rather than the workspace-scoped /v1/workspaces
tree so an admin can manage any workspace in the account, including ones they
are not themselves a member of.
- name: WorkspaceSecretService
- name: WorkspaceService
description: |-
Manage workspaces within an account. Workspaces provide organizational
grouping and isolation for resources such as agents, tools, and API keys.
This is the workspace-scoped, end-user surface. Administrative operations
(create / archive workspaces, manage members) live in WorkspaceAdminService
under /v1/account/workspaces and require the admin role.
paths:
/v1/workspaces/{workspaceId}/tenants:
get:
tags:
- TenantService
- Tenants
summary: List tenants
description: >-
Lists the tenants asserted in a workspace, newest first. `query` matches
against a tenant's name and its external_id, for type-ahead filters.
operationId: TenantService_ListTenants
parameters:
- name: workspaceId
in: path
description: Workspace ID.
required: true
schema:
type: string
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
- name: limit
in: query
description: Maximum number of results to return.
schema:
type: integer
format: int32
- name: cursor
in: query
description: Pagination cursor from previous response.
schema:
type: string
- name: query
in: query
description: |-
Substring match against the tenant's name and external_id. Built for
type-ahead filter pickers, where the operator knows the customer's own
identifier rather than Cadenya's.
schema:
type: string
- name: labels
in: query
description: |-
Filters by metadata labels. Comma-separated key=value pairs,
e.g. "env=prod,team=ai". A resource matches only if every pair
matches exactly (AND semantics).
schema:
type: string
- name: sortOrder
in: query
description: Sort order for results (asc or desc by creation time).
schema:
type: string
- name: includeInfo
in: query
description: >-
When true, the `info` field on each returned tenant is populated.
This
costs several count queries per tenant, so it is off by default.
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListTenantsResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
x-codeSamples:
- lang: JavaScript
source: |-
import Cadenya from '@cadenya/cadenya';
const client = new Cadenya({
apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const tenant of client.tenants.list({
workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
})) {
console.log(tenant.metadata);
}
- lang: Python
source: |-
import os
from cadenya import Cadenya
client = Cadenya(
api_key=os.environ.get("CADENYA_API_KEY"), # This is the default and can be omitted
)
page = client.tenants.list(
workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
page = page.items[0]
print(page.metadata)
- lang: Go
source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"go.cadenya.com/cadenya-go\"\n\t\"go.cadenya.com/cadenya-go/option\"\n)\n\nfunc main() {\n\tclient := cadenya.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Tenants.List(context.TODO(), cadenya.TenantListParams{\n\t\tWorkspaceID: cadenya.String(\"workspace_01HXKD2E5NQM3T9AYWCF133E3Q\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n"
- lang: Ruby
source: >-
require "cadenya"
cadenya = Cadenya::Client.new(api_key: "My API Key")
page = cadenya.tenants.list(workspace_id:
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q")
puts(page)
- lang: CLI
source: |-
cadenya tenants list \
--api-key 'My API Key' \
--workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q
components:
schemas:
ListTenantsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Tenant'
pagination:
$ref: '#/components/schemas/Page'
description: List tenants response.
Status:
type: object
properties:
code:
type: integer
description: >-
The status code, which should be an enum value of
[google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: >-
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
[google.rpc.Status.details][google.rpc.Status.details] field, or
localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: >-
A list of messages that carry the error details. There is a common
set of message types for APIs to use.
description: >-
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It
is used by [gRPC](https://github.com/grpc). Each `Status` message
contains three pieces of data: error code, error message, and error
details. You can find out more about this error model and how to work
with it in the [API Design
Guide](https://cloud.google.com/apis/design/errors).
Tenant:
required:
- metadata
- state
type: object
properties:
metadata:
$ref: '#/components/schemas/ResourceMetadata'
info:
$ref: '#/components/schemas/TenantInfo'
state:
readOnly: true
enum:
- STATE_UNSPECIFIED
- STATE_ACTIVE
- STATE_ERASING
type: string
description: The current lifecycle state of the tenant. Output only.
format: enum
description: >-
Tenant is the customer's organization as a readable record rather than
an
echo. It carries no spec: a tenant is never configured, only asserted, so
everything about it lives in the metadata envelope — `external_id` is the key
the customer asserted it under, `name` is the most recent name they asserted,
and `updated_at` is therefore when the tenant was last asserted.
Page:
type: object
properties:
nextCursor:
type: string
description: >-
Page carries cursor-based pagination state. There is no total: the
cursor
walks the result set without ever counting it, and a count would cost a second
query on every list.
GoogleProtobufAny:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: >-
Contains an arbitrary serialized message along with a @type that
describes the type of the serialized message.
ResourceMetadata:
required:
- id
- accountId
- workspaceId
- name
- profileId
- createdAt
type: object
properties:
id:
readOnly: true
type: string
description: >-
Unique identifier for the resource (prefixed ULID, e.g.,
"agent_01HXK...")
accountId:
readOnly: true
example: account_01HXKD2E5NQM3T9AYWCFTJHJVF
type: string
description: >-
Account this resource belongs to for multi-tenant isolation
(prefixed ULID)
workspaceId:
readOnly: true
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
type: string
description: >-
Workspace this resource belongs to for organizational grouping
(prefixed ULID)
name:
type: string
description: >-
Human-readable name for the resource (e.g., "Customer Support
Agent", "Email Tool")
Required for resources that users interact with directly
externalId:
type: string
description: >-
External ID for the resource (e.g., a workflow ID from an external
system)
labels:
type: object
additionalProperties:
type: string
description: |-
Key-value pairs for categorization and filtering. Values are 0-63
alphanumeric characters with "-", "_", or "." allowed between; keys
follow the same shape and additionally accept an optional DNS-subdomain
prefix (e.g. "cadenya.com/") of at most 253 characters.
Examples: {"environment": "production", "team": "platform", "version": "v2"}
profileId:
readOnly: true
example: profile_01HXKD2E5NQM3T9AYWCFS0AP08
type: string
description: ID of the actor (user or service account) that created this resource
createdAt:
readOnly: true
type: string
description: Timestamp when this resource was created
format: date-time
updatedAt:
readOnly: true
type: string
description: Timestamp when this resource was last updated
format: date-time
description: >-
Standard metadata for persistent, named resources (e.g., agents, tools,
prompts)
TenantInfo:
type: object
properties:
subjectCount:
readOnly: true
type: integer
description: Number of subjects asserted under this tenant.
format: int32
objectiveCount:
readOnly: true
type: integer
description: >-
Number of objectives associated with this tenant, across every
surface —
widget conversations and objectives created directly against the API
alike. This is the footprint a delete would destroy, which is why it is
worth the count query that populating `info` costs.
format: int32
widgetSessionCount:
readOnly: true
type: integer
description: Number of widget sessions minted for this tenant that still exist.
format: int32
description: TenantInfo provides read-only server-derived data about a tenant.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````