Wholesale API with Fast Delivery

Exporting articles - how do you actually export them using the API?

Answered

1 year ago January 22, 2025 2 replies 565 views

Question from Alex D.

Hi I know that I need to use the API to export articles, and I’ve looked at a couple of existing questions around this. The answer seems to be, you need to use the API and to look at the article Formatting and exporting your articles with the API for answers. That article doesn’t have any information about exporting articles using the API. It has one line of text right at the bottom, pointing you to the developer docs, but not guidelines as to how to start. I looked at the data export section of the developer docs and gave that a try, and first of all found out that it will only pull data from a 90 day period, so pretty useless if you want to export docs that have been created over time. I tried the Export API endpoint with a shorter time period and still had issues. For anyone else trying, you first have to Create a Data export, the response from that request will give you a job number. You then need to download the data export, using the job number. I tried this in the Intercom test environment (in the Dev doc examples, where you click ‘try it’) and got it to work, but the response data is gibberish (ie it didn’t give ma a nice neat csv). Should I be using the Data export end point? Or do I need to use the articles one and download each article one at a time using the API?

Best answer by Jacques Reynolds

Hi Alex D.👋 Jacques here from support engineering! Hope all is well with you today :) You can export articles from your Help Center by using the Articles API. The process involves the following steps steps:

1. Obtain an admin access token to authenticate your API requests. This token can be created in the Developers Hub section of your Intercom workspace.
2. Use the List all articles endpoint to fetch a list of all your articles, which will provide you with the article IDs necessary for exporting.
3. For each article ID, use the Retrieve an Article endpoint to retrieve the full content and metadata of each article.
4. After retrieving the data, you can format and save it as needed, such as in JSON or HTML format on your own end.

Please note that certain HTML elements like div, span, form, input, textarea, and script tags are not supported and may be removed or replaced with paragraph tags during the export process. Hope this is clear!

Replies

Jacques Reynolds (Intercom Team)

Hi Alex D.👋 Jacques here from support engineering! Hope all is well with you today :) You can export articles from your Help Center by using the Articles API. The process involves the following steps steps:

1. Obtain an admin access token to authenticate your API requests. This token can be created in the Developers Hub section of your Intercom workspace.
2. Use the List all articles endpoint to fetch a list of all your articles, which will provide you with the article IDs necessary for exporting.
3. For each article ID, use the Retrieve an Article endpoint to retrieve the full content and metadata of each article.
4. After retrieving the data, you can format and save it as needed, such as in JSON or HTML format on your own end.

Please note that certain HTML elements like div, span, form, input, textarea, and script tags are not supported and may be removed or replaced with paragraph tags during the export process. Hope this is clear! Jacques Reynolds

TBelevska

Hi Alex D. If you need to export articles from Intercom,Help Desk Migration offers an automated way to do