Guides

Everything the API reference doesn't cover: concepts, conventions, and recipes.

• Authentication

  How Partner API tokens work — claims, tenancy, rotation, and handling rules.

• Filtering & pagination

  PostgREST query operators, projection, sorting, hard limits, and keyset pagination.

• Errors & retries

  Status codes, the PostgREST error body, and recommended client behavior.

• Migrating from Symplicity

  URL shape, auth, and resource-name mapping for teams moving off the Symplicity CSM API.

• Generating a typed client

  Use the OpenAPI spec to generate TypeScript, Python, Go, Java, or Swift clients.