Exports
Use the exports API to export records and property data from your HubSpot account, retrieve a URL to download an export file, or see the status of an export. Within HubSpot, you can also export records or view a log of past exports in your account.
To start an export, make a POST
request to /crm/v3/exports/export/async
. Your request body should specify information such as the file format, the object and properties you want to export, and the type of export you're completing (e.g., exporting an object view or a list). You can also filter the property data to be exported based on specific operators.
For both view and list exports, you can include the following fields in your request:
Parameter | Description |
---|---|
exportType
| The type of export, either |
format
| The file format. Options include |
exportName
| The name of the export. |
language
| The language of the export file. Options include |
objectType
| The name or ID of the object you're exporting. For standard objects, you can use the object's name (e.g., |
associatedObjectType
| The names or IDs of associated objects to include in the export. If you include associated objects, the export will contain the associated record IDs of that object and the records' primary display property value (e.g., name). |
objectProperties
| A list of the properties you want included in your export. |
If you're exporting an index page view, your exportType
value should be VIEW
, and you can include the following field to filter and sort the records you're exporting:
Parameter | Description |
---|---|
publicCrmSearchRequest
| Indicates which data should be exported based on certain property values and search queries. You can include the following within the object:
|
For example, to export a view of contacts and associated company records, filtered by the email
property, your request may look like the following:
If you're exporting a list, your exportType
value should be LIST
, but you also need to specify the list you're exporting with the following field:
Parameter | Description |
---|---|
listId
| The ID of the list to export. You can find the list ID via the list details in HubSpot or for contact lists, by making a |
For example, to export a list with the contacts' emails, your request may look like the following:
When you successfully complete an export, the export's id
will be returned in the response. To retrieve an export from your HubSpot account, make a GET
request to /crm/v3/exports/export/async/tasks/{exportId}/status
.
When retrieving exports, the status
of the export will also be returned. Possible statuses include COMPLETED
, PENDING
, PROCESSING
, or CANCELED
. For exports with a COMPLETED
status, a URL is returned that you can use to download the exported file. The download URL will expire five minutes after the completed request. Once expired, you can perform another GET
request to generate a new unique URL.
The following limits apply to the export endpoints:
- When setting filters for your export, you can include a maximum of three
filterGroups
with up to threefilters
in each group.
- There will be a limit to the number of exports you can complete within 24 hours, and the number of exports you can complete simultaneously. These limits will be determined during the API's beta period.
Thank you for your feedback, it means a lot to us.