Sample code for 30+ languages & platforms
Visual FoxPro Requires Chilkat v11.0.0+

Jira Cloud: List Boards, Sprints, and Sprint Issues

See more Jira Examples

Find a board within a project by name, find a sprint on that board, and list its issues. Each list is paginated. Duplicate board or sprint names are treated as ambiguous; choose an ID explicitly if names are not unique.

Boards and sprints belong to the Jira Software REST API. A board's filter and the user's permissions affect what is visible. Sprints must be enabled for the selected board. Team-managed boards can have type simple even when sprints are enabled, so the discovery request does not restrict results to type=scrum. The final request uses the enhanced sprint-issue endpoint with token pagination, rather than the deprecated offset-based issue endpoint. OAuth integrations need the Jira Software scopes listed by these endpoints in addition to platform scopes.

The code uses an Atlassian account email and an API token without scopes with the site URL. For a scoped API token, keep Basic authentication and change baseUrl to https://api.atlassian.com/ex/jira/YOUR_CLOUD_ID. For OAuth2, use that gateway URL, omit Login/Password/BasicAuth, and set http.AuthToken to the access token. See API token authentication and OAuth2 authorization. The account must have permission for the operation; OAuth scopes do not grant additional Jira permissions.

Targets Jira Cloud. Jira Data Center has a separate REST API and may require different paths, authentication, or payloads.

Atlassian REST API documentation

Chilkat Visual FoxPro Downloads

Visual FoxPro
LOCAL lnSuccess
LOCAL loHttp
LOCAL lcBaseUrl
LOCAL loUrl
LOCAL loResp
LOCAL loReply
LOCAL lcBoardName
LOCAL lcSprintName
LOCAL lcBoardId
LOCAL lcSprintId
LOCAL lnBoardMatches
LOCAL lnSprintMatches
LOCAL lnBoardsStart
LOCAL lnBoardsMore
LOCAL loBoardsOffset
LOCAL lnBoardsCount
LOCAL lnBoardsIndex
LOCAL lnSprintsStart
LOCAL lnSprintsMore
LOCAL loSprintsOffset
LOCAL lnSprintsCount
LOCAL lnSprintsIndex
LOCAL lcNextToken
LOCAL lcPreviousToken
LOCAL lnMore
LOCAL i

lnSuccess = 0

*  Assumes Chilkat is unlocked. See Global Unlock Sample.

