Ticket planning API
This article and the rest of the API documentation in this section are written for a technical audience — integrators and developers connecting external systems to Tickiti. Familiarity with HTTP, REST, JSON and bearer-token authentication is assumed.
The ticket planning endpoints work with what staff use to plan the work on a ticket: its checklist, its reminders, and the start and due dates tasks carry. The reusable checklists themselves, from Workflow → Checklists, are managed through the Workflow configuration API.
Every change is made by the same code as the ticket page, so a checklist change updates the progress shown in ticket lists and on any open copy of the ticket at once. All endpoints are POST, take and return JSON, and use the response envelope described in the API overview. None takes an Idempotency-Key.
Endpoints
| Method & path | Ability | Purpose |
|---|---|---|
| POST /api/v1/tickets/checklist | tickets:read | Read a ticket’s checklist |
| POST /api/v1/tickets/checklist/add | tickets:write | Add an item, several items, or a checklist template |
| POST /api/v1/tickets/checklist/update | tickets:write | Tick, untick or reword an item |
| POST /api/v1/tickets/checklist/reorder | tickets:write | Put the items in a new order |
| POST /api/v1/tickets/checklist/delete | tickets:write | Delete an item, or clear the checklist |
| POST /api/v1/tickets/reminders | tickets:read | List a ticket’s reminders |
| POST /api/v1/tickets/reminders/add | tickets:write | Add a one-off or repeating reminder |
| POST /api/v1/tickets/reminders/delete | tickets:write | Delete a reminder |
Write implies read: a token holding tickets:write can call every endpoint above.
Who may do what
A call runs as the token’s owner, who must be able to see the ticket — its assignee (in person or as a member of the assigned team), a participant, or someone with access to its queue — exactly as on the ticket page. Integration identities (the System user, API user accounts, and on a self-hosted installation sysadmins and superusers) work on tickets in every queue. Every endpoint works on a task as on a ticket, and identifies it by ticket_number or ticket_id; give one.
Checklists
Reading. tickets/checklist returns the items in order, each with its id, text, is_done, and who ticked it and when (done_by_name, done_at); the checklist’s progress (done and total, or null when it has no items); and the templates that can be added to it.
{
"ok": true,
"data": {
"ticket_number": "528641",
"checklist": [
{ "id": 311, "text": "Confirm the order number", "is_done": true, "done_by_name": "Priya Sharma", "done_at": "2026-11-12T09:41:07+00:00" },
{ "id": 312, "text": "Book the courier collection", "is_done": false, "done_by_name": null, "done_at": null },
{ "id": 313, "text": "Email the returns label", "is_done": false, "done_by_name": null, "done_at": null }
],
"progress": { "done": 1, "total": 3 },
"templates": [ { "id": 4, "name": "Faulty shoe return" } ]
}
} Adding. checklist/add takes exactly one of:
text— one item, up to 500 characters;items— several items, added in the order given;template_id— a checklist template’s items. Items the checklist already has, word for word, are not added twice.
A checklist holds up to 100 items. Adding to a full checklist is refused (422 refused); a list of items that would go past the limit is cut at it. The reply is the checklist, as tickets/checklist returns it, with added, the number of items added.
Ticking and editing. checklist/update takes item_id with text, is_done or both. Ticking an item records the token’s owner and the time against it; unticking clears them.
{ "ticket_number": "528641", "item_id": 312, "is_done": true } Reordering. checklist/reorder takes ids, the items’ ids in their new order: every item on the ticket’s checklist, each once, and nothing else (a checklist holds up to 100 items). A list that leaves an item out, repeats one or names another ticket’s is refused with 422 validation_failed, naming them.
Deleting. checklist/delete takes item_id to delete one item, or all: true to clear the checklist. The reply includes deleted, the number of items removed.
An item_id that is not on the ticket’s checklist gives 404.
Reminders
A reminder belongs to the person who set it — through the API, the token’s owner. When it comes round it is posted on the ticket for the assignee (every member of an assigned team), or for its owner when the ticket is unassigned. See Reminders for how staff see them.
Listing. tickets/reminders returns the ticket’s reminders, soonest first. Each has its id, next_at, a readable repeat description with repeat_every, repeat_unit and repeat_until, its timezone and note, who set it (set_by, set_by_email), whether it is the token owner’s (mine), whether they may delete it (can_delete), and when it last fired.
Adding. reminders/add takes:
next_at— required; an ISO 8601 date and time. Without an offset it is read intimezone.note— optional, up to 255 characters.repeat_every(1–365) andrepeat_unit(day,weekormonth) — both or neither. A repeating reminder keeps its local time of day.repeat_until— optional last date,YYYY-MM-DD.timezone— an IANA name such asEurope/London; defaults to the workspace time zone.
curl -X POST https://support.sole-provider.example/api/v1/tickets/reminders/add \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ticket_number": "528641",
"next_at": "2026-11-20T09:00:00",
"timezone": "Europe/London",
"note": "Check the courier has collected the return"
}' The reply carries the new reminder_id and the ticket’s reminders. A reminder on a closed ticket, a one-off in the past and a series that has already ended are refused (422 refused); a series whose start has passed begins at its next occurrence.
Deleting. reminders/delete takes reminder_id. Its owner may delete it, and so may an administrator of at least the owner’s rank (admin, then sysadmin, then superuser): an admin cannot delete a sysadmin’s reminder. Anyone else gets 403; a reminder that is not on the ticket gives 404.
Start and due dates
A ticket’s start_date and due_date are set with tickets/update-many (YYYY-MM-DD, or none to clear), which applies the same rule as the ticket page: Manage on the ticket’s queue, or the ticket assigned to the owner in person. See Bulk ticket update API; it takes a single ticket as readily as a hundred.
tickets/show returns both dates (YYYY-MM-DD or null) and checklist, the checklist’s progress ({ "done": 1, "total": 3 }, or null). See Show ticket API.