QEHSQEHS
Book a demo

Developer portal

API reference

All public endpoints follow the same patterns: bearer authentication, JSON bodies, cursor pagination, idempotency keys, and rate-limit headers.

Live OpenAPI spec

The full OpenAPI 3.1 document is served from your QEHS tenant, it includes your modules and is always current.

GET https://app.qehsethos.com/api/docs/spec.json · authenticate with your API key to see tenant-specific endpoints.

Open interactive consoleDownload specPostman collection

Endpoints

16 endpoints across records, attachments, exports, modules, and SCIM. Click any path for code samples in 5 languages.

MethodPathSummaryTags
GET/api/v1/recordsList recordsrecords
POST/api/v1/recordsCreate recordrecords
GET/api/v1/records/{id}Get recordrecords
PATCH/api/v1/records/{id}Update recordrecords
POST/api/v1/records/{id}:transitionTransition recordrecordsworkflow
DELETE/api/v1/records/{id}Delete recordrecords
POST/api/modules/{moduleKey}/bulkBulk load recordsrecordsbulk
POST/api/v1/attachmentsRequest upload URLattachments
GET/api/v1/attachments/{id}Get attachment URLattachments
POST/api/v1/exportsStart export jobexports
GET/api/v1/exports/{jobId}Poll export jobexports
GET/api/v1/modulesList modulesmodules
GET/api/v1/modules/{moduleKey}Get module schemamodules
POST/api/scim/v2/UsersSCIM: create userscimauth
PATCH/api/scim/v2/Users/{id}SCIM: patch userscimauth
POST/api/scim/v2/GroupsSCIM: create groupscimauth

Conventions

  • All requests authenticate with Authorization: Bearer $QEHS_API_KEY.
  • Pagination uses cursor (nextCursor), not page/offset.
  • Timestamps are always ISO 8601 with timezone (Z for UTC).
  • Errors follow RFC 7807 problem+json with type, title, detail, code, and traceId.
  • Supply Idempotency-Key on unsafe methods to make retries safe.
  • GraphQL is available at /api/graphql with the same auth model.