Skip to main content
GET
/
api
/
v1
/
instances

​
List Instances

Retrieve all instances for your tenant.
​
status
string
Filter by status: upcoming, active, completed, archived (optional)
​
limit
number
Number of results per page (default: 100)
​
offset
number
Number of results to skip (default: 0)

​
Example Request

curl -X GET https://api.checkpoint.b-digital.uk/api/v1/instances \
  -H "X-API-Key: YOUR_API_KEY"

​
Example Response

{
  "success": true,
  "data": [
    {
      "id": "se8SajpJDWUwrEmhElLF",
      "name": "Junior Camp",
      "status": "active",
      "start_date": "2025-08-01",
      "end_date": null
    }
  ],
  "meta": {
    "total": 5,
    "limit": 100,
    "offset": 0
  }
}