---
title: "get_workspace"
method: GET
path: "/v1/workspace"
---

# get_workspace

`GET /v1/workspace`

## Request

- Base URL: `https://app.agentlinkops.com`
- URL: `https://app.agentlinkops.com/v1/workspace`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Resource response adds access:{role,scopes,project_ids} alongside workspace information.

## Headers

- `X-Workspace-ID` string

## Response `200`

Resource response adds access:{role,scopes,project_ids} alongside workspace information.

- object
  - `workspace` object, required
    - `id` string, required: Resource identifier returned by the operation.
    - `name` string, required
    - `owner_user_id` string, required
    - `created_at` string, required: UTC timestamp when the record was created.
    - `watch_limit` number, required
    - `monthly_check_limit` number, required
    - `event_sequence` number, required
    - `event_floor` number, required
  - `membership` object, required
    - `workspace_id` string: Workspace that owns this record.
    - `user_id` string, required
    - `role` string, required
    - `project_ids` string[], nullable: Accessible project identifiers; null grants access to all workspace projects.
    - `created_at` string: UTC timestamp when the record was created.
  - `check_budget` object, required
    - `period` string, required
    - `limit` number, nullable, required
    - `reserved` number, required
    - `consumed` number, required
    - `remaining` number, nullable, required: Check units still available after consumed and reserved units; null if the limit is unknown.
    - `exhausted` boolean, nullable, required
    - `resets_at` string, required
    - `enforced_by` string, required
    - `plan_allowance_enforced` boolean, required
  - `usage` object, required
    - `period` string, required
    - `reserved` number, required
    - `consumed` number, required
    - `active_watches` number, required
    - `active_targets` number, required
  - `target_limit` number, required
  - `operator` boolean: True only for the configured operator using a human session.
  - `access` object
    - `role` string, nullable, required
    - `scopes` string[], required
    - `project_ids` string[], nullable, required

## Other responses

- `429`: Request-rate or usage refusal. Inspect error.code and recovery details before retrying.
- `default`: Error envelope. Non-configuration 5xx messages are masked and details omitted; allowlisted configuration errors retain static operator recovery.

---

[API](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api.md) · [All operations](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/revisions/1bf30c2912b2?raw)