Get a workspace by ID

GET/v1/account/workspaces/{workspaceId}

Retrieves a workspace in the account by ID. Admin only.

Path ParametersExpand Collapse

workspaceId: string

ReturnsExpand Collapse

Workspace object { metadata, spec, status }

metadata: AccountResourceMetadata { id, accountId, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: string

Unique identifier for the resource (prefixed ULID, e.g., “apikey_01HXK…”)

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

name: string

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”) Required for resources that users interact with directly

profileId: string

externalId: optional string

External ID for the resource (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: WorkspaceSpec { description }

description: optional string

status: optional "STATUS_ENABLED" or "STATUS_DISABLED" or "STATUS_ARCHIVED"

Lifecycle status of the workspace. Archived workspaces reject all requests scoped to them. Server-populated.

formatenum

One of the following:

"STATUS_ENABLED"

"STATUS_DISABLED"

"STATUS_ARCHIVED"

Get a workspace by ID

curl https://api.cadenya.com/v1/account/workspaces/$WORKSPACE_ID \
    -H "Authorization: Bearer $CADENYA_API_KEY"

{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "name": "name",
    "profileId": "profileId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "description": "description"
  },
  "status": "STATUS_ENABLED"
}

Returns Examples

{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "name": "name",
    "profileId": "profileId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "description": "description"
  },
  "status": "STATUS_ENABLED"
}