> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentlinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get workspace

> Read workspace limits, usage and membership.

`get_workspace`

Read workspace limits, usage and membership.

<Note>Available in the deployed MCP and HTTP bundle. Confirm access and inputs with your connected catalog. Workspace scopes and enabled providers still apply.</Note>

| Access          | Behavior         |
| --------------- | ---------------- |
| `projects:read` | Reads saved data |

This read does not start a verification job.

## Example request

Connect through [MCP](/guides/connect-mcp), [CLI](/guides/connect-cli), or [HTTP](/guides/connect-http). Replace example identifiers with records from your workspace.

<CodeGroup>
  ```json MCP theme={null}
  {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "get_workspace",
      "arguments": {}
    }
  }
  ```

  ```bash CLI theme={null}
  agentlinkops call get_workspace --args '{}'
  ```

  ```bash HTTP theme={null}
  curl "$AGENTLINKOPS_API_URL/v1/commands/get_workspace" \
    -H "Authorization: Bearer $AGENTLINKOPS_API_KEY" \
    -H 'Content-Type: application/json' \
    --data '{}'
  ```
</CodeGroup>

## Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in `structuredContent` and in a text content block; generic HTTP and CLI return the JSON result directly.

<Accordion title="Full response example">
  ```json theme={null}
  {
    "workspace": {
      "id": "ws_example",
      "name": "Example workspace",
      "owner_user_id": "user_example",
      "created_at": "2026-09-13T12:00:00.000Z",
      "watch_limit": 100,
      "monthly_check_limit": 3500,
      "event_sequence": 0,
      "event_floor": 0
    },
    "membership": {
      "user_id": "user_example",
      "role": "owner",
      "project_ids": null,
      "created_at": "2026-09-13T12:00:00.000Z"
    },
    "check_budget": {
      "period": "2026-09",
      "limit": 3500,
      "reserved": 0,
      "consumed": 0,
      "remaining": 3500,
      "exhausted": false,
      "resets_at": "2026-10-01T00:00:00.000Z",
      "enforced_by": "workspace_monthly_check_limit",
      "plan_allowance_enforced": false
    },
    "usage": {
      "period": "2026-09",
      "reserved": 0,
      "consumed": 0,
      "active_watches": 0,
      "active_targets": 0
    },
    "target_limit": 100
  }
  ```
</Accordion>

## Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

This operation accepts an empty object.

### Validation and omitted values

Workspace limits and usage describe the selected credential workspace.

## Output fields

Fields inside optional or nullable parents apply only when that parent exists. [Common schema conventions](/reference/schemas) explain evidence states, empty lists and extensions.

* **`workspace`** (object, required).
* **`membership`** (object, required).
* **`check_budget`** (object, required).
* **`usage`** (object, required).
* **`target_limit`** (number, required).

<Accordion title="All fields and nested objects">
  | Field                                  | Type           | Presence | Meaning and constraints                                                                      |
  | -------------------------------------- | -------------- | -------- | -------------------------------------------------------------------------------------------- |
  | `workspace`                            | object         | Required |                                                                                              |
  | `workspace.id`                         | string         | Required | Resource identifier returned by the operation.                                               |
  | `workspace.name`                       | string         | Required |                                                                                              |
  | `workspace.owner_user_id`              | string         | Required | Identifier returned by the related operation.                                                |
  | `workspace.created_at`                 | string         | Required | UTC timestamp when the record was created.                                                   |
  | `workspace.watch_limit`                | number         | Required |                                                                                              |
  | `workspace.monthly_check_limit`        | number         | Required |                                                                                              |
  | `workspace.event_sequence`             | number         | Required |                                                                                              |
  | `workspace.event_floor`                | number         | Required |                                                                                              |
  | `membership`                           | object         | Required |                                                                                              |
  | `membership.workspace_id`              | string         | Optional | Workspace that owns this record.                                                             |
  | `membership.user_id`                   | string         | Required | Identifier returned by the related operation.                                                |
  | `membership.role`                      | string         | Required |                                                                                              |
  | `membership.project_ids`               | array / null   | Optional | Accessible project identifiers; null grants access to all workspace projects.                |
  | `membership.created_at`                | string         | Optional | UTC timestamp when the record was created.                                                   |
  | `check_budget`                         | object         | Required |                                                                                              |
  | `check_budget.period`                  | string         | Required |                                                                                              |
  | `check_budget.limit`                   | number / null  | Required |                                                                                              |
  | `check_budget.reserved`                | number         | Required |                                                                                              |
  | `check_budget.consumed`                | number         | Required |                                                                                              |
  | `check_budget.remaining`               | number / null  | Required | Check units still available after consumed and reserved units; null if the limit is unknown. |
  | `check_budget.exhausted`               | boolean / null | Required |                                                                                              |
  | `check_budget.resets_at`               | string         | Required |                                                                                              |
  | `check_budget.enforced_by`             | string         | Required |                                                                                              |
  | `check_budget.plan_allowance_enforced` | boolean        | Required |                                                                                              |
  | `usage`                                | object         | Required |                                                                                              |
  | `usage.period`                         | string         | Required |                                                                                              |
  | `usage.reserved`                       | number         | Required |                                                                                              |
  | `usage.consumed`                       | number         | Required |                                                                                              |
  | `usage.active_watches`                 | number         | Required |                                                                                              |
  | `usage.active_targets`                 | number         | Required |                                                                                              |
  | `target_limit`                         | number         | Required |                                                                                              |
</Accordion>

[Download input schema](/schemas/get_workspace.input.json) · [Download output schema](/schemas/get_workspace.output.json)

## Errors and retries

The command is annotated idempotent. Reuse an accepted idempotency key when the input provides one; changing the payload under a reused key can conflict.

See [error recovery](/reference/errors) for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

## HTTP resource routes

These existing resource routes share the operation’s domain behavior. Their parameter placement, status and response envelope can differ from generic invocation. See [HTTP route details](/reference/http/routes).

| Method and route    | Success | Details                                                                                    |
| ------------------- | ------- | ------------------------------------------------------------------------------------------ |
| `GET /v1/workspace` | 200     | Resource response adds access:\{role,scopes,project\_ids} alongside workspace information. |

## Continue

[get\_usage](/reference/commands/get_usage) · [list\_projects](/reference/commands/list_projects)

Follow the [related workflow](/guides/connect-http), inspect [capability status](/capability-status), or return to the [command index](/reference/index).