PHPackages                             guenard/helpscout-exporter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. guenard/helpscout-exporter

AbandonedArchivedLibrary

guenard/helpscout-exporter
==========================

Export your Help Scout conversations

v1.2.1(8y ago)13891PHPPHP >=5.6.0

Since May 14Pushed 6y ago1 watchersCompare

[ Source](https://github.com/guenard/helpscout-exporter)[ Packagist](https://packagist.org/packages/guenard/helpscout-exporter)[ RSS](/packages/guenard-helpscout-exporter/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (3)Versions (3)Used By (0)

This project has been deprecated following the shutdown of Help scout Mailbox API 1.0.

[![No Maintenance Intended](https://camo.githubusercontent.com/d904056147052e22d8e1c7f46bb50293ed2aeb4c43ead9a2d0cf7a48b46d0562/687474703a2f2f756e6d61696e7461696e65642e746563682f62616467652e737667)](http://unmaintained.tech/)

Help Scout exporter
===================

[](#help-scout-exporter)

This small program lets you **download your history of [Help Scout](https://helpscout.net) email threads & conversations**, either for backup purposes or because you are exporting your data archive to another platform. Help Scout is an *email-based customer support / help desk service*.

This program, written in PHP, uses Help Scout's [Mailbox API 1.0](https://developer.helpscout.com/help-desk-api/) to:

- get your mailboxes list
- get the conversations into those mailboxes
- get the email threads into those conversations

Exported data will be automatically written into JSON files under the supplied directory path:

- `mailboxes.json` file will list mailboxes metadata.
- `conversations_{mailbox.id}.json` files will list conversations and threads under these mailboxes.

Running this program might be slow if you have lots of conversations as it respects Help Scout API rate-limit of (only) 200 requests per minute. It is not possible to pause/restart the program as it will start all over again when you run it again later, creating potential duplicates in the output files. If the program stopped, you should clean previous files (eg: `rm -R ~/helpscout-data/*.json`) before restarting.

Requirements
------------

[](#requirements)

- **PHP 5.6+** for the command line (eg: `sudo apt-get install php-cli`)
- **Composer** the dependency manager for PHP ([documentation](https://getcomposer.org/download/))

Usage
-----

[](#usage)

### 1. Install the script with:

[](#1-install-the-script-with)

```
composer global require guenard/helpscout-exporter
```

**Notes:**

*Add Composer global binaries to your path with `export PATH=$HOME/.composer/vendor/bin:$PATH` (add this line to your `~/.profile` or ` ~/.bashrc`).*

### 2. Configure Help Scout API key:

[](#2-configure-help-scout-api-key)

In your terminal, set the [Help Scout API key](https://docs.helpscout.net/article/1074-manage-api-keys) as an environment variable with:

```
export HELPSCOUT_API_KEY=YOUR_API_KEY_HERE
```

### 3. Run the exporter script:

[](#3-run-the-exporter-script)

```
helpscout-exporter -o ~/helpscout-data/ > ~/helpscout-export.log &
```

**Notes:**

*To let the program run for a very long time a) prefix the command with `nohup` (will detach the process from your current terminal) and b) suffix the command with `&` (will move it in background).*

### 4. Monitor the running exporter script:

[](#4-monitor-the-running-exporter-script)

```
# monitor output log in real-time
tail -f ~/helpscout-export.log
# number of conversations exported
cat ~/helpscout-data/conversations_*.json |grep '"threads":' |wc -l
```

Disclaimer
----------

[](#disclaimer)

Help Scout (R) is a registered Trademark of Help Scout Inc.

This open-source script is *not* affiliated with Help Scout Inc.

Before using this script, please review Help Scout's [Terms of Service](https://www.helpscout.net/company/legal/terms-of-service/).

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 87.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

2922d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d5c44d3d420f90ebfad42aa2cb486e67f7cc7497debcf06e1773ada365f87ef3?d=identicon)[guenard](/maintainers/guenard)

---

Top Contributors

[![guenard](https://avatars.githubusercontent.com/u/1021524?v=4)](https://github.com/guenard "guenard (7 commits)")[![stevenwadejr](https://avatars.githubusercontent.com/u/1508485?v=4)](https://github.com/stevenwadejr "stevenwadejr (1 commits)")

---

Tags

archivedbackupclicomposerexporterhelpdeskhelpscoutmigrationphp

### Embed Badge

![Health badge](/badges/guenard-helpscout-exporter/health.svg)

```
[![Health](https://phpackages.com/badges/guenard-helpscout-exporter/health.svg)](https://phpackages.com/packages/guenard-helpscout-exporter)
```

###  Alternatives

[craftcms/cms

Craft CMS

3.6k3.6M2.6k](/packages/craftcms-cms)[google/cloud

Google Cloud Client Library

1.2k16.2M53](/packages/google-cloud)[google/cloud-core

Google Cloud PHP shared dependency, providing functionality useful to all components.

343121.4M79](/packages/google-cloud-core)[googleads/googleads-php-lib

Google Ad Manager SOAP API Client Library for PHP

67410.3M25](/packages/googleads-googleads-php-lib)[tempest/framework

The PHP framework that gets out of your way.

2.1k23.1k9](/packages/tempest-framework)[akamai-open/edgegrid-client

Implements the Akamai {OPEN} EdgeGrid Authentication specified by https://developer.akamai.com/introduction/Client\_Auth.html

482.5M6](/packages/akamai-open-edgegrid-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)