Get a file uploaded via form field | Forms API

Method Details

HTTP Methods:

GET

Response Format:

N/A

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Marketing

Required Scope:

forms-uploaded-files

For a given file id, return the file associated with that Id.

The complete URL required to fetch the uploaded file can be found in the submitted form metadata, or on an associated contact record. The name of the property containing this URL will vary depending on the name given to the file upload.

The initial GET on this URL returns a redirect, which should be followed to retrieve the file.

Specific URL parameters, including portalId, sign, conversionId, and filename will be included as part of the URL fetched from the property as described above. These variables should not be changed.

Required Parameters	How to use	Description
OAuth access token or private app access token	Authorization: Bearer {token} header	Used to authenticate the request. Please see this page for more details about authentication.

Example URL: https://api.hubapi.com/form-integrations/v1/uploaded-files/signed-url-redirect/20128659661?portalId=62515&sign=sXEkvOBg6C5eiGuxOxrMYWCQb8k%3D&conversionId=1eac2f96-f4b7-4312-a4c3-9962382207f2&filename=1eac2f96-f4b7-4312-a4c3-9962382207f2-upload_a_file-test_file.txt

JSON
cURL/Bash

Example JSON response: { "portalId": 62515, "guid": "1eae3941-9ce8-411d-8b91-87a92c0c9d5c", "name": "Example Test Form", "action": "", "method": "POST", "cssClass": "hs-form stacked", "redirect": "", "submitText": "Submit", "followUpId": "", "notifyRecipients": "", "leadNurturingCampaignId": "", "formFieldGroups": [ { "fields": [ { "name": "firstname", "label": "First Name", "type": "string", "fieldType": "text", "description": "", "groupName": "contactinformation", "displayOrder": -1, "required": false, "selectedOptions": [ ], "options": [ ], "validation": { "name": "", "message": "", "data": "", "useDefaultBlockList": false, "blockedEmailAddresses": [ ] }, "enabled": true, "hidden": false, "defaultValue": "", "isSmartField": false, "unselectedLabel": "", "placeholder": "", "dependentFieldFilters": [ ], "labelHidden": false }, { "name": "lastname", "label": "Last Name", "type": "string", "fieldType": "text", "description": "", "groupName": "contactinformation", "displayOrder": -1, "required": false, "selectedOptions": [ ], "options": [ ], "validation": { "name": "", "message": "", "data": "", "useDefaultBlockList": false, "blockedEmailAddresses": [ ] }, "enabled": true, "hidden": false, "defaultValue": "", "isSmartField": false, "unselectedLabel": "", "placeholder": "", "dependentFieldFilters": [ ], "labelHidden": false } ], "default": true, "isSmartGroup": false, "richText": { "content": "" } }, { "fields": [ { "name": "email", "label": "Email", "type": "string", "fieldType": "text", "description": "", "groupName": "contactinformation", "displayOrder": -1, "required": true, "selectedOptions": [ ], "options": [ ], "validation": { "name": "email", "message": "Please enter a valid email address", "data": "", "useDefaultBlockList": false, "blockedEmailAddresses": [ ] }, "enabled": true, "hidden": false, "defaultValue": "", "isSmartField": false, "unselectedLabel": "", "placeholder": "", "dependentFieldFilters": [ ], "labelHidden": false } ], "default": true, "isSmartGroup": false, "richText": { "content": "" } } ], "createdAt": 1479855093627, "updatedAt": 1479855101085, "performableHtml": "", "migratedFrom": "", "ignoreCurrentValues": false, "metaData": [ ], "deletable": true, "inlineMessage": "", "tmsId": "", "captchaEnabled": false, "campaignGuid": "", "cloneable": true, "editable": true, "formType": "HUBSPOT" }