loHttp = CreateObject('Chilkat.Http')
loHttp.RequireSslCertVerify = 1
loHttp.BasicAuth = 1
*  Read these credentials from private application configuration.
loHttp.Login = "YOUR_ATLASSIAN_EMAIL"
loHttp.Password = "YOUR_API_TOKEN"
lcBaseUrl = "https://your-domain.atlassian.net"
loHttp.Accept = "application/json"
loUrl = CreateObject('Chilkat.StringBuilder')
loResp = CreateObject('Chilkat.HttpResponse')
loReply = CreateObject('Chilkat.JsonObject')
lcBoardName = "Example Board"
lcSprintName = "Sprint 1"
lcBoardId = ""
lcSprintId = ""
lnBoardMatches = 0
lnSprintMatches = 0
loHttp.SetUrlVar("projectKey","PROJECT")
loHttp.SetUrlVar("boardName",lcBoardName)
*  Team-managed boards can have type simple, including boards with sprints enabled.
lnBoardsStart = 0
lnBoardsMore = 1
loBoardsOffset = CreateObject('Chilkat.StringBuilder')
DO WHILE (lnBoardsMore = 1)
    loBoardsOffset.Clear()
    loBoardsOffset.AppendInt(lnBoardsStart)
    loHttp.SetUrlVar("offset",loBoardsOffset.GetAsString())
    loUrl.SetString(lcBaseUrl)
    loUrl.Append("/rest/agile/1.0/board?projectKeyOrId={$projectKey}&name={$boardName}&startAt={$offset}&maxResults=50")
    lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
    IF (loResp.StatusCode = 0) THEN
        ? "No HTTP response was received. Check connectivity and TLS settings."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        CANCEL
    ENDIF

    IF ((lnSuccess <> 1) OR (loResp.StatusCode < 200) OR (loResp.StatusCode >= 300)) THEN
        ? "Request failed. HTTP " + STR(loResp.StatusCode)
        IF (loResp.StatusCode = 429) THEN
            ? "Rate limited. Retry-After: " + loResp.GetHeaderField("Retry-After")
        ENDIF

        *  Inspect this response locally; it can contain private Jira data.
        ? loResp.BodyStr
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        CANCEL
    ENDIF

    lnSuccess = loReply.Load(loResp.BodyStr)
    IF (lnSuccess <> 1) THEN
        ? "Expected a JSON object in the response."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        CANCEL
    ENDIF

    IF (loReply.JsonTypeOf("values") <> 4) THEN
        ? "Expected an array: values"
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        CANCEL
    ENDIF

    lnBoardsCount = loReply.SizeOfArray("values")
    lnBoardsIndex = 0
    DO WHILE (lnBoardsIndex < lnBoardsCount)
        loReply.I = lnBoardsIndex
        ? "Board: " + loReply.StringOf("values[i].name") + "  ID: " + loReply.StringOf("values[i].id")
        IF (loReply.StringOfEquals("values[i].name",lcBoardName,1) = 1) THEN
            lcBoardId = loReply.StringOf("values[i].id")
            lnBoardMatches = lnBoardMatches + 1
        ENDIF

        lnBoardsIndex = lnBoardsIndex + 1
    ENDDO
    lnBoardsStart = lnBoardsStart + lnBoardsCount
    lnBoardsMore = (loReply.BoolOf("isLast") <> 1)
    IF ((lnBoardsMore = 1) AND (lnBoardsCount = 0)) THEN
        ? "Pagination made no progress; stopping."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        CANCEL
    ENDIF

ENDDO
IF (lnBoardMatches <> 1) THEN
    ? "Expected exactly one matching board in this project."
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    RELEASE loBoardsOffset
    CANCEL
ENDIF

loHttp.SetUrlVar("boardId",lcBoardId)
lnSprintsStart = 0
lnSprintsMore = 1
loSprintsOffset = CreateObject('Chilkat.StringBuilder')
DO WHILE (lnSprintsMore = 1)
    loSprintsOffset.Clear()
    loSprintsOffset.AppendInt(lnSprintsStart)
    loHttp.SetUrlVar("offset",loSprintsOffset.GetAsString())
    loUrl.SetString(lcBaseUrl)
    loUrl.Append("/rest/agile/1.0/board/{$boardId}/sprint?startAt={$offset}&maxResults=50")
    lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
    IF (loResp.StatusCode = 0) THEN
        ? "No HTTP response was received. Check connectivity and TLS settings."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        RELEASE loSprintsOffset
        CANCEL
    ENDIF

    IF ((lnSuccess <> 1) OR (loResp.StatusCode < 200) OR (loResp.StatusCode >= 300)) THEN
        ? "Request failed. HTTP " + STR(loResp.StatusCode)
        IF (loResp.StatusCode = 429) THEN
            ? "Rate limited. Retry-After: " + loResp.GetHeaderField("Retry-After")
        ENDIF

        *  Inspect this response locally; it can contain private Jira data.
        ? loResp.BodyStr
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        RELEASE loSprintsOffset
        CANCEL
    ENDIF

    lnSuccess = loReply.Load(loResp.BodyStr)
    IF (lnSuccess <> 1) THEN
        ? "Expected a JSON object in the response."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        RELEASE loSprintsOffset
        CANCEL
    ENDIF

    IF (loReply.JsonTypeOf("values") <> 4) THEN
        ? "Expected an array: values"
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        RELEASE loSprintsOffset
        CANCEL
    ENDIF

    lnSprintsCount = loReply.SizeOfArray("values")
    lnSprintsIndex = 0
    DO WHILE (lnSprintsIndex < lnSprintsCount)
        loReply.I = lnSprintsIndex
        ? "Sprint: " + loReply.StringOf("values[i].name") + "  " + loReply.StringOf("values[i].state") + "  ID: " + loReply.StringOf("values[i].id")
        IF (loReply.StringOfEquals("values[i].name",lcSprintName,1) = 1) THEN
            lcSprintId = loReply.StringOf("values[i].id")
            lnSprintMatches = lnSprintMatches + 1
        ENDIF

        lnSprintsIndex = lnSprintsIndex + 1
    ENDDO
    lnSprintsStart = lnSprintsStart + lnSprintsCount
    lnSprintsMore = (loReply.BoolOf("isLast") <> 1)
    IF ((lnSprintsMore = 1) AND (lnSprintsCount = 0)) THEN
        ? "Pagination made no progress; stopping."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        RELEASE loSprintsOffset
        CANCEL
    ENDIF

