Jira "Get All Sprints by Board" endpoint does not return the field "total"

Question

Hitting the endpoint to get all sprints for a board does not return with the "total" field as described here: https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-agile-1-0-board-boardid-sprint-get.

My response is something like:

{
  "maxResults":50,
  "startAt":0,
  "isLast":false,
  "values":[....]
}

Is this endpoint busted?

Mathieu RIO · Answer

That's really ugly, the bug in documentation is still there after 2 years :(

Bill Sheboy · Answer

Hi @Andrew Tarr

I tried that method and got all the sprints back in "values" and the "total" field was not present.  Same result when I used a board with below and above the maxResults of sprints.

It appears the documentation is out of date or there is an issue, so if you need that field (rather than counting the "values"), consider asking your site admin to submit a support ticket.

Best regards,

Bill