EXTRAS

API

VivifyScrum API lets you manage your Board Items, using external third party applications.

Right now, you can perform the following actions:

  • Add Item
  • Edit Item
  • Delete Item
  • Export Board
  • Export Sprint
  • Get All Sprints
  • Get Sprint Items

 

To be able to use VivifyScrum API, you'll need a unique Board API Key. One can be found on your ‘Configure Board’ page, on the Integrations tab. Simply copy the key already generated there and use it with all your API requests. API key can be sent as part of Authorization Header or as an additional GET parameter, it's up to you.

Add Item

To be able to add new Items via API, you need to create a POST request to the following route:

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

Required fields when creating an Item include:

  • Email - email address that uniquely identifies the user who will be used as the creator of the Item
  • Name - this will be the name of the created Item
  • Board - this is a Board code that will determine to which Board newly created Item should be added

 

Other fields that can be sent in the POST body:

  • Description - this is the Item description
  • Points - number of Item points
  • Priority - Item priority (available values are: Normal and Critical)
  • Value - Item value (available values are: 1, 2, 5, 8, 10, 15, 20, 30, 40, 50)
  • Type - Item type (available values are: Story, Improvement, Bug, Task, Note )
  • Assignee - decide who will be assigned to this Item. It should be the email address of a user who is already a Team Member (already assigned to mentioned board)
  • Parent_task - specify the code of the Item that will be used as the parent Item for the newly created one
  • Reviewers[] - array of users' emails who will be assigned to the Item as reviewers (emails of users who will be…)
  • Sprint - name of the Sprint in which Item will be added. In case of a Kanban board, this is an actual column
  • Sprint_Backlog_column - name of the Sprint Backlog column in which you want to store a new Item
  • labels[] - array of label names that will be added to the Item
  • checklists[] - array of checklists that will be added to the Item. You should specify checklists as a two-dimensional array, where the key of the first dimension array will be the name of a checklist. Value for the second dimension array will be a single checklist item. e.g. checklists[Test][]=This is a test will create a checklist named Test, with one checklist item ‘This is a test’

 

Edit Item

To be able to edit an existing Item, you need to create a PUT request to the following route:

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

Required field when editing an Item is:

  • task - code of an Item that you want to edit


Available fields are the same as the ones used for creating an Item.

 

Delete Item

In case you want to delete an existing Item, you should create a DELETE request to the following route:

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

When deleting an Item, you should specify:

  • Task - this should be the code of the item you want to delete
  • Delete_subtasks - will specify whether subtasks (if there are any) should be deleted or not. Available values are true and false.

 

Export Board

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" 'https://www.vivifyscrum.com/api/v1/board-export'

 

Export Sprint

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" 'https://www.vivifyscrum.com/api/v1/sprints/{sprintId}/export’

 

Get All Sprint 

You can only ask for Sprints with current status.

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" 'https://www.vivifyscrum.com/api/v1/sprints?[status=(active|finished|not_active|closed)]’

 

Get Sprint Items

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" https://www.vivifyscrum.com/api/v1/sprints/{sprintId}/tasks’

 

Here are the examples for every of the above actions:

Add item

curl -H "Authorization: Bearer YOUR_API_KEY" --data '[email protected]&name=APITask&board=S&description=This task is created using VS API&points=1&priority=Low&value=1&type=Task&[email protected]&parent_task=S-1&reviewers[][email protected]&reviewers[][email protected]&sprint=Sprint 1&sprint_backlog_column=To do&labels[]=Test&checklists[Checklist one][]=This is first item&checklists[Checklist one][]=This is second item&checklists[Checklist two][]=This is first item in second checklist' 'https://www.vivifyscrum.com/api/v1/task'

Edit item

curl -X PUT -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvbG9jYWxob3N0IiwiYXVkIjoiaHR0cHM6XC9cL2xvY2FsaG9zdCIsImJvYXJkX2lkIjo2fQ.YQnjBmBuRom9AHO355kSOHg0-tcyN19coduFHwpb5O8" --data 'task=S-2&name=Edit APITask' 'https://www.vivifyscrum.com/api/v1/task'

Delete item

curl -X DELETE -H "Authorization: Bearer YOUR_API_KEY" --data 'task=S-2&delete_subtasks=true' 'https://www.vivifyscrum.com/api/v1/task'