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

Jira Cloud: Get an Issue by Key

See more Jira Examples

Read an issue using its human-readable key and select the fields the application needs. An unassigned issue has a null assignee. The description is an ADF object, not an HTML or plain-text string; the example displays that JSON without assuming all ADF nodes are simple paragraphs.

Add a known custom-field ID to the fields parameter when needed. This example deliberately does not treat the embedded comments or worklogs as complete lists; their dedicated endpoints provide pagination.

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

CkPython
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()
issueKey = "PROJECT-123"
http.SetUrlVar("issueKey",issueKey)
url.SetString(baseUrl)
url.Append("/rest/api/3/issue/{$issueKey}?fields=summary,status,assignee,description,labels")
success = http.HttpNoBody("GET",url.getAsString(),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()

print("Issue: " + reply.stringOf("key"))
print("Summary: " + reply.stringOf("fields.summary"))
print("Status: " + reply.stringOf("fields.status.name"))
if (reply.IsNullOf("fields.assignee") == True):
    print("Unassigned")
else:
    print("Assignee: " + reply.stringOf("fields.assignee.displayName"))

if (reply.JsonTypeOf("fields.description") == 3):
    description = chilkat.CkJsonObject()
    # description is a CkJsonObject
    description = reply.ObjectOf("fields.description")
    print("Description (ADF): " + description.emit())