Skip to main content
GET
/
api
/
v1
/
participants
List Participants
curl --request GET \
  --url https://api.checkpoint.b-digital.uk/api/v1/participants \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": {},
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Query Parameters

instance_id
string

Filter by instance ID

status
enum<string>

Filter by status

Available options:
active,
inactive
limit
integer
default:50

Number of results per page

offset
integer
default:0

Number of results to skip

Response

200 - application/json

List of participants

success
boolean
Example:

true

data
object
meta
object