Makers can use this handy API endpoint to export all your notes, components, features, and subfeatures in seconds.
In this article:
- How to export all notes
- How to export all notes with associated features
- How to export all features (plus subfeatures and components)
- How to strip HTML from exported notes
- Troubleshooting
How to export all notes
Exports include all notes, but only the content (description field) of some types of notes is included in the export:
-
The content of the note is included for all notes created in Productboard, the Portal, or via the Chrome extension or email.
-
The content of the note is not included for notes created via third-party applications such as Zendesk and Intercom. For these notes, all data is exported except for the content. (The note_text field is left blank.)
Steps:
-
Make sure you're signed in to your Productboard workspace.
- Paste this URL into your browser:
https://[your_workspace].productboard.com/api/notes/export
Note: To locate your workspace name, see the article How can I find my workspace name?
- Insert your workspace's name into the URL. (When you're logged into Productboard, this will be at the beginning of the URL, before "productboard.com".)
- Press enter.
How to export all notes with associated features
Want to maintain a record of the features associated with certain notes?
-
Make sure you're signed in to your Productboard workspace.
- Paste this URL into your browser:
https://[your_workspace].productboard.com/api/notes/export?export_type=with_features
Note: To locate your workspace name, see the article How can I find my workspace name?
- Insert your workspace's name into the URL. (When you're logged into Productboard, this will be at the beginning of the URL, before "productboard.com".)
- Press enter.
How to export all features (plus subfeatures and components)
Exports also include all data fields associated with each feature that have been shared with you.
Steps:
- Make sure you're signed in to your Productboard workspace.
- Paste this URL into your browser:
https://[your_workspace].productboard.com/api/features/export
Note: To locate your workspace name, see the article How can I find my workspace name?
- Insert your workspace name into the URL. (When you're logged into Productboard, this will be at the beginning of the URL, before "productboard.com".)
- Press enter.
How to strip HTML from exported notes
By default, the description fields of exported notes includes HTML formatting. To export without HTML, append the following parameter to the export URL:
&strip_html=true
So the final URL you enter in your browser might look like this:
https://[yourworkspace].productboard.com/api/notes/export?export_type=with_features&strip_html=true
Note: To locate your workspace name, see the article How can I find my workspace name?
How to export data fields
When you export features, associated data fields (segments, releases, drivers...) are exported as well.
In the case where a data field's sharing settings have been updated to restrict access, it will only be included in the export if it has been shared with you.
Troubleshooting
When exporting features and notes into a CSV, Excel will sometimes misformat special characters, in order to resolve this the CSV needs to be imported to Excel in a specific manner. In Excel:
- Go to the Data tab.
- Select in the database icon, Get Data...
- Select from text/ CSV, then pick the CSV export file.
- There will be a preview of the imported file. There’s nothing to change here but click on the Load button.
- Then the CSV is perfectly imported.
Comments
Very helpful - is there a way to export comments attached to notes?
Please sign in to leave a comment.