Categories - API Reference - PlanDocket Documentation

Endpoints

GET


                    /api/v1/categories

List all categories

GET


                    /api/v1/categories/{id}

Retrieve a single category

POST


                    /api/v1/categories

Create a new category

PUT/PATCH


                    /api/v1/categories/{id}

Update a category

DELETE


                    /api/v1/categories/{id}

Delete a category

Query Parameters

Parameter	Description
`hierarchical`	Return as hierarchical tree (1)

Request Schema

Parameter	Type	Required	Description
`title`	string	Yes	Category name (required)
`category_key`	string	No	Unique key (auto-generated if omitted)
`parent_category_id`	integer	No	Parent category ID for nesting
`content`	string	No	Category description or content
`event_keys`	array	No	Array of event keys to associate
`is_visible`	boolean	No	Whether the category is visible (default: true)
`applicant_visibility`	string	No	Visibility for applicants (selectable, container, admin_only)
`account_access_enabled`	boolean	No	Whether the category is available in the account portal (default: true)
`sort_order`	integer	No	Display order (default: 0)

Response Schema

Field	Type
`id`	integer
`category_key`	string\|null
`title`	string
`content`	string\|null
`parent_category_id`	integer
`event_keys`	array\|null
`is_visible`	boolean
`applicant_visibility`	string
`account_access_enabled`	boolean
`sort_order`	integer
`level`	integer\|null
`created_at`	string
`updated_at`	string

Code Examples

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

Sample Response

200 OK

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