ScrumDesk API Endpoints

How to consume ScrumDesk API

ScrumDesk API is built with the support of HAL – the hypertext application language. It is a simple format that gives a consistent and easy way to hyperlink between resources in our API.  It can be easily consumed using open source libraries available for most major programming languages. It’s also simple enough that you can just deal with it as you would any other JSON.

ScrumDesk API is the set of resources represented by URLs. Every URL doesn’t just return data, but it includes also:

• permissions for the logged user and particular resource (see options: on the picture above),
• list of additional links and resources available for the resource (related collections, subtasks, relations, comments, etc.

For request use  application/json (Content-Type, Accept). 

Projects accessible for the logged user, the response for https://api.scrumdesk.com/users/XX/projects API request

Authorization (POST)

Authorization token must be included in every API call must either in the header or in the URL link itself.

In HEADER:

https://api.scrumdesk.com/auth

Authorization, Token token=token_value

In URL:

https://api.scrumdesk.com/auth?access_token=token_value

Authorization for custom integrations

It is possible to use project-level authorization if you want to create your own integration and would like to access and manage project data without the necessity to authorize project users. Please contact support@scrumdesk.com in this case and request an access token for your integration.

Login via email and password

https://api.scrumdesk.com/auth

{ “username”: “”,  “password”: “” }

Output:

• access_token
• links
  • link to user

Data model structure simplified

Account

• Invitation
• Organization members
• User

Projects

• Project membership
• Project detail
• Workflow + workflow steps

OKR Desk

• Okr diagrams
• Okr nodes
• Key results

Product Desk

• Roadmaps
  • Roadmap diagram
  • Roadmap group
  • Roadmap row
  • Roadmap lane
  • Roadmap box
  • Milestones

Scrum board

• Release
• Sprint
• Themes
• Epics
• Backlog item types
• Task types
• Custom fields
• Colors
• Backlog Items

• Tasks
  • Worklogs
  • Board items that represent visual aspects of cards

Retro Desk

• Retro idea
• Retro idea category
• Retro idea vote

RCA Desk

• RCA node
• RCA link
• Retro technique

Common

• Constants
• Comments related to either tasks or backlog items
• History
• Attachments
• Notifications
• Relations

Backlog Items

Project details contain the list of backlog items referenced in the links section. The user must be either a product owner or Scrum Master role in the project.

API Endpoints Reference