NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
Packagist
Packagist, #2117 most downloaded on Packagist
JIRA REST API Client for PHP Users.
Latest stable
5.16.1
Last release 17 days ago
05 Nov 2026
Ships fairly regularly
a new release about every 4 months
Some releases are documented
notes for 35 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
12 years old
157 releases · first in 2015
Drag across the ruler to compare, or tap a release to open it.
Restored IssueService::search(..., validateQuery: false) for Jira Server/Data Center (#571). Searches containing unknown issue keys can now return mat
IssueService::search(..., validateQuery: false) for Jira Server/Data Center (#571). Searches containing unknown issue keys can now return matching issues instead of failing with HTTP 400./search endpoint both when falling back from /search/jql and on later searches against a detected Server/Data Center host. The default request is unchanged, and Jira Cloud's enhanced search does not receive the unsupported setting.Full Changelog: https://github.com/lesstif/php-jira-rest-client/compare/5.16.0...5.16.1
UserService can now get, set and delete user properties:
UserService can now get, set and delete user properties:
use JiraRestApi\Issue\Property;
use JiraRestApi\User\UserService;
$us = new UserService();
$user = ['username' => 'lesstif']; // or ['userKey' => ...], ['accountId' => ...] on Jira Cloud
$property = new Property();
$property->key = 'my.settings';
$property->value = ['theme' => 'dark', 'pageSize' => 50];
$us->setProperty($user, $property);
$keys = $us->getPropertyKeys($user); // ['my.settings', ...]
$value = $us->getProperty($user, 'my.settings')->value; // decoded JSON
$us->deleteProperty($user, 'my.settings');
Property::$value is now mixed, because property values can be any JSON value. Before, setting an array or object value threw a TypeError, for issue properties as well. Existing code using string values keeps working.
IssueService::renderWikiMarkup() renders Jira wiki markup to HTML:
$html = $issueService->renderWikiMarkup('*bold* [link|https://example.com]');
// with an issue key, issue links and attachments are rendered in the context of the issue
$html = $issueService->renderWikiMarkup('see TEST-1 and !screenshot.png!', 'TEST-1');
It calls POST /rest/api/1.0/render, which Jira's own editor preview uses. It isn't a documented public API, so it may change in future Jira versions.
For the HTML of an existing issue's fields, get the issue with 'expand' => ['renderedFields'] instead.
JiraClient::getAPIUri() was added as well.
#262, #363 (and #355, #456 were triaged and closed)
Full Changelog: https://github.com/lesstif/php-jira-rest-client/compare/5.15.0...5.16.0
Your coding agent can read these notes before it upgrades. Set up the MCP server →
`JqlQuery::quote()` now escapes backslashes (#230) Previously a backslash in the value was passed through, so quote('a\nb') produced the JQL escape se
JqlQuery::quote() now escapes backslashes (#230)
Previously a backslash in the value was passed through, so quote('a\nb') produced the JQL escape sequence \n, and other backslashes caused illegal JQL escape sequence errors.
The value is now quoted as is (\ becomes \\). If you relied on passing JQL escape sequences through quote(), build that part of the query yourself.Set OAUTH_ACCESS_TOKEN (or oauthAccessToken in ArrayConfiguration), and it is sent as Authorization: Bearer {token}. It takes precedence over the personal access token and basic authentication.
JIRA_HOST to https://api.atlassian.com/ex/jira/{cloudId}.The library only sends the token. Getting and refreshing it is up to your application. OAuth 1.0a is not supported.
Text search (~) treats characters like ( ) : / [ ] + - ! ^ ~ * ? as special syntax, so searching for a log line failed with Unable to parse the text.
JqlQuery::quoteText() escapes them, and addTextSearchExpression() uses it:
$jql = (new JqlQuery())
->addTextSearchExpression(JqlQuery::FIELD_SUMMARY, 'session_start(): Failed (path: /var/lib/php)');
// or with a raw JQL string
$jql = 'summary ~ '.JqlQuery::quoteText($text);
quoteText() disables wildcards like *. Keep using quote() if you need them.
JqlQuery::quote() broke values containing a double quote (#230). It produced \\" instead of \".
Transition by untranslated status name (#323): Transition::setUntranslatedName() never worked.
IssueStatus didn't declare untranslatedName, so the value was dropped.findTransitonIdByUntranslatedName() returned the status id instead of the transition id, so the transition request failed.It now returns the transition that leads to the matched status. This works regardless of the user's language on Jira Cloud. Jira Server/Data Center doesn't provide untranslatedName, so there the status name is compared instead. The same fix applies to ServiceDesk\Request\RequestService.
AbstractConfiguration::getOAuthAccessToken() threw a TypeError when no token was configured.
JIRA_LOG_ENABLED, JIRA_LOG_FILE, JIRA_LOG_LEVEL) and the Laravel log location are documented in the README (#169).#92, #169, #230, #323
Full Changelog: https://github.com/lesstif/php-jira-rest-client/compare/5.14.0...5.15.0
Since 5.13.0, IssueService::search() falls back to the legacy /search API when the enhanced search API (/search/jql) returns 404. Before this release,
Since 5.13.0, IssueService::search() falls back to the legacy /search API when the enhanced search API (/search/jql) returns 404.
Before this release, every search on Server/Data Center sent two requests: a 404 to /search/jql, then the retry to /search.
Hosts without /search/jql are now remembered, so only the first search hits the 404 and later searches call /search directly.
Each Jira host is detected separately, so using Cloud and Server/Data Center in the same process still works.
JqlQuery::setCustomField() (#569)setCustomField() accepts the operator as an optional 4th parameter. The default is still =, so existing code keeps working.
Some fields don't support =. For example, text fields only support ~, and so do Tempo fields on Forge that are referenced by id (Tempo: expected changes on Forge).
$jql = new JqlQuery();
$jql->setProject('TEST')
// "Account.name" = "Maintenance"
->setCustomField('Account.name', 'Maintenance')
// "cf[10000]" ~ "Maintenance"
->setCustomField('cf[10000]', 'Maintenance', JqlQuery::KEYWORD_AND, JqlQuery::OPERATOR_CONTAINS);
#568, #569
Full Changelog: https://github.com/lesstif/php-jira-rest-client/compare/5.13.0...5.14.0
Removed curl_close() calls, deprecated in PHP 8.5.
This release contains two small behavior changes. Please check your code before upgrading.
IssueField::$fixVersions defaults to null instead of [] (#558)
When fixVersions isn't returned (e.g. it's excluded from the requested fields), the property is now null.
If you iterate over it directly, use the new getter or ?? []:foreach ($issue->fields->getFixVersions() as $version) { ... }
// or
foreach ($issue->fields->fixVersions ?? [] as $version) { ... }
Reporter::$active (and User::$active) is now bool (#532)
It was declared as string, so it held "1" / "". It now holds true / false, as returned by Jira.
if ($user->active) keeps working, but strict comparisons like $user->active === '1' need to change.IssueService::search() now works on both Jira Cloud and Jira Server/Data Center.
It calls the enhanced search API (/search/jql) first. On a 404 it falls back to the legacy /search API (Server/Data Center).
On Server/Data Center, nextPageToken holds the next startAt offset, so the same paging loop works on both:
$nextPageToken = '';
do {
$ret = $issueService->search($jql, $nextPageToken, 50, ['summary']);
// ...
$nextPageToken = $ret->getNextPageToken();
} while (!empty($nextPageToken));
The second parameter of search() is nextPageToken, not startAt. The README pagination example has been updated.
CURL_LOCK_DATA_CONNECT (#567)CURL_LOCK_DATA_CONNECT requires libcurl 7.57.0 or later, but PHP 8.0 - 8.3 can be built with libcurl 7.29.0 (e.g. CentOS/RHEL 7).
The connection cache is now shared only when the constant is defined. Otherwise only the DNS cache is shared.
fixVersions mapping (#558)Mapping a response with "fixVersions": null no longer throws JsonMapper_Exception. New IssueField::getFixVersions() always returns an array.
Several ServiceDesk classes failed to map real API responses:
CustomerService: building a customer from a user failed (wrong timeZone property, accountId/key missing on Server/Cloud, avatarUrls type mismatch).OrganisationService:
createFromOrganisation() sent a JSON string as the organisation name.getCustomersForOrganisation() didn't read the paged values and failed to build its URL.addCustomersToOrganisation() posted form data to the wrong endpoint.Comment, RequestStatus, Organisation, Request: mapping JSON objects failed with TypeError.Customer::setLinks() dropped the given links.versions field, which Jira rejected with 400.curl_close() calls, deprecated in PHP 8.5.vendor/bin/phpunit without a Jira server now passes. Tests that need a live Jira server extend JiraIntegrationTestCase and are skipped unless .env is configured. See "Running tests" in the README. (#532)#532, #542, #547, #552, #558, #567
Full Changelog: https://github.com/lesstif/php-jira-rest-client/compare/5.12.1...5.13.0
Nothing published for this version
Merged #554 #555 #556 #557 #559 #561 #563
Merged #554 #555 #556 #557 #559 #561 #563
Nothing published for this version
Nothing published for this version
Merge from PR #538, #539, #541, #543. #545
Merge from PR #538, #539, #541, #543. #545
Fixed - #534 New feature - #535, #537
Fixed - #534 New feature - #535, #537
Change Logs * fixed #526 * merge #525
Change Logs
Nothing published for this version
Nothing published for this version
Nothing published for this version
- See #512 - See #506 - See #509
added add $startDate, $userStartDate to Version
explicit properties declaration in Version, Project class
Nothing published for this version
Adapt to PHP 8.2's new feature - Dynamic Properties are deprecated, See #486 , #487
Adapt to PHP 8.2's new feature - Dynamic Properties are deprecated, See #486 , #487
duplicated JSM URL fixed(See #476)
I forked V3 API and eliminated all V3 related code in this repository.
Hi!
I forked V3 API and eliminated all V3 related code in this repository.
You can find V3 API repository here.
Fixed ADF(Atlassian Document Format) related issues, See #454, #458, #457
drop the unnecessary code - See #449
bugs fix release * See(#441) * See
bugs fix release
fix several bugs * #441 * #439 * #432
fix several bugs
Nothing published for this version
Drop PHP 7 and added property type(not at all)
Nothing published for this version
new feature - Project component (See #426)
To be compatible with PHP 8.1.(See #401)
* support personal access token(#394 ) * new feature archive project
Nothing published for this version
update dependency for support to PHP 8
Nothing published for this version
Nothing published for this version
Nothing published for this version
fixed function name typo in the IssueService
fixed function name typo in the IssueService (#343 )
Nothing published for this version
support to config personal certificate when connect to jira server.(see #332)
added new Service Class AgileIssueService(See #299)
Nothing published for this version
add get users function for v3 api(See #283 )
update monolog dependancy to v2.
update monolog dependancy to v2.(#281 )
changed project component class(see #265 )
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
file upload performance improvement
persist curl resource handle(see #241 )
Use Proxy Configuration for curl handle
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Use DateTimeInterface instead of DateTime(see #212)
add new functionality for Version
add new functionality for Version
add laravel package auto discover support
Nothing published for this version
Nothing published for this version
One column per quarter.