POST GET exports/getFile
Get file generated from an export
* required
Parameters
Name | Type | Description |
---|---|---|
fileKey * | guid | Unique ID used to retrieve file |
Response Data
Zip file (content type: application/zip) returned as a binary. Be sure your HTTP library processes this request as binary! The zip file will contain a single flat file that is a plain text dump of the export data.
Permissions
Method requires the Client admin permission
Example Calls
General steps involved in retrieving files
- Make API call to retrieve file
- Process binary response from API
- Save zip file to local file system
- Unzip flat file to local file system
- Process flat file containing exported data
- Clean up files on local file system (as needed)
Get file using fileKey
Response is binary of a zip file
GET
/exports/getFile?fileKey=2500FAD3-C075-7951-D8F9-0CCD77628FFD
cURL
Copy
Export file format
The zip file will contain a single flat file with a content type of text/plain. The flat file's name will use the format {{fileKey}}.csv
File Format | ||
---|---|---|
Column Delimiter | Tab (\t) | |
Row Delimiter | Carriage Return + Line Feed (\r\n) | |
Text Qualifier |
Double Quote. If a double quote occurs IN the data itself, it will be escaped with two double quotes: |
Sample Export
"firstName" "lastName" "email" "John" "Doe" "john.doe@example.com" "Jane" "Doe" "jane.doe@example.com"
API Console
The console uses production data, so BE CAREFUL!
GET
exports/getFile
Sorry, the console is unavailable for this endpoint.