Skip to main content

​
Base URL

Production API: https://api.checkpoint.b-digital.uk All endpoints are prefixed with /api/v1

​
Authentication

The API supports two authentication methods: Include your API key in every request using the X-API-Key header: 
X-API-Key: your-api-key-here
API keys allow admins to access the API without Firebase. Generate your API key using the API Keys guide.

​
Firebase Token Authentication

Include your Firebase ID token in the Authorization header: 
Authorization: Bearer YOUR_FIREBASE_ID_TOKEN

​
Response Format

All API responses follow a consistent format:

​
Success Response

{
  "success": true,
  "data": { ... },
  "meta": { ... }  // For list endpoints
}

​
Error Response

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable message",
    "details": "Additional details (optional)"
  }
}

​
Multi-Tenant Isolation

All endpoints automatically scope data to your tenant. You can only access data belonging to your organization.

​
Available Resources

  • Participants - Manage participant/member data
  • Instances - Manage camp/session instances
  • Groups - Manage supergroups and subgroups
  • Blocks & Rooms - Manage location assignments
  • API Keys - Manage authentication keys

​
Quick Start

  1. Get your API key - See API Keys guide
  2. Make your first request - Use the examples in each endpoint section or the API playground below
  3. Check the health endpoint - Verify API is running
curl https://api.checkpoint.b-digital.uk/health

​
Interactive API Playground

Use the interactive API playground to test endpoints directly from the documentation. Navigate to the API Playground section in the sidebar to see all available endpoints with interactive testing capabilities. The playground supports both API key and Firebase token authentication.

API Playground

Go to the interactive API playground