Booths - API Reference - PlanDocket Documentation

Endpoints

GET


                    /api/v1/booths

List all booths

GET


                    /api/v1/booths/{id}

Retrieve a single booth

POST


                    /api/v1/booths

Create a new booth

PUT/PATCH


                    /api/v1/booths/{id}

Update a booth

DELETE


                    /api/v1/booths/{id}

Delete a booth

Query Parameters

Parameter	Description
`event_key`	Filter by event key
`plan_id`	Filter by floor plan ID
`status`	Filter by booth status (available, reserved, sold, blocked)

Request Schema

Parameter	Type	Required	Description
`plan_id`	integer	Yes	Floor plan ID (required)
`booth_type_id`	integer	No	Booth type ID
`booth_number`	string	No	Booth number (auto-generated if omitted)
`booth_name`	string	No	Display name for the booth
`description`	string	No	Booth description
`width`	float	No	Booth width in meters (default: 3.00)
`depth`	float	No	Booth depth in meters (default: 3.00)
`pos_x`	float	No	X position on the floor plan (default: 0.00)
`pos_y`	float	No	Y position on the floor plan (default: 0.00)
`rotation`	integer	No	Rotation angle in degrees (default: 0)
`formula_id`	integer	No	Pricing formula ID
`fixed_price`	float	No	Fixed price override
`tax_rate`	float	No	Tax rate percentage (default: system default)
`status`	string	No	Booth status (available, reserved, sold, blocked)
`blocked_reason`	string	No	Reason for blocking the booth
`notes`	string	No	Internal notes
`amenities`	string	No	Booth amenities description

Response Schema

Field	Type
`id`	integer
`plan_id`	integer
`plan_name`	string\|null
`event_id`	integer\|null
`event_title`	string\|null
`booth_type_id`	integer\|null
`booth_type_name`	string\|null
`booth_type_key`	string\|null
`booth_number`	string\|null
`booth_name`	string\|null
`description`	string\|null
`dimensions`	object
`position`	object
`formula_id`	integer\|null
`fixed_price`	float\|null
`tax_rate`	float
`status`	string
`blocked_reason`	string\|null
`color`	string\|null
`notes`	string\|null
`created_at`	string
`updated_at`	string

Code Examples

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

Sample Response

200 OK

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