Events - API Reference - PlanDocket Documentation

Endpoints

GET


                    /api/v1/events

List all events

GET


                    /api/v1/events/{id}

Retrieve a single event

POST


                    /api/v1/events

Create a new event

PUT/PATCH


                    /api/v1/events/{id}

Update an event

DELETE


                    /api/v1/events/{id}

Delete an event

Query Parameters

Parameter	Description
`search`	Search term to filter results
`visible`	Filter by visibility (0 or 1)
`upcoming`	Only show upcoming events (1)
`sort`	Sort field (title, event_key, date_from, date_to, city)
`order`	Sort direction (ASC or DESC, default: DESC)
`include`	Include related data (opening_hours, participant_count)

Request Schema

Parameter	Type	Required	Description
`title`	string	Yes	Name of the event
`event_key`	string	No	Unique identifier for the event (auto-generated if omitted)
`description`	string	No	Event description
`date_from`	string	No	Start date (ISO 8601 format)
`date_to`	string	No	End date (ISO 8601 format)
`country`	string	No	Country code (default: DE)
`state`	string	No	State or region
`city`	string	No	City name
`application_deadline`	string	No	Application deadline (ISO 8601 format)
`is_visible`	boolean	No	Whether the event is publicly visible
`opening_hours`	array	No	Array of opening hour entries

Response Schema

Field	Type
`id`	integer
`event_key`	string
`title`	string
`description`	string\|null
`country`	string
`state`	string\|null
`city`	string\|null
`date_from`	string\|null
`date_to`	string\|null
`application_deadline`	string\|null
`is_visible`	boolean
`image`	object\|null

Code Examples

curl -X GET "https://your-tenant.plandocket.com/api/v1/events" \
  -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/events',
    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/events`, {
  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/events', headers=headers)
data = response.json()
print(data)

Sample Response

200 OK

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