Participants - API Reference - PlanDocket Documentation

Endpoints

GET


                    /api/v1/participants

List all participants

GET


                    /api/v1/participants/{id}

Retrieve a single participant

POST


                    /api/v1/participants

Add a participant

PUT/PATCH


                    /api/v1/participants/{id}

Update a participation

DELETE


                    /api/v1/participants/{id}

Remove a participation

Query Parameters

Parameter	Description
`event_key`	Filter by event key
`customer_number`	Filter by customer number
`confirmed`	Filter by confirmation status (0 or 1)
`include`	Include related data (contact, event, category)

Request Schema

Parameter	Type	Required	Description
`event_key`	string	Yes	Event key to identify the event
`customer_number`	string	Yes	Customer number to identify the contact
`is_confirmed`	boolean	No	Whether the participation is confirmed

Response Schema

Field	Type
`id`	integer
`event_id`	integer
`contact_id`	integer
`is_confirmed`	boolean
`created_at`	string
`updated_at`	string

Code Examples

curl -X GET "https://your-tenant.plandocket.com/api/v1/participants" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://your-tenant.plandocket.com';

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => $baseUrl . '/api/v1/participants',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
    ],
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

print_r($data);

const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://your-tenant.plandocket.com';

const response = await fetch(`${baseUrl}/api/v1/participants`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

import requests

api_key = 'YOUR_API_KEY'
base_url = 'https://your-tenant.plandocket.com'

headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json',
}

response = requests.get(f'{base_url}/api/v1/participants', headers=headers)
data = response.json()
print(data)

Sample Response

200 OK

{
  "data": {
    "participant_id": 1,
    "created_at": 1704067200,
    "updated_at": 1704067200
  },
  "meta": {
    "request_id": "req_abc123"
  }
}