## List workspaces

`workspaces.list(**kwargs) -> CursorPagination<Workspace>`

**get** `/v1/workspaces`

Lists all workspaces for the current account

### Parameters

- `cursor: String`

  Pagination cursor from previous response

- `include_info: bool`

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

- `limit: Integer`

  Maximum number of results to return

- `sort_order: String`

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

### Returns

- `class 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...")

    - `account_id: 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

    - `profile_id: String`

    - `external_id: String`

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

    - `labels: Hash[Symbol, String]`

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

  - `spec: WorkspaceSpec`

    - `description: String`

  - `status: :STATUS_ENABLED | :STATUS_DISABLED | :STATUS_ARCHIVED`

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

    - `:STATUS_ENABLED`

    - `:STATUS_DISABLED`

    - `:STATUS_ARCHIVED`

### Example

```ruby
require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

page = cadenya.workspaces.list

puts(page)
```

#### Response

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