Home
API Reference
Schedules

Schedules

Business+

Retrieve event schedules.

Read Only This endpoint only supports GET requests.

Required scopes: schedules

Feature flag: schedules

Endpoints

GET


                    /api/v1/schedules

List all schedule entries

GET


                    /api/v1/schedules/{id}

Retrieve a single entry

Query Parameters

Parameter	Description
`event_key`	Filter by event key (required)
`date`	Filter by specific date (ISO 8601)
`from_date`	Filter entries from this date (ISO 8601)
`to_date`	Filter entries until this date (ISO 8601)
`location`	Filter by location name
`slot_type`	Filter by slot type
`is_public`	Filter by public visibility (0 or 1)
`include`	Include related data (assignments)

Response Schema

Field	Type
`id`	integer
`event_id`	integer
`event_title`	string\|null
`slot_date`	string\|null
`start_time`	string\|null
`end_time`	string\|null
`location`	string\|null
`title`	string\|null
`description`	string\|null
`slot_type`	string
`is_public`	boolean
`sort_order`	integer
`created_at`	string
`updated_at`	string

Code Examples

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

Sample Response

200 OK

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

Notes Webhooks