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 Unicode C++ Downloads
#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>
#include <CkJsonObjectW.h>
void ChilkatSample(void)
{
bool success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
CkHttpW http;
http.put_RequireSslCertVerify(true);
http.put_BasicAuth(true);
// Read these credentials from private application configuration.
http.put_Login(L"YOUR_ATLASSIAN_EMAIL");
http.put_Password(L"YOUR_API_TOKEN");
const wchar_t *baseUrl = L"https://your-domain.atlassian.net";
http.put_Accept(L"application/json");
CkStringBuilderW url;
CkHttpResponseW resp;
CkJsonObjectW reply;
CkJsonObjectW request;
// Bound the query to a project. Adapt the JQL to your permissions and needs.
request.UpdateString(L"jql",L"project = PROJECT ORDER BY key");
request.UpdateInt(L"maxResults",50);
request.UpdateString(L"fields[0]",L"summary");
request.UpdateString(L"fields[1]",L"status");
request.UpdateString(L"fields[2]",L"assignee");
const wchar_t *previousToken = L"";
const wchar_t *nextToken = L"";
bool more = true;
while ((more == true)) {
url.SetString(baseUrl);
url.Append(L"/rest/api/3/search/jql");
success = http.HttpJson(L"POST",url.getAsString(),request,L"application/json",resp);
if (resp.get_StatusCode() == 0) {
wprintf(L"No HTTP response was received. Check connectivity and TLS settings.\n");
return;
}
if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
wprintf(L"Request failed. HTTP %d\n",resp.get_StatusCode());
if (resp.get_StatusCode() == 429) {
wprintf(L"Rate limited. Retry-After: %s\n",resp.getHeaderField(L"Retry-After"));
}
// Inspect this response locally; it can contain private Jira data.
wprintf(L"%s\n",resp.bodyStr());
return;
}
success = reply.Load(resp.bodyStr());
if (success != true) {
wprintf(L"Expected a JSON object in the response.\n");
return;
}
if (reply.JsonTypeOf(L"issues") != 4) {
wprintf(L"Expected an array: issues\n");
return;
}
int count = reply.SizeOfArray(L"issues");
int i = 0;
while ((i < count)) {
reply.put_I(i);
wprintf(L"%s %s %s\n",reply.stringOf(L"issues[i].key"),reply.stringOf(L"issues[i].fields.summary"),reply.stringOf(L"issues[i].fields.status.name"));
if (reply.IsNullOf(L"issues[i].fields.assignee") != true) {
wprintf(L"Assignee: %s\n",reply.stringOf(L"issues[i].fields.assignee.displayName"));
}
i = i + 1;
}
more = (reply.BoolOf(L"isLast") != true);
if (more == true) {
if ((reply.JsonTypeOf(L"nextPageToken") != 1) || (reply.StringOfEquals(L"nextPageToken",L"",true) == true)) {
wprintf(L"Missing value: nextPageToken\n");
return;
}
nextToken = reply.stringOf(L"nextPageToken");
if (nextToken == previousToken) {
wprintf(L"Repeated pagination token; stopping.\n");
return;
}
previousToken = nextToken;
request.UpdateString(L"nextPageToken",nextToken);
}
}
}