Skip to content

All resources

sprints

4 endpoints

get /projects/{id}/sprints

List a project's sprints

Requires authentication

Returns the active sprint (nil when none) plus the completed sprint history, most-recent first.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

post /projects/{id}/sprints/dates

Update the active sprint's planned span

Requires authentication

Sets the active sprint's planned start/end dates — fired when the sprint bar is dragged/resized on the calendar.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id

Request body: object

No fields documented.

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope
  • 409 Conflict · apimodel.ErrorEnvelope

post /projects/{id}/sprints/end

End the active sprint

Requires authentication

Closes the active sprint, snapshots its task counts, rolls unfinished current tasks to Next, and clears done ones.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope
  • 409 Conflict · apimodel.ErrorEnvelope

post /projects/{id}/sprints/start

Start a sprint

Requires authentication

Creates a new active sprint and promotes the Next bucket into it. Rejects if one is already active.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id

Request body: object

No fields documented.

Responses

  • 201 Created · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope
  • 409 Conflict · apimodel.ErrorEnvelope