---
title: "Inspect effective API capabilities"
method: GET
path: "/capabilities"
---

# Inspect effective API capabilities

`GET /capabilities`

## Request

- Base URL: `https://app.formasty.com/api/v1`
- URL: `https://app.formasty.com/api/v1/capabilities`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://app.formasty.com/oauth/authorize/api/v1`, token URL `https://app.formasty.com/oauth/token`)
  - HTTP bearer

Returns credential scopes and workspace-role permissions as separate authorization layers, plus operations that are available, conditional on a target resource, or blocked in the evaluated workspace.

## Query parameters

- `workspaceId` string

## Headers

- `X-Formasty-Workspace-Id` string

## Response `200`

Effective Formasty API capabilities.

- CapabilitiesResponse
  - `contractVersion` string, required
  - `defaultWorkProfile` object, required
  - `supportedScopes` string[], required
  - `authentication` object, required
  - `safeguards` object, required
  - `unsupported` string[], required
  - `endpoints` object, required
  - `credential` object, required
    - `type` 'api_key' | 'oauth', required
    - `scopes` string[], required
  - `workspace` object, required
  - `workspaceAccess` object, required: OAuth workspace grants and the workspace selected for this evaluation. API keys expose selected mode with one bound workspace.
  - `effectiveOperations` string[], required: Operations immediately available in the evaluated workspace without a target-form check.
  - `operationAvailability` object[], required
    - `operation` string, required
    - `effective_status` 'available' | 'conditional' | 'blocked', required
    - `requires_resource_context` boolean, required
    - `blockers` object[], required

## Other responses

- `401`: Missing or invalid credential.
- `default`: A machine-readable error with a stable code and a recovery hint. The legacy error value is retained for existing clients.

---

[API](https://skmtc.dev/formasty/apis/formasty-forms-api.md) · [All operations](https://skmtc.dev/formasty/apis/formasty-forms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/formasty/apis/formasty-forms-api/revisions/09ad7f50c693?raw)