NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
Packagist, #2854 most downloaded on Packagist
Help Scout API v2 Client
Latest stable
3.10.3
Last release 5 months ago
15 Jun 2026
Release timing varies
gaps range from 5 weeks to 1.4 years
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
12 years old
68 releases · first in 2014
Drag across the ruler to compare, or tap a release to open it.
Add hasNextPage()/hasPreviousPage() to PagedCollection by @Teots in https://github.com/helpscout/helpscout-api-php/pull/335
Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.10.2...3.10.3
Fix "implicit nulls" deprecation warnings for PHP 8.4 by @matical in https://github.com/helpscout/helpscout-api-php/pull/328
Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.10.1...3.10.2
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Allow update of rize/uri-template to v0.4 by @IanSimpson in https://github.com/helpscout/helpscout-api-php/pull/327
Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.10.0...3.10.1
Fix ConversationsEndpoint publishDraft function by @IanSimpson in https://github.com/helpscout/helpscout-api-php/pull/325
Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.9.0...3.10.0
Update Webhook.php by @gldrenthe89 in https://github.com/helpscout/helpscout-api-php/pull/318
Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.8.0...3.9.0
Added functionality to get embedded threads by @wotta in https://github.com/helpscout/helpscout-api-php/pull/317
Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.7.0...3.8.0
Support hydrating embedded threads in incoming webhooks by @matt-h in https://github.com/helpscout/helpscout-api-php/pull/289 When an incoming webhook
Thread objects will be created and hydrated with that data automatically.Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.6.6...3.7.0
Cleanup by @nicolas-grekas in https://github.com/helpscout/helpscout-api-php/pull/309
Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.6.5...3.6.6
Replace ql/uri-template Dependency by @ryancco in https://github.com/helpscout/helpscout-api-php/pull/304
Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.6.4...3.6.5
Add delete customer endpoint by @ryanito in https://github.com/helpscout/helpscout-api-php/pull/300
Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.6.3...3.6.4
Add missing 'text' property to Conversation Custom Fields by @pchemali in https://github.com/helpscout/helpscout-api-php/pull/286
Full Changelog: https://github.com/helpscout/helpscout-api-php/compare/3.6.2...3.6.3
- #283 Added ability to update a customer's property values - thanks @leewillis77 for the contribution!
- #282 Fix bug where the retry request was not using the new auth headers.
- #282 Added methods to hide() and unhide() a Thread in a conversation.
hide() and unhide() a Thread in a conversation.PR #278 now throws a JsonException if an outbound request to Help Scout's API is unable to generate valid json. This is not a breaking change because…
JsonException if an outbound request to Help Scout's API is unable to generate valid json. This is not a breaking change because previously this invalid state would error out anyways.PR #273 adds more webhook header variants for use within Laravel applications
PR #270 adds support for chat endpoints and chat webhook event types.
PR https://github.com/helpscout/helpscout-api-php/pull/266 brings the ability to access customer property values for a Customer - thanks @andryska
Customer - thanks @andryskaPR https://github.com/helpscout/helpscout-api-php/pull/263 SDK can now be used in PHP 8 projects - thanks to @miken32
PR https://github.com/helpscout/helpscout-api-php/pull/261 Now gracefully handling scenarios where failures were encountered when hydrating a Conversa
Conversation where the User who created the convo had been deletedPR https://github.com/helpscout/helpscout-api-php/pull/259 adds a few more sorting options for conversations that are supported by the API - thanks @a
PR https://github.com/helpscout/helpscout-api-php/pull/253 adds compatibility with Guzzle v7 - thanks @dmlogic!
PR https://github.com/helpscout/helpscout-api-php/pull/244 introduces the ability for the SDK to automatically refresh expired tokens. There's a new s
PR https://github.com/helpscout/helpscout-api-php/pull/243 enables the ability to fetch a thread email's original source.
Support for a new customer.updated web hook via PR https://github.com/helpscout/helpscout-api-php/pull/231
This release includes:
customer.updated web hook via PR https://github.com/helpscout/helpscout-api-php/pull/231[Breaking Change] PHP 7.1 has reached end of life and 7.2 is receiving security updates only, so v3 now requires PHP 7.3 (see #216). PHPDoc tags have…
With this release we're targeting improving the developer experience to make the SDK easier to work with. There's no new API interaction being added.
(new ConversationFilter())->withMailbox(40323) can give the impression that we're eager loading mailbox 40323 alongside the conversations, but it'll actually list the conversations in that mailbox. To make this more clear, we've eliminated the with*() verbiage for filters in favor of more specific verbiage like inMailbox(2), modifiedSince(Carbon::now()->subDay()) and hasTag('trial-customer').
Refactored filter objects to use more clear terminology.HelpScout\Api\Exception\AuthenticationException is now thrown when the API responds with a 401. Previously this threw a GuzzleHttp\Exception\RequestException, so if you are catching that exception to refresh your token, you'll need to update your code base. (see #212)HelpScout\Api\Customers\Entry\Chat has been removed completely in place of HelpScout\Api\Customers\Entry\ChatHandle. This was previously deprecated in v2. (see #229, #100, #102)isAssigned method has been added to HelpScout\Api\Conversations\Threads\Thread.php to help reduct additional logic when determining if a given Thread is assigned.(See #230)PR https://github.com/helpscout/helpscout-api-php/pull/245 introduces the ability for the SDK to automatically refresh expired tokens. There's a new s
PR https://github.com/helpscout/helpscout-api-php/pull/242 enables the ability to fetch a thread email's original source.
PR https://github.com/helpscout/helpscout-api-php/pull/207 removes unnecessary docblocks where type hints or return values are sufficient. This PR mak
PR https://github.com/helpscout/helpscout-api-php/pull/200 fulfills https://github.com/helpscout/helpscout-api-php/issues/197 by adding some additiona
PR https://github.com/helpscout/helpscout-api-php/pull/191 fulfills https://github.com/helpscout/helpscout-api-php/issues/174 by adding the ability to
PR https://github.com/helpscout/helpscout-api-php/pull/189 resolves a regression that caused php exceptions when embedded entities were present but em
PR https://github.com/helpscout/helpscout-api-php/pull/185 resolves an issue with the date format used when filtering Customers or Conversations
PR https://github.com/helpscout/helpscout-api-php/pull/180 resolves https://github.com/helpscout/helpscout-api-php/issues/178 by preventing the hydrat
getCorrelationId() as an alias for getLogRef() so it's more clear how to provide the ID when contacting Help ScoutThanks to @matt-allan for submitting issue #175 and creating PR #176 to resolve it. There was an issue where the API response format changed and we we
Thanks to @matt-allan for submitting issue #175 and creating PR #176 to resolve it. There was an issue where the API response format changed and we were improperly assuming that HalDocument _embedded properties were only arrays and this was causing issues.
Thanks to @dodedodo33 who submitted PR https://github.com/helpscout/helpscout-api-php/pull/173 resolving https://github.com/helpscout/helpscout-api-ph
PR https://github.com/helpscout/helpscout-api-php/pull/171 expands the available shorthand types for Customers. You can now use these methods with str
$customer->addChatHandle('helpscout', 'aim')$customer->addSocialProfile('helpscout', 'twitter')$customer->addPhone('14235554837')$customer->addWebsite('https://helpscout.com')PR https://github.com/helpscout/helpscout-api-php/pull/167 resolves https://github.com/helpscout/helpscout-api-php/issues/163 - user is now correctly
user is now correctly populated with the expected id of the user when creating a new Conversation$customer->addEmail($emailAddress, 'work')Thanks again to @wking-io for PR https://github.com/helpscout/helpscout-api-php/pull/162 which resolves https://github.com/helpscout/helpscout-api-php
$customer->getEmails() was incorrectly returning emails as a collection of strings rather than EmailsThanks to @wking-io for contributing PR https://github.com/helpscout/helpscout-api-php/pull/158 which added the webUrl attribute to the extract attrib
webUrl attribute to the extract attributes for an AttachmentgetType() to help determine what type the existing thread isCustomerThread, PhoneThread, NoteThread, etc. We only type thread types that can be created through the API. Any system-based or unknown thread types will not be typedPR https://github.com/helpscout/helpscout-api-php/pull/155 resolves https://github.com/helpscout/helpscout-api-php/issues/154 - $attachment->getWebUrl
$attachment->getWebUrl() will now provide the web accessible URL for the attachmentPR https://github.com/helpscout/helpscout-api-php/pull/148 adds support for recently added reporting endpoints that includes:
Thanks to @JPry for contributing PR https://github.com/helpscout/helpscout-api-php/pull/147 which resolves an issue with an invalid date format used w
PR https://github.com/helpscout/helpscout-api-php/pull/145 resolves https://github.com/helpscout/helpscout-api-php/issues/143 - PHP and SDK versions a
PR https://github.com/helpscout/helpscout-api-php/pull/139 resolves https://github.com/helpscout/helpscout-api-php/issues/138 - Correct version of the
PR https://github.com/helpscout/helpscout-api-php/pull/131 resolves https://github.com/helpscout/helpscout-api-php/issues/129 - Correct query paramete
Conversation by customerFieldIdsConversation not being correctly hydrated with all data when using $webhook->getConversation()PR https://github.com/helpscout/helpscout-api-php/pull/127 - You can now use IncomingWebhook::makeFromGlobals($secret) to build an instance of Incomin
IncomingWebhook::makeFromGlobals($secret) to build an instance of IncomingWebhook without having to first build a PSR-7 compatible RequestInterfacePR https://github.com/helpscout/helpscout-api-php/pull/122 resolves https://github.com/helpscout/helpscout-api-php/issues/121 - Adds support for valid
setAssignee() can now be used to specify the assignee when creating a conversation (previously could only use setAssignTo())updateTags() and updateCustomFields() now accept Collection and [Tags|CustomFields]Collection in addition to an array. This is a quality of life improvement, making it easier to update these fields for existing conversations.In other news, the v2 branch is now the new master. You can still track changes to the v1 SDK via the v1 branch.
PR https://github.com/helpscout/helpscout-api-php/pull/120 resolves https://github.com/helpscout/helpscout-api-php/issues/118 - All Customer attribute
PR https://github.com/helpscout/helpscout-api-php/pull/102 deprecates a Customer's Chat and replaces it with ChatHandle to better reflect what data is…
$client->swapAuthorizationCodeForReusableTokens() enabling developers to quickly and easily exchange the code for a refresh and access token pair. A shout out goes to @scr4bble for pushing this work forward!Customer's Chat and replaces it with ChatHandle to better reflect what data is being provided and to get in sync with our updated API documentation. Relevant getter and setter methods have also been deprecated in favor of $customer->getChatHandles().$client->useLegacyToken() and all relevant legacy credentials configuration. These will be fully removed on June 6, 2019 so you'll need to make sure you've upgraded your authentication to OAuth2. Here's an example of how to upgrade painlessly using the SDK:$authenticator = HelpScout\Api\ApiClientFactory::createClient()
->useLegacyToken($clientId, $apiKey)
->getAuthenticator();
$authenticator->convertLegacyToken():
var_dump($authenticator->getTokens()); // an array containing your new tokens
CustomerRequest is deprecated. Recent updates to the Mailbox API v2 means customers()->get() and customers()->list() will always provide embedded enti…
PR #101 brought a few changes:
CustomerRequest is deprecated. Recent updates to the Mailbox API v2 means customers()->get() and customers()->list() will always provide embedded entities. Any applications that still use this object to eager load will not experience any errors, but it isn't required and can be removed.HasOne relationships (e.g. Customer has one Address) are now properly hydrated (resolves https://github.com/helpscout/helpscout-api-php/issues/89)PR #92 will now return the Resource ID value (or null if none available) when creating a resource via the API. This closes Issue #88
null if none available) when creating a resource via the API. This closes Issue #88PR #87 removes validation on Attachment size, height and width values (also closes issue #86)
Attachment size, height and width values (also closes issue #86)PR #78 adds missing functionality to filter conversations by custom field ID value (also closes issue #77)
This release adds a few things
The API client now uses the Mailbox API v2. This release is _not_ backwards compatible with the v1.x releases.
The API client now uses the Mailbox API v2. This release is not backwards compatible with the v1.x releases.
This is the first beta release of the official PHP client for the Help Scout Mailbox v2 API.
This is the first beta release of the official PHP client for the Help Scout Mailbox v2 API.
This is NOT backwards-compatible with the pre-2.0 versions. In fact, we started from the ground-up to make this client easier to use, test, mock, and troubleshoot.
Take a look at the README file for more information.
Additional headers can be specified statically using:
Additional headers can be specified statically using:
ApiClient::setAdditionalHeaders([
'foo' => 'bar',
]);
All subsequent requests will have those headers included.
No changes in this tag. This release marks the point when v1 maintenance was moved off the master branch and into a separate branch.
No changes in this tag. This release marks the point when v1 maintenance was moved off the master branch and into a separate branch.
This release adds a notice to the readme file that on April 1, 2019, we will be moving the work targeting Mailbox API v1 to a separate branch and merg
This release adds a notice to the readme file that on April 1, 2019, we will be moving the work targeting Mailbox API v1 to a separate branch and merging the v2 branch into master. At that time, anyone referencing dev-master in their composer.json file needs to either specify the specific tagged version, if still using the v1 Mailbox API, or things will break.
This release contains changes from 2 pull requests:
This release contains changes from 2 pull requests:
One column per quarter.