Add Item

ROUTE: https://www.vivifyscrum.com/api/v1/task

METHOD: POST

HEADERS: Authorization = Bearer YOUR_API_KEY

REQUEST PAYLOAD:

• name: required, name of the task
• board: required, code of the board where the task will be added
• description: optional, task description
• sprint: optional, name of the sprint (if it is not provided, the task will go to the backlog)
• email: optional, email of the person that is adding the task
• points: optional, is used to set the number of points (choose between any number of points that you specified on the board). If not set the value is 0
• type: optional, is used to set the type of the item (Choose between: "Story" [default], "Improvement", "Bug", "Task", "Note", "Idea")
• value: optional, is used to set the value you want to add to the task (Choose between: 1 [default], 2, 5, 8, 10, 15, 20, 30, 40, 50)
• priority: optional, is used to set type of priority ("Normal" [default], "High")
• checklists: optional, is array of checklists you want to add on task [{ "title": "Checklist1"}, { "title": "Checklist2"}]
• labels: optional, array of label names that you want to add to the task (labels must first be added to the board)
• assignees: optional, array of user emails that you want to set as doers (assignees)
• reviewers: optional, array of user emails you want to set as reviewers
• parent_task: optional, hash code of the parent task

EXAMPLE:

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" --data-raw '{ "board": "VSVA", "name": "example name", "sprint": "Sprint 1", "points": 1, "labels": [{"name":"documentation" } ] "assignees": [ {"email": "[email protected]"} ], "reviewers": [ { "email":"[email protected]" } ]}' 'https://www.vivifyscrum.com/api/v1/task'

Edit Item

ROUTE: https://www.vivifyscrum.com/api/v1/task

METHOD: PUT

HEADERS: Authorization = Bearer YOUR_API_KEY

REQUEST PAYLOAD:

• task: required, hash code of task you want to edit
• name: optional, task name
• description: optional, task description
• points: optional, is used to set the number of points (choose between any number of points that you specified on the board)
• type: optional, is used to set the type of item (Choose between: "Story" [default], "Improvement", "Bug", "Task", "Note", "Idea")
• value: optional, is used to set value you want to add to your task (Choose between: 1 [default], 2, 5, 8, 10, 15, 20, 30, 40, 50)
• priority: optional, is used to set type of priority ("Normal" [default], "High")
• checklists: optional, is array of checklists you want to add on task, example:
  [{"First checklist title" : [ "item1", "item2"]}, {"Another checklist title": [ "item1", "item2"]}]
• labels: optional, array of labels you want to add to the task (labels must first be added to the board)
• assignees: optional, array of users ids that you want to set as doers (assignees)
• reviewers: optional, array of users ids you want to set as reviewers
• parent_task: optional, hash code of the parent task

EXAMPLE:

curl -X PUT -H "Authorization: Bearer YOUR_API_KEY" --data-raw'{"task": "TEAA-25", "name": "example name", "points": 5, "value": 5, "priority":"High"}'
'https://www.vivifyscrum.com/api/v1/task'

Get Item

ROUTE: https://www.vivifyscrum.com/api/v1/task/taskCode | taskId

METHOD: GET

HEADERS: Authorization = Bearer YOUR_API_KEY

REQUEST PAYLOAD: 

EXAMPLE:

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" 'https://www.vivifyscrum.com/api/v1/task/TEAA-25'

Delete Item

ROUTE: https://www.vivifyscrum.com/api/v1/task

METHOD: DELETE

HEADERS: Authorization = Bearer YOUR_API_KEY

REQUEST PAYLOAD: 

• task: required, hash code (item code) of the task you want to delete

PERMISSION: Board write actions

EXAMPLE:

curl -X DELETE -H "Authorization: Bearer YOUR_API_KEY" --data-raw '{"task": "TEAA-25"}' 'https://www.vivifyscrum.com/api/v1/task'