Message sent!

Someone from our support team will contact you shortly.

Get a Quote

Your email *

Tell us why you're considering making a switch:

Schedule a demo

Your name *

Your email *

Number of team members *

Industry

Tell us why you're considering making a switch:

API

Checklists API

ADD CHECKLIST

    ROUTE: https://www.vivifyscrum.com/api/v2/tasks/taskId/checklists

    METHOD: POST

    HEADERS: Authorization = Bearer YOUR_API_KEY

    taskId: required, id of task you want to add a checklist to

    REQUEST PAYLOAD:

        -title; required, name of the checklist you want to add

    PERMISSION: Board write actions

    EXAMPLE:

        curl -X POST -H "Authorization: Bearer YOUR_API_KEY" --data "title=ChecklistTitle" 'https://www.vivifyscrum.com/api/v2/tasks/1/checklists'

 

UPDATE CHECKLIST

    ROUTE: https://www.vivifyscrum.com/api/v2/tasks/taskId/checklists/checklistId

    METHOD: PUT

    HEADERS: Authorization = Bearer YOUR_API_KEY

    taskId: required, id of the task you want to update the checklist to

    checklistId: required, id of the checklist you want to update

    REQUEST PAYLOAD:

        -task_id: required, id of task where the checklist is

        -title: required, title of the checklist you want to set

    PERMISSION: Board write actions

    EXAMPLE:

        curl -X PUT -H "Authorization: Bearer YOUR_API_KEY" --data 'task_id=1&title=Example title' https://www.vivifyscrum.com/api/v2/tasks/1/checklists/1

 

DELETE CHECKLIST

    ROUTE: https://www.vivifyscrum.com/api/v2/tasks/taskId/checklists/checklistId

    METHOD: DELETE

    HEADERS: Authorization = Bearer YOUR_API_KEY

    taskId: required, id of task you want to delete the checklist from

    checklistId: required, id of the checklist you want to delete

    PERMISSION: Board write actions

    EXAMPLE:

        curl -X DELETE -H "Authorization: Bearer YOUR_API_KEY" 'https://www.vivifyscrum.com/api/v2/tasks/1/checklists/1'

 

ADD CHECKLIST ITEM

    ROUTE: https://www.vivifyscrum.com/api/v2/checklists/checklistId/items

    METHOD: POST

    HEADERS: Authorization = Bearer YOUR_API_KEY

    checklistId: required, id of checklist you want to add an item to

    REQUEST PAYLOAD

        -checklistItems: required, list of checklistItems you want to add to the checklist.

                        it contains js objects with fields

                        -description: required, description of checklistItem

                        -is_done: optional(true/false), flag which indicates if checklist item is done or not. Default setting is false (checklist item not done)

    PERMISSION: Board write actions

    EXAMPLE:

        curl -X POST -H "Authroziaton: Bearer YOUR_API_KEY" --data '{"checklistItems":[{"description":"Checklist","is_done":"true"}]}' 'https://www.vivifyscrum.com/api/v2/tasks/1/checklists'

 

UPDATE CHECKLIST ITEM

    ROUTE: https://www.vivifyscrum.com/api/v2/checklists/checklistId/items/itemId

    METHOD: PUT

    HEADERS: Authorization = Bearer YOUR_API_KEY

    checklistId: required, id of the checklist you want to update

    itemId: required, id of the item you want to update

    REQUEST PAYLOAD:

        -description: required, description of the item you want to set

        -is_done: required boolean(true/false), mark if item is done or not

    PERMISSION: Board write actions

    EXAMPLE:

        curl -X PUT -H "Authorization: Bearer YOUR_API_KEY" --data 'description=Example description&is_done=true' 'https://www.vivifyscrum.com/api/v2/checklists/1/items/1'

 

DELETE CHECKLIST ITEM

    ROUTE: https://www.vivifyscrum.com/api/v2/checklists/checklistId/items/itemId

    METHOD: DELETE

    HEADERS: Authorization = Bearer YOUR_API_KEY

    checklistId required, id of checklist you want to delete the checklist item from

    itemId: required, id of checklist item you want to delete from the checklist

    PERMISSION: Board write actions

    EXAMPLE:

        curl -X DELETE -H "Authorization: Bearer YOUR_API_KEY"  'https://www.vivifyscrum.com/api/v2/checklists/1/items/1'