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 CkPython Downloads
import sys
import chilkat
success = False
# Assumes Chilkat is unlocked. See Global Unlock Sample.
http = chilkat.CkHttp()
http.put_RequireSslCertVerify(True)
http.put_BasicAuth(True)
# Read these credentials from private application configuration.
http.put_Login("YOUR_ATLASSIAN_EMAIL")
http.put_Password("YOUR_API_TOKEN")
baseUrl = "https://your-domain.atlassian.net"
http.put_Accept("application/json")
url = chilkat.CkStringBuilder()
resp = chilkat.CkHttpResponse()
reply = chilkat.CkJsonObject()
request = chilkat.CkJsonObject()
# Bound the query to a project. Adapt the JQL to your permissions and needs.
request.UpdateString("jql","project = PROJECT ORDER BY key")
request.UpdateInt("maxResults",50)
request.UpdateString("fields[0]","summary")
request.UpdateString("fields[1]","status")
request.UpdateString("fields[2]","assignee")
previousToken = ""
nextToken = ""
more = True
while (more == True) :
url.SetString(baseUrl)
url.Append("/rest/api/3/search/jql")
success = http.HttpJson("POST",url.getAsString(),request,"application/json",resp)
if (resp.get_StatusCode() == 0):
print("No HTTP response was received. Check connectivity and TLS settings.")
sys.exit()
if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
print("Request failed. HTTP " + str(resp.get_StatusCode()))
if (resp.get_StatusCode() == 429):
print("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"))
# Inspect this response locally; it can contain private Jira data.
print(resp.bodyStr())
sys.exit()
success = reply.Load(resp.bodyStr())
if (success != True):
print("Expected a JSON object in the response.")
sys.exit()
if (reply.JsonTypeOf("issues") != 4):
print("Expected an array: issues")
sys.exit()
count = reply.SizeOfArray("issues")
i = 0
while (i < count) :
reply.put_I(i)
print(reply.stringOf("issues[i].key") + " " + reply.stringOf("issues[i].fields.summary") + " " + reply.stringOf("issues[i].fields.status.name"))
if (reply.IsNullOf("issues[i].fields.assignee") != True):
print("Assignee: " + reply.stringOf("issues[i].fields.assignee.displayName"))
i = i + 1
more = (reply.BoolOf("isLast") != True)
if (more == True):
if ((reply.JsonTypeOf("nextPageToken") != 1) or (reply.StringOfEquals("nextPageToken","",True) == True)):
print("Missing value: nextPageToken")
sys.exit()
nextToken = reply.stringOf("nextPageToken")
if (nextToken == previousToken):
print("Repeated pagination token; stopping.")
sys.exit()
previousToken = nextToken
request.UpdateString("nextPageToken",nextToken)