Zammad Hub

English

Deutsch
српски

English

Deutsch
српски

Appearance

Checklist ​

Zammad has different checklist endpoints:

INFO

Checklist templates include their items whereas the standard checklist has a separate item endpoint.

Checklists ​

INFO

To add checklist items, use the checklist items endpoint.

Show ​

Required permission: ticket.agent

GET-Request sent: /api/v1/checklists/{checklist id}

Show response
json
// 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
  ]
}

Show By Ticket ​

Required permission: ticket.agent

GET-Request sent: /api/v1/checklists/by_ticket/{ticket id}

Show response
json
// HTTP-Code 200 OK

{
  "id": 6,
  "assets": {
    "Checklist": {
      "6": {
        "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
        ]
      }
    },
    "ChecklistItem": {
      "18": {
        "text": "Prepare shipment",
        "checked": false,
        "updated_by_id": 3,
        "ticket_id": null,
        "created_by_id": 3,
        "checklist_id": 6,
        "id": 18,
        "created_at": "2024-10-15T08:47:51.036Z",
        "updated_at": "2024-10-15T08:47:59.717Z"
      },
      "19": {
        "text": "Inform customer",
        "checked": false,
        "updated_by_id": 3,
        "ticket_id": null,
        "created_by_id": 3,
        "checklist_id": 6,
        "id": 19,
        "created_at": "2024-10-15T08:48:02.042Z",
        "updated_at": "2024-10-15T08:48:12.726Z"
      },
      "20": {
        "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"
      },
      "21": {
        "text": "Check whether return has arrived",
        "checked": false,
        "updated_by_id": 3,
        "ticket_id": null,
        "created_by_id": 3,
        "checklist_id": 6,
        "id": 21,
        "created_at": "2024-10-15T08:49:12.388Z",
        "updated_at": "2024-10-15T08:49:40.746Z"
      }
    }
  }
}

Create ​

Required permission: ticket.agent

POST-Request sent: /api/v1/checklists

Show request/response
json
{
  "ticket_id": 7,
  "template_id": 1
}

Update ​

Required permission: ticket.agent

PATCH-Request sent: /api/v1/checklists/{checklist id}

Show request/response
json
{
  "name": "New checklist name",
  "sorted_item_ids": [
    "34",
    "33",
    "32"
  ]
}

Delete ​

Required permission: ticket.agent

DELETE-Request sent: /api/v1/checklists/{checklist id}

Show response
json
// HTTP-Code 200 OK

Checklist Items ​

Show ​

Required permission: ticket.agent

GET-Request sent: /api/v1/checklist_items/{checklist item id}

Show response
json
// 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"
}

Create ​

Required permission: ticket.agent

POST-Request sent: /api/v1/checklist_items

Show request/response
json
{
  "text": "New Item via API!",
  "checklist_id": 12,
  "checked": false
}

Update ​

Required permission: ticket.agent

PATCH-Request sent: /api/v1/checklist_items/{checklist item id}

Show request/response
json
{
  "text": "Changed checklist item",
  "checked": true
}

Delete ​

Required permission: ticket.agent

DELETE-Request sent: /api/v1/checklist_items/{checklist item id}

Show response
json
// HTTP-Code 200 OK

Checklist Templates ​

Show ​

Required permission: admin.checklists or ticket.agent

GET-Request sent: /api/v1/checklist_templates/{checklist template id}

Show response
json
{
  "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
  ]
}

Create ​

Required permission: admin.checklists

POST-Request sent: /api/v1/checklist_templates

Show request/response
json
{
  "name": "My checklist template",
  "active": true,
  "items": [
    "Item 1",
    "Item 2",
    "Item 3"
  ]
}

Update ​

Required permission: admin.checklists

PATCH-Request sent: /api/v1/checklist_templates/{checklist template id}

Show request/response
json
{
  "name": "My changed checklist template name",
  "active": true,
  "items": [
    "Item 7",
    "Item 8",
    "Item 9"
  ]
}

Delete ​

Required permission: admin.checklists

DELETE-Request sent: /api/v1/checklist_templates/{checklist template id}

Show response
json
// HTTP-Code 200 OK