The intercom API reference.
URL https://developers.intercom.com
License MIT
The intercom API reference.
The data export api is used to view all message sent & viewed in a given timeframe.
The current state of your job.
The time after which you will not be able to access the data.
{ "job_identfier": "orzzsbd7hk67xyu", "status": "pending", "download_expires_at": "1674917488", "download_url": "https://api.intercom.test/download/messages/data/example" }
To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data.
The only parameters you need to provide are the range of dates that you want exported.
🚧 Limit of one active job
You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.
❗️ Updated_at not included
It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.
📘 Date ranges are inclusive
Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.
The start date that you request data for. It must be formatted as a unix timestamp.
curl -i -X POST \ https://api.intercom.io/export/content/data \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.10' \ -d '{ "created_at_after": 1717003983, "created_at_before": 1717021983 }'
{ "job_identifier": "3pnq4uopx4s9cmye", "status": "pending", "download_url": "", "download_expires_at": "" }
You can view the status of your job by sending a GET request to the URL https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.
🚧 Jobs expire after two days All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.
curl -i -X GET \ 'https://api.intercom.io/export/content/data/{job_identifier}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.10'
{ "job_identifier": "g7izbbolicujndl4", "status": "pending", "download_url": "", "download_expires_at": "" }
curl -i -X POST \ 'https://api.intercom.io/export/cancel/{job_identifier}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.10'
{ "job_identifier": "vl698f5y3e0vz9y6", "status": "canceled", "download_url": "", "download_expires_at": "" }
When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.
Your exported message data will be streamed continuously back down to you in a gzipped CSV format.
📘 Octet header required
You will have to specify the header Accept:
application/octet-streamwhen hitting this endpoint.
curl -i -X GET \ 'https://api.intercom.io/download/content/data/{job_identifier}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.10'