SOPCompass
Start free trial
Help center

API changelog

What changed in the SOPCompass API and when. Within v1, changes are additive only.

Business plan Updated
On this page
  1. 2026-09-19: v1 released
  2. Endpoints
  3. Keys and limits

Within v1, changes are additive only: new endpoints, new optional parameters, new response fields and new error codes. Anything that would break an integration ships as a new version under a new path, and v1 keeps working. See Versioning.

2026-09-19: v1 released

The first public version of the SOPCompass REST API, for workspaces on the Business plan.

Endpoints

  • GET /sops: list SOPs, oldest change first, with library_id, board_id, updated_since and include_archived filters and cursor pagination.
  • GET /sops/{id}: one SOP in full, with cards, steps and image_urls.
  • POST /sops: create an SOP from Markdown or plain text.
  • GET /search: the app’s full-text search.
  • GET /libraries, GET /boards, GET /people.
  • GET /assignments: list assignments, newest first, with status, assignee_email and sop_id filters and cursor pagination.
  • POST /assignments: assign an SOP to a member by email.

Keys and limits

  • API keys in People › Settings & billing › API keys, read only or read and write, shown once, up to 25 active per workspace.
  • A key stops working (401 creator_not_admin) when the owner or admin who created it is removed from the workspace or is no longer an owner or admin.
  • Keys can’t be created once a workspace’s subscription has ended.
  • 60 requests per minute per key, with X-RateLimit-* headers and Retry-After on 429.
  • Every response carries X-SOPCompass-API-Version: v1.