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 Visual FoxPro Downloads
LOCAL lnSuccess
LOCAL loHttp
LOCAL lcBaseUrl
LOCAL loUrl
LOCAL loResp
LOCAL loReply
LOCAL lcIssueKey
LOCAL loDescription
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')
lcIssueKey = "PROJECT-123"
loHttp.SetUrlVar("issueKey",lcIssueKey)
loUrl.SetString(lcBaseUrl)
loUrl.Append("/rest/api/3/issue/{$issueKey}?fields=summary,status,assignee,description,labels")
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
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
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
CANCEL
ENDIF
? "Issue: " + loReply.StringOf("key")
? "Summary: " + loReply.StringOf("fields.summary")
? "Status: " + loReply.StringOf("fields.status.name")
IF (loReply.IsNullOf("fields.assignee") = 1) THEN
? "Unassigned"
ELSE
? "Assignee: " + loReply.StringOf("fields.assignee.displayName")
ENDIF
IF (loReply.JsonTypeOf("fields.description") = 3) THEN
loDescription = CreateObject('Chilkat.JsonObject')
loDescription = loReply.ObjectOf("fields.description")
? "Description (ADF): " + loDescription.Emit()
RELEASE loDescription
ENDIF
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loReply
RELEASE loDescription