Get workspace

get_workspace Read limits and usage for your selected workspace.

Name recorded in the 2026-10-17 deployment. This page describes current source; verify inputs and access in your connected catalog. Provider configuration and workspace access still apply.

Access	Behavior
`projects:read`	Reads saved data

This read does not start a verification job.

Example request

Connect through MCP, CLI, or HTTP. Replace example identifiers with records from your workspace.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_workspace",
    "arguments": {}
  }
}

agentlinkops call get_workspace --args '{}'

curl --fail-with-body https://app.agentlinkops.com/v1/commands/get_workspace \
  -H "Authorization: Bearer $AGENTLINKOPS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{}'

Returned result

Schema-validated example; IDs and dates are illustrative. MCP returns this data in structuredContent and in a text content block; generic HTTP and CLI return the JSON result directly.

Full response example

{
  "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
}

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 explain evidence states, empty lists and extensions.

workspace (object, required).
membership (object, required).
monitor_credits (object, optional).
check_budget (object, required).
usage (object, required).
target_limit (number, required).

All fields and nested objects

Types, allowed values, limits and nested fields:

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.
`monitor_credits`	object	Optional
`monitor_credits.policyVersion`	number	Required	must equal `1`
`monitor_credits.selectedPolicy`	string	Required	must equal `"monitor_shared_credits_v1"`
`monitor_credits.enforcementActive`	boolean	Required
`monitor_credits.allowanceCredits`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`monitor_credits.remainingCredits`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`monitor_credits.reservedCredits`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`monitor_credits.consumedCredits`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`monitor_credits.protectedCredits`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`monitor_credits.availableCredits`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`monitor_credits.forecastMonitoringCredits`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`monitor_credits.period`	object / null	Required
`monitor_credits.period.id`	string	Required	Resource identifier returned by the operation.
`monitor_credits.period.startsAt`	string	Required
`monitor_credits.period.endsAt`	string	Required
`monitor_credits.rates`	object	Required	additional fields rejected
`monitor_credits.rates.check`	number	Required	must equal `1`
`monitor_credits.rates.check_target`	number	Required	must equal `1`
`monitor_credits.rates.lookup`	number	Required	must equal `1000`
`monitor_credits.rates.crawl`	number	Required	must equal `20`
`monitor_credits.rates.retained_read`	number	Required	must equal `0`
`monitor_credits.rates.ai_citation_report`	number	Required	must equal `0`
`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

Download input schema · Download output schema

Errors and retries

Follow the error recovery before retrying this read. Preserve the selected workspace, project, filters and feed. Recovering a read does not require an idempotency key or another verification job. See error recovery 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.

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

Continue

get_usage · list_projects Follow the related workflow. See capability status for availability or the command index for another operation.

Overview

MCP, CLI and API commands

CLI client

HTTP and events

Optional local workflows

Example request

Returned result

Input fields

Validation and omitted values

Output fields

Errors and retries

HTTP resource routes

Continue

​Example request

​Returned result

​Input fields

​Validation and omitted values

​Output fields

​Errors and retries

​HTTP resource routes

​Continue

Example request

Returned result

Input fields

Validation and omitted values

Output fields

Errors and retries

HTTP resource routes

Continue