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

Items API

Add Item

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

   METHOD: POST

   HEADERS: Authorization = Bearer YOUR_API_KEY

   REQUEST PAYLOAD:

       -board_id: required, id of board

       -item.name: required, name of task

       -item.bard_id: required, id of board where we want to set our task

       -item.sprint_id: required, id of sprint

       -item.points_id: optional, is used to set number of points

       -item.priority_id: optional, is used to set type of priority(1 = low, 2 = normal, 3 = high, 4 = urgent, 5 = critical)

       -item.type_id: optional, is used to set the type of item(1 = story, 2 = improvement, 3 = bug, 4 = task, 5 = note, 6 = idea)

       -item.taskvalue_id: optional, is used to set the value you want to add to your task

       -item.checklists: optional, is array of checklists you want to add on task [{ title: "Checklist1"}, { title: "Checklist2"}]

       -item.labels: optional, array of labels ids you want to add on task [{ "id": 1 }, { "id": 2 }]

       -item.doers: optional, array of users ids that you want to set as doers(assignees)

       -item.reviewers: optional, array of users ids you want to set as reviewers

   PERMISSION: Board write actions

   EXAMPLE:

       curl -X POST -H "Authorization: Bearer YOUR_API_KEY" --data '{ "board_id": 1, item: { "name": "example name", "board_id": 1, "sprint_id": 1, "points_id":  1, "doers": [ {"id": 1} ], "reviewers": [ { "id": 1 } ]}' 'http://www.vivifyscrum.com/api/v2/tasks'

 

Edit Item

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

    METHOD: PUT

    HEADERS: Authorization = Bearer YOUR_API_KEY

    taskId: required, id of task you want to edit

    REQUEST PAYLOAD:

        -name: required, name of task you want to set or if u dont want to change use old name

        -type_id: optional, is used to set the type of item(1 = story, 2 = improvement, 3 = bug, 4 = task, 5 = note, 6 = idea)

        -taskvalue_id: optional, is used to set value you want to add to your task

        -points_id: optional, is used to set number of points 

        -priority_id: optional, is used to set type of priority(1 = low, 2 = normal, 3 = high, 4 = urgent, 5 = critical)

    PERMISSION: Board write action

    EXAMPLE:

        curl -X PUT -H "Authorization: Bearer YOUR_API_KEY" --data"name=Task name&type_id=2&taskvalue_id=1&points_id=1&priority_id=2" 

        https://www.vivifyscrum.com/api/v2/tasks/1



Delete Item

   ROUTE: http://www.vivifyscrum.com/api/v2/tasks/taskId

   METHOD: DELETE

   HEADERS: Authorization = Bearer YOUR_API_KEY

   taskId: required, Id of task you want to delete

   PERMISSION: Board write actions

   EXAMPLE:

       curl -X DELETE -H "Authorization: Bearer YOUR_API_KEY" 'http://www.vivifyscrum.com/api/v2/tasks/12'