PlanDocket
Deutsch English

Notes

Business+

Manage internal notes.

Required scopes: contacts applications participants invoices events
Access level: GET {scope}:read POST / PUT / PATCH / DELETE {scope}:write About access levels
The required scope depends on the entity type: contact notes require the "contacts" scope, application notes require "applications", etc. Notes on other entity types (e.g. booths or tasks) are not accessible through the API (404). A key acts for the admin who created it: it can change or delete only notes written by that admin, unless that admin is a super admin (403 otherwise). Reading and pinning work for every note; "can_modify" tells whether the key may change a note.

Endpoints

GET /api/v1/notes

List all notes

GET /api/v1/notes/{id}

Retrieve a single note

POST /api/v1/notes

Create a new note

PUT/PATCH /api/v1/notes/{id}

Update a note

DELETE /api/v1/notes/{id}

Delete a note

POST /api/v1/notes/{id}/pin

Toggle pin status of a note

Query Parameters

Parameter Description
entity_type Entity type (required: contact, application, event_participant, invoice, event)
entity_id Entity ID (required)
note_type Filter by note type (info, warning, followup, internal)
is_pinned Filter by pinned status (1)
page Page number (default: 1)
per_page Results per page (default: 25, max. 100)

Request Schema

Parameter Type Required Description
entity_type string Yes Entity type (required: contact, application, event_participant, invoice, event)
entity_id integer Yes Entity ID (required)
note_text string Yes Note content (required)
note_type string No Note type (info, warning, followup, internal; default: info)
is_pinned boolean No Whether the note is pinned

Response Schema

Field Type
id integer
entity_type string
entity_id integer
admin_id integer
admin_name string|null
note_text string
note_type string
is_pinned boolean
created_at string
updated_at string

Code Examples

curl -X GET "https://your-tenant.plandocket.com/api/v1/notes?entity_type=contact&entity_id=123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: 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/notes?entity_type=contact&entity_id=123',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);
const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://your-tenant.plandocket.com';

const response = await fetch(`${baseUrl}/api/v1/notes?entity_type=contact&entity_id=123`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

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}',
}

response = requests.get(f'{base_url}/api/v1/notes?entity_type=contact&entity_id=123', headers=headers)
data = response.json()
print(data)

Sample Response

200 OK 
{
    "data": [
        {
            "id": 1,
            "entity_type": "string",
            "entity_id": 1,
            "admin_id": 1,
            "admin_name": "string",
            "note_text": "string",
            "note_type": "string",
            "is_pinned": true,
            "created_at": "2026-01-15T10:00:00+01:00",
            "updated_at": "2026-01-15T10:00:00+01:00"
        }
    ],
    "meta": {
        "current_page": 1,
        "per_page": 25,
        "total": 1,
        "total_pages": 1,
        "entity_type": "contact",
        "entity_id": 123
    }
}
Newsletter Schedules
API Version v1.0