Skip to content
Test environment - these docs describe the GuardianCheckin sandbox API. For production, see docs.guardiancheckin.com.

Overview

The GuardianCheckin Public Developer API. A stable, versioned (/v1/) read surface over your listings and forms, decoupled from GuardianCheckin’s internal data shapes (Story 37.4, FR-API-20). Authentication is a bearer API key (Authorization: Bearer gck_live_<prefix>.<secret>) on the api.gcheckin.com host. Every request is scoped to the listings the key’s owner owns or writer-manages; out-of-scope or unknown ids return 404 with no existence disclosure. Pagination is keyset/cursor based. nextCursor is an opaque token — treat it as a black box and pass it back verbatim as the cursor query parameter to fetch the next page. A null nextCursor means the last page was reached. Cursors are stable over inserts/deletes: a row added during iteration appears only if it sorts after your current position; already-returned pages never shift.

  • OpenAPI version: 3.0.1

A GuardianCheckin API key, sent as Authorization: Bearer gck_live_<prefix>.<secret>.

Security scheme type: http