> ## 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 workspace members > Lists the members of a workspace. Admin only. ```typescript TypeScript theme={null} for await (const member of client.workspaceAdmin.members.list({ workspaceId })) { console.log(member.actorId); } ``` ```go Go theme={null} page, err := client.WorkspaceAdmin.Members.List(ctx, cadenya.WorkspaceAdminMemberListParams{ WorkspaceID: cadenya.String(workspaceID), }) for _, member := range page.Items { fmt.Println(member.ActorID) } ``` ```ruby Ruby theme={null} page = cadenya.workspace_admin.members.list(workspace_id: workspace_id) page.auto_paging_each do |member| puts member.actor_id end ``` ```bash cURL theme={null} curl "https://api.cadenya.com/v1/account/workspaces/${WORKSPACE_ID}/members" \ -H "Authorization: Bearer ${CADENYA_API_KEY}" ``` ## OpenAPI ````yaml get /v1/account/workspaces/{workspaceId}/members 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/account/workspaces/{workspaceId}/members: get: tags: - WorkspaceAdminService - Workspace Admin summary: List workspace members description: Lists the members of a workspace. Admin only. operationId: WorkspaceAdminService_ListWorkspaceMembers parameters: - name: workspaceId in: path description: The workspace whose members will be listed (path). 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 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListWorkspaceMembersResponse' 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 workspaceMember of client.workspaceAdmin.members.list({ workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q', })) { console.log(workspaceMember.actorId); } - 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.workspace_admin.members.list( workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q", ) page = page.items[0] print(page.actor_id) - 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.WorkspaceAdmin.Members.List(context.TODO(), cadenya.WorkspaceAdminMemberListParams{\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.workspace_admin.members.list(workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q") puts(page) - lang: CLI source: |- cadenya workspace-admin:members list \ --api-key 'My API Key' \ --workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q components: schemas: ListWorkspaceMembersResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/WorkspaceMember' pagination: $ref: '#/components/schemas/Page' 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). WorkspaceMember: required: - profileId - actorId type: object properties: profileId: readOnly: true example: profile_01HXKD2E5NQM3T9AYWCFS0AP08 type: string description: The account profile that has access to the workspace. actorId: readOnly: true example: actor_01HXKD2E5NQM3T9AYWCFKM4E2P type: string description: >- The actor row linking the profile to the workspace (the junction record). name: readOnly: true type: string description: Display name of the member's profile. email: readOnly: true type: string description: Email address of the member's profile. addedAt: readOnly: true type: string description: When the member was added to the workspace. format: date-time description: >- A member of a workspace: the profile granted access plus the actor row that links it to the workspace. Returned by member list/add operations. 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. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````