v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-174421106.5 KB

Internal

Get autocomplete data for /playbook check

This is an internal endpoint used by the autocomplete system to retrieve the data needed to show the list of items that the user can check.

get/plugins/playbooks/api/v0/runs/checklist-autocomplete

Query parameters

channel_IDstring required

ID of the channel the user is in.

Response

List of autocomplete items for this channel.

itemstring required

A string containing a pair of integers separated by a space. The first integer is the index of the checklist; the second is the index of the item within the checklist.

hintstring required

The title of the corresponding item.

helptextstring required

Always the value "Check/uncheck this item".

Example response

[
  {
    "item": "1 2",
    "hint": "Gather information from customer.",
    "helptext": "Check/uncheck this item"
  }
]