OpenProject Sprints API
Work packages can be assigned to a sprint. This is employed in agile contexts such as Scrum or Kanban to group the work packages to be worked on within a defined time frame towards a defined goal.## Linked Properties| Link | Description | Type | Constraints | Supported operations ||:-------------------:|----------------------------------------- | ------------- | -------------------------------------------------------------- | -------------------- || self | This sprint | Sprint | not null | READ || definingWorkspace | The workspace in which the sprint is defined | Workspace | | READ || status | The status the sprint is in | URN | | READ |The status is represented as a URN and can have the following values: - **urn:openproject-org:api:v3:sprints:status:in_planning**: The sprint hasn't started yet, it isplanned. - **urn:openproject-org:api:v3:sprints:status:active**: The sprint is currently active. - **urn:openproject-org:api:v3:sprints:status:completed**: The sprint has finished.## Local Properties| Property | Description | Type | Constraints | Supported operations || :---------: | --------------------------------------------- | ----------- | ----------- | -------------------- || id | Sprint id | Integer | x > 0 | READ || name | Sprint name | String | not null | READ || description | | Formattable | | READ || startDate | | Date | | READ || finishDate | | Date | | READ || createdAt | Time of creation | DateTime | not null | READ || updatedAt | Time of the most recent change to the sprint | DateTime | not null | READ |
OpenProject Sprints API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sprints. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.1.2, at version 3.
Requests are made against 3 base URLs: https://qa.openproject-edge.com, https://qa.openproject-stage.com, https://community.openproject.org.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
OpenProject Sprints API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
Work packages can be assigned to a sprint. This is employed in agile contexts such as Scrum or Kanban to group the work packages to be worked on within a defined time frame toward…
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are SprintModel (9 properties), Link (7 properties), ErrorResponse (4 properties), CollectionModel (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from OpenProject 12
Other APIs OpenProject publishes across the network.
This is an independent, third-party profile of OpenProject Sprints API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.