Skip to main content

API Reference

The Gauzr API is organized around REST. It uses predictable, resource-oriented URLs, returns JSON, and relies on standard HTTP status codes and verbs.

Base URL https://api.gauzr.com
Version /v1
Auth Authorization: Bearer <api_key>

Conventions

  • JSON everywhere. Send Content-Type: application/json; responses are JSON.
  • IDs are prefixed. Every object ID carries its type — insp_… for inspections, fnd_… for findings, evt_… for events.
  • Timestamps are UTC in ISO 8601 (2026-07-21T09:12:04Z).
  • Idempotency. Send an Idempotency-Key header on POST requests to make retries safe.

Endpoints

Inspections

MethodPathDescription
POST/v1/inspectionsCreate an inspection and its capture link.
GET/v1/inspections/:idRetrieve an inspection and its status.
GET/v1/inspectionsList inspections, most recent first.
POST/v1/inspections/:id/cancelCancel an inspection before completion.

Reports

MethodPathDescription
GET/v1/inspections/:id/reportRetrieve the completed report.

Media

MethodPathDescription
GET/v1/media/:id/full.jpgRetrieve an evidence photo.

Pagination

List endpoints are cursor-paginated. Pass limit (max 100) and the next_cursor from the previous response:

curl "https://api.gauzr.com/v1/inspections?limit=20&cursor=insp_3fJ2c9" \
-H "Authorization: Bearer $GAUZR_API_KEY"
{
"data": [ /* … inspections … */ ],
"has_more": true,
"next_cursor": "insp_1aB4d0"
}

For request-level detail on the two integration paths, see Inspection Links and Webhooks. For the report schema, see Reports.