Skip to content
Scopable

SCOPABLE DEVELOPERS

Build on the Scopable platform.

Connect tenant-scoped systems to Scopable clients and contacts with a versioned REST API, a public OpenAPI specification, and signed outbound webhooks.

When to use Scopable

Reach for the Scopable API when an MSP automation or agent needs to work with tenant-scoped client organizations or contacts.

  • Sync client organizations or contacts from an approved CRM or PSA workflow.
  • Read and update Scopable client records.
  • Search, create, update, archive, or restore client contacts.
  • React to signed client or contact change webhooks.

API keys from Settings → Developer carry client and contact scopes only, so they cannot reach quotes, opportunities, assessments, or roadmaps yet.

How an agent calls Scopable

  1. Read the OpenAPI specification and getting-started guide.
  2. Ask a tenant administrator for a least-privilege API key from Settings → Developer.
  3. Send it as a bearer token to the versioned /v1 routes.
  4. Send an Idempotency-Key on every write and reuse it when retrying.
  5. Branch on error.code, retain error.requestId, and obey quota headers.

Scopable OpenAPI 3.1 specification

Machine-readable schemas and operations for the Scopable client and contact API.

Open resource

Scopable API getting-started guide

Create an API key, authenticate requests, paginate results, and make idempotent writes.

Open resource

Scopable API authentication

Use a scoped bearer API key from Settings → Developer. Live and test keys are supported.

Open resource

Scopable signed webhooks

Receive HMAC-signed client and contact changes without polling the API.

Open resource

API reliability and lifecycle

Rate limits

Each key allows 600 reads and 60 writes per minute. Responses report RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset. A 429 also returns Retry-After.

Typed errors

Every failure returns a machine-readable code, a human-readable 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.

Start for free