---
title: "Get authenticated API capabilities"
method: GET
path: "/v1/capabilities"
tags: ["Platform"]
---

# Get authenticated API capabilities

`GET /v1/capabilities`

## Request

- Base URL: `https://api.mailrith.com`
- URL: `https://api.mailrith.com/v1/capabilities`
- Auth: HTTP bearer

Returns the current workspace context, discovery URLs, shared request conventions, supported webhook events, and public resource operations available to the authenticated bearer credential.

## Response `200`

Successful response

- object
  - `data` Capabilities, required
    - `version` string, required
    - `workspace` object, required
      - `id` string, required
      - `name` string, required
    - `authentication` object, required
      - `type` 'bearer', required
      - `header_name` string, required
      - `header_value_prefix` string, required
      - `workspace_scoped` boolean, required
      - `scopes_supported` string[], required
      - `supported_credential_types` string[], required
    - `credential` union, required
      - object
        - `type` 'workspace_api_key', required
        - `id` string, required
        - `name` string, required
        - `status` 'active' | 'expired' | 'revoked' | 'rotated', required
        - `scopes` string[], required
        - `key_preview` string, required
        - `expires_at` string, date-time, nullable
        - `last_used_at` string, date-time, nullable
        - `revoked_at` string, date-time, nullable
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
      - object
        - `type` 'oauth_access_token', required
        - `id` string, required
        - `status` 'active', required
        - `scopes` string[], required
        - `token_preview` string, required
        - `client` object, required
          - `id` string, required
          - `name` string, required
        - `created_by_user_id` string, nullable, required
        - `last_authorized_by_user_id` string, nullable, required
        - `expires_at` string, date-time, required
        - `last_used_at` string, date-time, nullable
        - `revoked_at` string, date-time, nullable
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
    - `discovery` object, required
      - `documentation_url` string, required
      - `reference_url` string, required
      - `agents_url` string, required
      - `sdk_docs_url` string, required
      - `typescript_sdk_url` string, required
      - `python_sdk_url` string, required
      - `mcp_docs_url` string, required
      - `mcp_url` string, required
      - `llms_url` string, required
      - `llms_full_url` string, required
      - `openapi_url` string, required
      - `webhook_subscriptions_url` string, required
      - `oauth_authorization_server_url` string, required
    - `sdks` PublicApiSdks, required
      - `typescript` object, required
        - `package_name` string, required
        - `docs_url` string, required
        - `language` 'typescript', required
      - `python` object, required
        - `package_name` string, required
        - `docs_url` string, required
        - `language` 'python', required
    - `mcp` PublicApiMcp, required
      - `package_name` string, required
      - `docs_url` string, required
      - `server_url` string, required
      - `recommended_transport` 'streamable_http', required
      - `supported_transports` string[], required
      - `active_toolsets` string[], nullable: Toolsets selected for this MCP request. Omitted for direct REST requests.
      - `active_operation_ids` string[], nullable: Exact operation IDs exposed by this MCP client's active tool catalog. Omitted for direct REST requests and unrestricted MCP clients.
      - `read_only` boolean: True when this MCP request is restricted to read-only operations.
    - `conventions` object, required
      - `pagination_type` 'cursor', required
      - `pagination_limit_param` string, required
      - `pagination_cursor_param` string, required
      - `idempotency_header` string, required
    - `capability_mode` 'effective', required: Resources contain only operations currently available to this credential, plan, workspace state, rollout state, and active MCP client catalog when called through MCP.
    - `limitations` object[], required: Current plan or workspace prerequisites that caused otherwise supported operations to be omitted.
      - `code` string, required
      - `message` string, required
      - `affected_operation_ids` string[], required: Exact operation IDs omitted because of this limitation.
      - `setup_url` string, uri
    - `events` WebhookEventSupport, required
      - `subscriptions_url` string, required
      - `supported_events` string[], required
      - `supported_event_patterns` string[], required
      - `signing` WebhookSigning, required
        - `algorithm` 'hmac-sha256', required
        - `id_header` string, required
        - `timestamp_header` string, required
        - `signature_header` string, required
        - `signature_prefix` string, required
    - `resources` CapabilityResource[], required
      - `key` string, required
      - `name` string, required
      - `description` string, required
      - `operations` CapabilityOperation[], required
        - `method` string, required
        - `path` string, required
        - `operation_id` string, required
        - `summary` string, required
        - `required_scopes` string[], required

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/mailrith/apis/mailrith-api.md) · [All operations](https://skmtc.dev/mailrith/apis/mailrith-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mailrith/apis/mailrith-api/revisions/41f09536f2da?raw)
