Skip to main content
GET
/
api
/
v1
/
participants
{
  "success": true,
  "data": [
    {}
  ],
  "meta": {}
}

​
List Participants

Retrieve a list of participants, optionally filtered by instance or status.
​
instance_id
string
Filter by instance ID (optional)
​
status
string
Filter by status: active, inactive (optional)
​
limit
number
Number of results per page (default: 50)
​
offset
number
Number of results to skip (default: 0)
​
success
boolean
Indicates if the request was successful
​
data
array
Array of participant objects
​
meta
object
Pagination metadata (total, limit, offset)

​
Example Request

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

​
Example Response

{
  "success": true,
  "data": [
    {
      "id": "20527",
      "user_id": "20527",
      "first_name": "Ella",
      "surname": "Lassman",
      "full_name": "Ella Lassman",
      "status": "active",
      "instance_id": "se8SajpJDWUwrEmhElLF",
      "supergroup_name": "Junior Camp",
      "subgroup_name": "Dragon",
      "block_name": "Block A",
      "room_number": "9"
    }
  ],
  "meta": {
    "total": 150,
    "limit": 50,
    "offset": 0
  }
}