Getting started

From an API key to your first 200 in one scroll.

1. Mint a key

Sign in to GuardianCheckin, open the profile-photo dropdown → API Keys, and create a key. The secret is shown once - copy it now. A key looks like gck_live_<prefix>.<secret>.

2. Export it

shell

export GCK_KEY=gck_live_<prefix>.<secret>
export PUBLIC_API_BASE=https://api.gcheckin.com
export BODY=$(mktemp)

3. Make your first call

List the listings your key can see:

# EXPECT: 200
curl -sS -o "$BODY" -w '%{http_code}' \
  -H "Authorization: Bearer $GCK_KEY" \
  "$PUBLIC_API_BASE/v1/listings"

A 200 returns a cursor-paginated page. items holds the listings; pass nextCursor back as the cursor query parameter to fetch the next page (a null nextCursor means the last page). Inspect the body with cat "$BODY":

200 OK - response body

{
  "items": [
    {
      "id": "8f2b1c4e-9a7d-4b2e-bf1a-2c3d4e5f6071",
      "publicId": "sunset-villa",
      "title": "Sunset Villa",
      "address": "123 Ocean Drive",
      "city": "Cartagena",
      "country": "CO",
      "zipCode": "130001",
      "district": "Bocagrande",
      "timezone": "America/Bogota",
      "active": true,
      "maxPeopleInListing": 6,
      "maxVehicles": 2,
      "allowPets": true,
      "createdAt": "2026-01-15T14:32:00Z"
    }
  ],
  "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTAxLTE1VDE0OjMyOjAwWiIsImlkIjoiOGYyYjFjNGUifQ"
}

That’s it - key to first 2xx without a support ticket. Next: read the authentication walkthrough and the error codes, or browse the full API reference.