Developer API · v1.0.0

Build integrations against the product vocabulary.

One clear contract for crewQI data, employee provisioning, and operational workflows. Organization-bound keys keep TEST and LIVE isolated while the API stays aligned with the app.

Open API reference Download openapi.yaml

Start with the essentials

The shortest path from a customer key to a working integration.

Quick startAuthentication, environments, and the first request AuthenticationScopes, validity, rotation, and organization boundaries Resource catalogFind every product entity and command in the API

API reference

v1.0.0

Browse operations, schemas, required scopes, and copyable request examples generated from OpenAPI 3.1.1.

Use locations for the product entity. The API does not expose a buildings alias.

GET https://api-test.crewqi.com/healthz reports stable API version: 1.0.0 and the exact deployed releaseId. The release ID is operational provenance, not a new public API version.

The employer app’s Cards/List choice is a per-resource, browser-local preference. There is no card/list preference endpoint or cross-browser synchronization contract.

Browse the referenceInteractive endpoint and schema explorer Employee bank accountsUse the restricted individual subresource and dual scopes Materials and orderingSearch article numbers and use one preferred HTTPS ordering source Reusable location contactsUse tenant-safe personal data, ordered links, and primary projections Time entries and correctionsSeparate immutable scan evidence from audited effective time SCIM provisioningConnect employee lifecycle automation