REST API Checklists

Listing checklists

GET /issues/1/checklists.xml

Returns list of checklist items for issue #1.


<checklists total_count="7" type="array">
    <subject>Search for company activity for last year</subject>

Creating a checklist

POST /issues/1/checklists.[format]


  • checklist - A hash of the checklist attributes:
    • subject
    • is_done
    • position
    • issue_id


POST /checklists.xml
<?xml version="1.0"?>
  <subject>New checklist item</subject>
POST /checklists.json
  "checklist": {
    "issue_id": 1,
    "subject": "New checklist item",
    "is_done": 0

Creating issue with a checklist

POST /issues.json
  "issue": {
    "project_id": 1,
    "subject": "Example",
    "priority_id": 4,
    "checklists_attributes": [

Curl examples

Update checklist item

curl -v -H “Accept: application/json” -H "Content-Type: application/json" -X PUT http://localhost:3000/checklists/1 -u admin:admin -d "{\"checklist\": {\"subject\":\"Item_changed\"}}" 

Create checklist item

curl -v -H "Content-Type: application/xml" -X POST -d "<checklist><issue_id>1</issue_id><subject>New checklist item</subject><is_done>0</is_done></checklist>" -u admin:admin http://localhost:3000/issues/1/checklists.xml
Was this article helpful? Yes  No
230 from 264 found this helpful