SalesOS

API reference

Every public operation, read live from GET /v1/openapi.json, with a try-it console.

This page reads the live OpenAPI document, https://api.salesos.org/v1/openapi.json, in your browser, so it always matches what is deployed. Pick a resource, or search across all of them. Try it sends the request through this site to your organization with the API key you paste. The key stays in this browser tab.

Use the OpenAPI document to generate a client (openapi-generator, openapi-typescript), or import it into Postman or Insomnia. The per-resource reference has the same operations as static pages.