Checkliste
Zammad hat verschiedene Endpunkte für Checklisten:
INFO
Checklisten-Vorlagen enthalten ihre Elemente, während die Standard-Checkliste einen eigenen Endpunkt für Elemente hat.
Checklisten
INFO
Um der Checkliste Elemente hinzuzufügen, verwenden Sie den Endpunkt Checklisten-Elemente.
Anzeigen
Erforderliche Berechtigung: ticket.agent
GET-Anfrage gesendet: /api/v1/checklists/{checklisten id}
Details
// HTTP-Code 200 OK
{
"name": "Return order",
"sorted_item_ids": [
"18",
"19",
"20",
"21"
],
"updated_by_id": 3,
"created_by_id": 3,
"ticket_id": 4,
"id": 6,
"created_at": "2024-10-15T08:47:50.860Z",
"updated_at": "2024-10-15T08:50:52.698Z",
"item_ids": [
18,
19,
20,
21
]
}TIP
Sie können das Attribut checklist_id eines Tickets finden, indem Sie eine GET-Anfrage an /api/v1/tickets/{ticket id} senden.
Erstellen
Erforderliche Berechtigung: ticket.agent
POST-Anfrage gesendet: /api/v1/checklists
Details
{
"ticket_id": 7,
"template_id": 1
}Aktualisierung
Erforderliche Berechtigung: ticket.agent
PATCH-Anfrage gesendet: /api/v1/checklists/{checklisten id}
Details
{
"name": "New checklist name",
"sorted_item_ids": [
"34",
"33",
"32"
]
}Löschen
Erforderliche Berechtigung: ticket.agent
DELETE-Anfrage gesendet: /api/v1/checklists/{checklisten id}
Details
// HTTP-Code 200 OKChecklisten-Elemente
Anzeigen
Erforderliche Berechtigung: ticket.agent
GET-Anfrage gesendet: /api/v1/checklist_items/{checklist item id}
Details
// HTTP-Code 200 OK
{
"text": "Hand over the goods to the shipping company",
"checked": false,
"updated_by_id": 3,
"ticket_id": null,
"created_by_id": 3,
"checklist_id": 6,
"id": 20,
"created_at": "2024-10-15T08:48:14.216Z",
"updated_at": "2024-10-15T08:49:10.467Z"
}Erstellen
Erforderliche Berechtigung: ticket.agent
POST-Anfrage gesendet: /api/v1/checklist_items
Details
{
"text": "New Item via API!",
"checklist_id": 12,
"checked": false
}Aktualisierung
Erforderliche Berechtigung: ticket.agent
PATCH-Anfrage gesendet: /api/v1/checklist_items/{checklist item id}
Details
{
"text": "Changed checklist item",
"checked": true
}Löschen
Erforderliche Berechtigung: ticket.agent
DELETE-Anfrage gesendet: /api/v1/checklist_items/{checklist item id}
Details
// HTTP-Code 200 OKChecklisten-Vorlagen
Auflisten
Erforderliche Berechtigung: admin.checklists
GET-Request gesendet: /api/v1/checklist_templates
Details
{
"id": 3,
"name": "My checklist template",
"active": true,
"sorted_item_ids": [
"7",
"8",
"9"
],
"created_by_id": 3,
"updated_by_id": 3,
"created_at": "2026-04-07T12:43:21.347Z",
"updated_at": "2026-04-07T12:43:21.378Z",
"item_ids": [
7,
8,
9
]
},
{
"id": 4,
"name": "Onboarding",
"active": true,
"sorted_item_ids": [
"10",
"11",
"12",
"13"
],
"created_by_id": 3,
"updated_by_id": 3,
"created_at": "2026-04-07T12:45:11.249Z",
"updated_at": "2026-04-07T12:45:11.269Z",
"item_ids": [
10,
11,
12,
13
]
}Anzeigen
Erforderliche Berechtigung: admin.checklists oder ticket.agent
GET-Anfrage gesendet: /api/v1/checklist_templates/{checklist template id}
Details
// HTTP-Code 200 OK
{
"name": "Return order",
"active": true,
"updated_by_id": 3,
"created_by_id": 3,
"id": 28,
"sorted_item_ids": [
"18",
"19",
"20",
"21"
],
"created_at": "2024-10-15T12:43:14.642Z",
"updated_at": "2024-10-15T12:43:34.242Z",
"item_ids": [
18,
19,
20,
21
]
}Erstellen
Erforderliche Berechtigung: admin.checklists
POST-Anfrage gesendet: /api/v1/checklist_templates
Details
{
"name": "My checklist template",
"active": true,
"items": [
"Item 1",
"Item 2",
"Item 3"
]
}Aktualisierung
Erforderliche Berechtigung: admin.checklists
PATCH-Anfrage gesendet: /api/v1/checklist_templates/{checklist template id}
Details
// HTTP-Code 200 OK
{
"name": "My changed checklist template name",
"active": true,
"items": [
"Item 7",
"Item 8",
"Item 9"
]
}Löschen
Erforderliche Berechtigung: admin.checklists
DELETE-Anfrage gesendet: /api/v1/checklist_templates/{checklist template id}
Details
// HTTP-Code 200 OK