SOPCompass
Start free trial
Help center

API

The SOPCompass REST API: keys, endpoints and examples.

  1. SOPCompass API overviewBusinessThe SOPCompass REST API reads your SOPs, libraries, boards, people and assignments, assigns SOPs and adds new SOPs, from your own code or a no-code tool.
  2. API quickstartBusinessCreate a read-only key, list your libraries and SOPs, then read one SOP in full. Four steps, about two minutes.
  3. Authentication and API keysBusinessOwners and admins create read only or read and write keys in People, Settings and billing. Send a key as a Bearer token in the Authorization header, never in a URL.
  4. Rate limitsBusinessEach key gets 60 requests per calendar minute. Every counted response carries X-RateLimit headers, and a 429 carries Retry-After in seconds.
  5. PaginationBusinessGET /sops and GET /assignments return pages of up to 100 items. Pass next_cursor back as cursor, with the same filters, until has_more is false.
  6. ErrorsBusinessErrors share one shape, an HTTP status plus a stable error code. Branch on the code, show the message to people, and retry only 429 and 500.
  7. Filtering and updated_sinceBusinessEvery filter on GET /sops and GET /assignments, what counts as a change to an SOP, and the exact polling pattern that never misses one.
  8. List SOPsBusinessReference for GET /sops, the paginated list of SOPs ordered by updated_at, with every parameter, field and error.
  9. Get an SOPBusinessReference for GET /sops/{id}, which returns an SOP's fields plus its cards, steps and image URLs, archived or not.
  10. Create an SOPBusinessReference for POST /sops, which turns a title plus Markdown or plain text into a new SOP with one card per heading.
  11. Search SOPsBusinessReference for GET /search, which returns up to 50 SOPs matching a query, with phrase, or and exclude syntax.
  12. List librariesBusinessReference for GET /libraries, which returns every library the workspace can see in one response, own libraries first.
  13. List boardsBusinessReference for GET /boards, which returns the workspace's boards (pillars) in display order, in one response.
  14. List peopleBusinessReference for GET /people, which returns every member of the workspace in one response, sorted by name.
  15. List assignmentsBusinessReference for GET /assignments, the paginated list of who has been assigned which SOP, with open, overdue and completed status.
  16. Assign an SOPBusinessReference for POST /assignments, which assigns an SOP to a member by sign-in email, refuses duplicates and sends no email.
  17. Guide: keep a knowledge base in syncBusinessA complete, restartable sync job that copies every SOP out of SOPCompass, then picks up only what changed, including archives and deletions.
  18. Guide: build an internal chatbot on your SOPsBusinessRetrieve the right SOPs with full-text search, turn their cards into clean text, and ground a language model's answer in them with links back to the app.
  19. Guide: auto-assign onboarding SOPs to new hiresBusinessWhen a new hire joins your workspace, assign every SOP in your onboarding library that fits their departments, with a due date, and notify them yourself.
  20. Guide: Zapier, Make and n8nBusinessStep-by-step HTTP setups for Zapier, Make and n8n. Poll for new SOPs and assignments, assign SOPs, and create SOPs from Markdown.
  21. API security best practicesBusinessA checklist for running integrations safely, from scoping and storing keys to rotating them, reacting to a leak and rendering SOP HTML.
  22. API changelogBusinessWhat changed in the SOPCompass API and when. Within v1, changes are additive only.