PlanDocket

Service Orders

Business+

View orders for additional services.

Read Only This endpoint only supports GET requests.
Required scopes: service_orders
Feature flag: service_orders

Endpoints

GET /api/v1/service-orders

List all orders

GET /api/v1/service-orders/{id}

Retrieve a single order

Query Parameters

Parameter Description
event_key Filter by event key
status Filter by order status
participant_id Filter by participant ID
order_number Filter by order number
sort Sort field (order_number, total, status, submitted_at, created_at)
order Sort direction (ASC or DESC, default: DESC)
include Include related data (items, participant)

Response Schema

Field Type
id integer
order_number string|null
event_participant_id integer|null
status string
subtotal float
tax_total float
total float
currency string
notes string|null
submitted_at string|null
confirmed_at string|null
cancelled_at string|null
cancellation_reason string|null
created_at string
updated_at string

Code Examples

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

Sample Response

200 OK
{
  "data": {
    "service-order_id": 1,
    "created_at": 1704067200,
    "updated_at": 1704067200
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Esc to close