API Documentation

Use the SiteSafe REST API to manage visitors and sites programmatically.

Authentication

All API requests require a Bearer token. You can generate your company’s API key in the Settings page of your SiteSafe dashboard.

Include the key in the Authorization header:

Authorization: Bearer ss_your_api_key_here

Base URL

https://sitesafe.thesift.space/api/v1

Endpoints

GET/sites

Returns all sites belonging to your company.

curl -H "Authorization: Bearer YOUR_KEY" \
     https://sitesafe.thesift.space/api/v1/sites

Example response

[
  {
    "id": "cmp...",
    "name": "Headquarters",
    "slug": "headquarters",
    "address": "123 Main St",
    "safetyBriefingText": "Please sign in..."
  }
]

GET/visitors

Returns visitor logs, optionally filtered by site or date range.

Query parameters:

siteId – filter by site ID
from – start date (YYYY-MM-DD)
to – end date (YYYY-MM-DD)

curl -H "Authorization: Bearer YOUR_KEY" \
     "https://sitesafe.thesift.space/api/v1/visitors?from=2026-06-01&to=2026-06-30"

POST/visitors

Creates a new visitor record (simulates a check‑in). The site must belong to your company.

Required body fields:

fullName
company
siteId

Optional: phone, email, hostName, safetyAcknowledged (boolean)

curl -X POST \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fullName":"Jane Doe","company":"Acme","siteId":"cmp..."}' \
  https://sitesafe.thesift.space/api/v1/visitors

POST/visitors/{visitorId}/signout

Signs out an existing visitor. The visitor must belong to your company.

curl -X POST \
  -H "Authorization: Bearer YOUR_KEY" \
  https://sitesafe.thesift.space/api/v1/visitors/cmp.../signout

Errors

The API returns standard HTTP status codes. A JSON body with anerror field is included for failures.

401 – Missing or invalid API key
400 – Missing required fields
404 – Resource not found or access denied
429 – Rate limit exceeded (future)

Support

If you have questions or need help with the API, email us at cloudandclipboard@gmail.com.