ENDDO
IF (lnSprintMatches <> 1) THEN
    ? "Expected exactly one matching sprint."
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loReply
    RELEASE loBoardsOffset
    RELEASE loSprintsOffset
    CANCEL
ENDIF

loHttp.SetUrlVar("sprintId",lcSprintId)
lcNextToken = ""
lcPreviousToken = ""
lnMore = 1
DO WHILE (lnMore = 1)
    loHttp.SetUrlVar("nextToken",lcNextToken)
    loUrl.SetString(lcBaseUrl)
    loUrl.Append("/rest/software/1.0/sprint/{$sprintId}/issue?maxResults=50&fields=summary,status")
    IF (lcNextToken <> "") THEN
        loUrl.Append("&nextPageToken={$nextToken}")
    ENDIF

    lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
    IF (loResp.StatusCode = 0) THEN
        ? "No HTTP response was received. Check connectivity and TLS settings."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        RELEASE loSprintsOffset
        CANCEL
    ENDIF

    IF ((lnSuccess <> 1) OR (loResp.StatusCode < 200) OR (loResp.StatusCode >= 300)) THEN
        ? "Request failed. HTTP " + STR(loResp.StatusCode)
        IF (loResp.StatusCode = 429) THEN
            ? "Rate limited. Retry-After: " + loResp.GetHeaderField("Retry-After")
        ENDIF

        *  Inspect this response locally; it can contain private Jira data.
        ? loResp.BodyStr
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        RELEASE loSprintsOffset
        CANCEL
    ENDIF

    lnSuccess = loReply.Load(loResp.BodyStr)
    IF (lnSuccess <> 1) THEN
        ? "Expected a JSON object in the response."
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        RELEASE loSprintsOffset
        CANCEL
    ENDIF

    IF (loReply.JsonTypeOf("issues") <> 4) THEN
        ? "Expected an array: issues"
        RELEASE loHttp
        RELEASE loUrl
        RELEASE loResp
        RELEASE loReply
        RELEASE loBoardsOffset
        RELEASE loSprintsOffset
        CANCEL
    ENDIF

    i = 0
    DO WHILE (i < loReply.SizeOfArray("issues"))
        loReply.I = i
        ? loReply.StringOf("issues[i].key") + "  " + loReply.StringOf("issues[i].fields.summary")
        i = i + 1
    ENDDO
    lnMore = (loReply.BoolOf("isLast") <> 1)
    IF (lnMore = 1) THEN
        IF ((loReply.JsonTypeOf("nextPageToken") <> 1) OR (loReply.StringOfEquals("nextPageToken","",1) = 1)) THEN
            ? "Missing value: nextPageToken"
            RELEASE loHttp
            RELEASE loUrl
            RELEASE loResp
            RELEASE loReply
            RELEASE loBoardsOffset
            RELEASE loSprintsOffset
            CANCEL
        ENDIF

        lcNextToken = loReply.StringOf("nextPageToken")
        IF (lcNextToken = lcPreviousToken) THEN
            ? "Repeated pagination token; stopping."
            RELEASE loHttp
            RELEASE loUrl
            RELEASE loResp
            RELEASE loReply
            RELEASE loBoardsOffset
            RELEASE loSprintsOffset
            CANCEL
        ENDIF

        lcPreviousToken = lcNextToken
    ENDIF

ENDDO

RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loBoardsOffset
RELEASE loSprintsOffset