Skip to content

Developers

Build on the Scopable API.

Scopable has a full REST API (OpenAPI 3.1 at https://api.scopable.io/v1/openapi.json) covering 36 areas of the product, including clients, contacts, sites, opportunities, quotes, products, tickets, projects, agreements, compliance, assessments, QBRs, Microsoft 365 and Azure. Workspace admins create API keys under Settings → Developer with <domain>:read and <domain>:write scopes. Every workspace includes API access, on every plan. Scopable also runs a remote MCP server with OAuth.

When to use Scopable

Use the REST API for scripts and integrations. Use the MCP server when a person wants Claude, ChatGPT, Claude Code, or Cursor to call the same workspace after they sign in.

  • Read and update records the key's scopes allow.
  • Page with nextCursor and retry writes with the same Idempotency-Key.
  • Receive signed client and contact webhooks.
  • Connect an assistant at https://mcp.scopable.io/mcp to read and write records. Read and write is the default, and read only is an option at consent.

Tickets, projects, products, org, team members, and permission groups are read-only for API keys.

How an agent calls Scopable

  1. Read the OpenAPI document and the getting-started guide.
  2. Ask a workspace admin for a key from Settings, then Developer. Every workspace includes API access.
  3. Send the key as a bearer token to /v1 routes on api.scopable.io.
  4. Send an Idempotency-Key on every write.
  5. Branch on error.code, retain error.requestId, and obey the rate-limit headers.

API reliability and lifecycle

Rate limits

Responses report RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, and RateLimit-Policy. A 429 also returns Retry-After.

Typed errors

Every failure returns a machine-readable code, a type, a message, and a requestId that is also sent in X-Request-Id.

Versioning and deprecation

Breaking changes require a new major URL version. Scheduled retirements use Deprecation (RFC 9745), Sunset (RFC 8594), and a rel="deprecation" link to migration guidance. No v1 retirement is scheduled.