ORora
project

Get sprints

get/projects/{project_id}/sprints

Request

  • Base URL
    https://api.ora.pm
  • Auth
    OAuth 2
    Authorization code: https://app.ora.pm/authorize
    Token URL: https://api.ora.pm/oauth/token scopes: read, write

Query parameters

offsetstring

Number of items already displayed

limitstring

Number of items per page

Response

Success

titlestring

Title of the sprint.

created_atstring date-time

Date and time when the sprint was created.

updated_atstring date-time

Date and time when the sprint was last updated.

start_datestring date-time

Date and time when the sprint starts.

end_datestring date-time

Date and time when the sprint ends.

durationinteger

Duration of the sprint in days.

done_listinteger

Counter for completed tasks in the done list.

statestring

State of the sprint.

numberinteger

Autogenerated. Can not be changed. Number of the sprint.

archivedboolean

False if the project is archived, if false it is not.

tasksinteger

Counter for the tasks in sprint.

tasks_completedinteger

Counter for completed tasks in sprint.

pointsinteger

Effort estimate in points. Every task has Story points. They are combined.

points_completedinteger

Completed Story points in the sprint.

valueinteger

Business value estimate of the sprint. Every task has business value points. They are combined.

value_completedinteger

Completed Business value points in the sprint.

Example response

{
  "title": "Cool sprint title",
  "created_at": "2019-07-31T12:42:49.096305Z",
  "updated_at": "2019-08-01T10:33:12.070602Z",
  "start_date": "2019-07-31T13:00:00.000000Z",
  "end_date": "2019-08-03T13:00:00.000000Z",
  "duration": 4,
  "done_list": 423,
  "state": "unactive",
  "tasks": 450,
  "tasks_completed": 423,
  "points": 567,
  "points_completed": 546,
  "value": 451,
  "value_completed": 234
}

Changes

No recorded changes to this operation across all 1 revision of this API.