# Workspaces

## List workspaces

`client.workspaces.list(WorkspaceListParamsquery?, RequestOptionsoptions?): CursorPagination<Workspace>`

**get** `/v1/workspaces`

Lists all workspaces for the current account

### Parameters

- `query: WorkspaceListParams`

  - `cursor?: string`

    Pagination cursor from previous response

  - `includeInfo?: boolean`

    When set to true you may use more of your alloted API rate-limit

  - `limit?: number`

    Maximum number of results to return

  - `sortOrder?: string`

    Sort order for results (asc or desc by creation time)

### Returns

- `Workspace`

  - `metadata: AccountResourceMetadata`

    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?: string`

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

    - `labels?: Record<string, string>`

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

  - `spec: WorkspaceSpec`

    - `description?: string`

### Example

```typescript
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 workspace of client.workspaces.list()) {
  console.log(workspace.metadata);
}
```

#### Response

```json
{
  "items": [
    {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "description": "description"
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}
```

## Get the current workspace

`client.workspaces.get(RequestOptionsoptions?): Workspace`

**get** `/v1/workspaces/current`

Retrieves the workspace associated with the current API token. Useful for workspace-scoped tokens to identify which workspace they belong to.

### Returns

- `Workspace`

  - `metadata: AccountResourceMetadata`

    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?: string`

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

    - `labels?: Record<string, string>`

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

  - `spec: WorkspaceSpec`

    - `description?: string`

### Example

```typescript
import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const workspace = await client.workspaces.get();

console.log(workspace.metadata);
```

#### Response

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

## Domain Types

### Workspace

- `Workspace`

  - `metadata: AccountResourceMetadata`

    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?: string`

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

    - `labels?: Record<string, string>`

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

  - `spec: WorkspaceSpec`

    - `description?: string`

### Workspace Spec

- `WorkspaceSpec`

  - `description?: string`