Welcome to the Scrumy REST API documentation!
This documentation is currently not complete, but as of writing, all of the available methods are at least mentioned.
Feel free to update or expand on the documentation wherever you see fit.
The Scrumy API is RESTful. Anything within your project is a resource, be it a task, a sprint, or the project itself. Each resource can be accessed or modified using specially formed URLs and the HTTP verbs GET, POST, PUT, and DELETE. Descriptions of the actions you may perform on each resource can be found below.
All Scrumy resources can be returned in either XML or JSON formats. To specify the format you’d like to see, add either
.json to your URL. If nothing is specified, XML will be returned.
The API uses http basic authentication. Your login is your project name and your password is the password you use to log into your project. If you don’t have a password, we recommend that you set one, but if you insist, just leave the field blank.
or using curl:
curl -u yourproject:yourpassword https://scrumy.com/api/scrumies/yourproject
Under normal circumstances, you will see the following types of responses:
However, sometimes things don’t go according to plan. These are the error responses you may receive:
The Scrumy API is available with or without SSL. The only difference is using
https:// for a secure connection or
http:// to use it without a secure connection. For obvious reasons, we recommend using
Currently, changes made on the API will not be pushed to users connected to the live updating server, regardless of whether or not they are shown as being ‘online’. We will work on making this feature more available in the future.
The following are the different resources that can be accessed or modified using the API.
Notes: In any case where you would be updating or deleting a resource, parameters can be sent in the form
resource_name[attribute_name]=data. For example, if you are updating the title attribute of a story, you could send
story[title]=something or just
title=something. You cannot, however, mix and match during one request. If you send any updates in the form