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

Jira Cloud: Search Issues with JQL

See more Jira Examples

Use enhanced JQL search to retrieve selected issue fields across every page. Sending JQL in a JSON POST body avoids URL-length and query-encoding problems. The current endpoint uses nextPageToken; do not substitute startAt or use the deprecated /rest/api/3/search endpoint.

Results include only issues visible to the account. Recent changes can take time to appear in search. If immediate read-after-write consistency is needed, use the endpoint's reconcileIssues option with the affected numeric issue IDs, or retrieve a known issue directly. A pagination token belongs to the same query and selected fields.

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 loRequest
LOCAL lcPreviousToken
LOCAL lcNextToken
LOCAL lnMore
LOCAL lnCount
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')
loRequest = CreateObject('Chilkat.JsonObject')
*  Bound the query to a project. Adapt the JQL to your permissions and needs.
loRequest.UpdateString("jql","project = PROJECT ORDER BY key")
loRequest.UpdateInt("maxResults",50)
loRequest.UpdateString("fields[0]","summary")
loRequest.UpdateString("fields[1]","status")
loRequest.UpdateString("fields[2]","assignee")
lcPreviousToken = ""
lcNextToken = ""
lnMore = 1
DO WHILE (lnMore = 1)
    loUrl.SetString(lcBaseUrl)
    loUrl.Append("/rest/api/3/search/jql")
    lnSuccess = loHttp.HttpJson("POST",loUrl.GetAsString(),loRequest,"application/json",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 loRequest
        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 loRequest
        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 loRequest
        CANCEL
    ENDIF

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

    lnCount = loReply.SizeOfArray("issues")
    i = 0
    DO WHILE (i < lnCount)
        loReply.I = i
        ? loReply.StringOf("issues[i].key") + "  " + loReply.StringOf("issues[i].fields.summary") + "  " + loReply.StringOf("issues[i].fields.status.name")
        IF (loReply.IsNullOf("issues[i].fields.assignee") <> 1) THEN
            ? "Assignee: " + loReply.StringOf("issues[i].fields.assignee.displayName")
        ENDIF

        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 loRequest
            CANCEL
        ENDIF

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

        lcPreviousToken = lcNextToken
        loRequest.UpdateString("nextPageToken",lcNextToken)
    ENDIF

ENDDO

RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loRequest