{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/exports/:id","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\"created_at\":\"2020-04-15T11:24:27.585-07:00\",\n \"updated_at\":\"2020-04-15T11:24:35.052-07:00\",\n \"status\":\"finished\",\n \"file_url\":\"https://fountain-uploads.s3-us-west-1.amazonaws.com/uploads/export/file/101023/export_10102320200415-3-82so6k.csv?X-Amz-Expires=604800&X-Amz-Date=20200415T182458Z&XAmz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJQOABKUE66R2SJPQ/20200415/us-west-1/s3/aws4_request&X-Amz-SignedHeaders=host&XZ-Amz-Signature=96efe92999cea704c88ca46a4771de4212c86a000000708eb80585d287dc5794\",\n \"id\":\"791862a4-000a-4b46-954f-47a2b7d2bd07\",\n \"template\": {\n   \"title\":\"Applicants\",\n   \"id\":\"675eaaa6-b7d0-459f-1117b-01a877ec1473\"\n }","language":"json","status":200}]},"params":[{"name":"id","type":"string","default":"550e8400-e29b-41d4-a716-446655441111","desc":"The id of the custom export that's returned in the 'Create Custom Export' response.","required":false,"in":"path","ref":"","_id":"5e9a3154d3c36f0057d07446"},{"name":"api_token","type":"string","default":"secret-api-token","desc":"Required if api_token is not passed in header","required":false,"in":"query","ref":"","_id":"5ea0fc7811af9c0018e7984e"}],"examples":{"codes":[{"code":"curl -X GET -d 'api_token=secret_api_token' 'https://api.fountain.com/v2/exports/791862a4-4bca-4b46-954f-47a2b111bd07'","language":"curl"},{"code":"https://www.onboardiq.com/api/v2/exports/550e8400-e29b-41d4-a716-446655440000?api_token=secret-api-token","language":"text"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Download Custom Export","type":"endpoint","slug":"download-custom-export","excerpt":"","body":"## Download a custom export\nDownload an export that you've created specified by `id`. Obtain an `id` from [Create Custom Export](doc:create-custom-export).\n\nThe `file_url` will return an HTTP 404 until `state` is `finished`. You may decide to poll this endpoint until the file is ready.\n\n`file_url` will expire 1 week from creation. This is to ensure that your exports are up to date.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"`id` refers to the id of this export, whereas `template_id` refers to the source template. You'll use `id` to GET the export that you've created.\",\n  \"title\": \"NOTE: id vs. template_id\"\n}\n[/block]\n## Response Schema\n\n* **created_at**\n     * Required: no\n     * Type: string\n     * Format: date-time\n     * Example: \"2020-04-15T11:24:27.585-07:00\"\n* **updated_at**\n     * Required: no\n     * Type: string\n     * Format: date-time\n     * Example: \"2020-04-15T11:24:35.052-07:00\"\n* **status**\n     * Required: no\n     * Type: string\n     * Example: \"finished\"\n* **file_url**\n     * Required: no\n     * Type: string\n     * Example: \"https://fountain-uploads.s3-us-west-1.amazonaws.com/uploads/export/file/101023/export_10102320200415-3-82so6k.csv?X-Amz-Expires=604800&X-Amz-Date=20200415T182458Z&XAmz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJQOABKUE66R2SJPQ/20200415/us-west-1/s3/aws4_request&X-Amz-SignedHeaders=host&XZ-Amz-Signature=96efe92999cea704c88ca46a4771de4212c86a000000708eb80585d287dc5794\"\n* **id**\n     * Required: no\n     * Type: string\n     * Example: \"791862a4-000a-4b46-954f-47a2b7d2bd07\"\n* **template**\n     * Required: no\n     * additionalProperties: false\n     * **title**\n          * Required: no\n          * Type: string\n          * Example: \"Applicants\"\n * **id**\n          * Required: no\n          * Type: string\n          * Example: \"675eaaa6-b7d0-459f-1117b-01a877ec1473\"","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e9a3154d3c36f0057d07444","createdAt":"2020-04-17T22:44:36.577Z","user":"547504ed59fade080004cb8b","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Export Management","slug":"exports","order":8,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68f9","__v":0,"project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","createdAt":"2016-05-24T19:12:00.251Z"},"version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"project":"59de6011debd1200240f68ec","__v":1,"parentDoc":null}

getDownload Custom Export


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string550e8400-e29b-41d4-a716-446655441111
The id of the custom export that's returned in the 'Create Custom Export' response.

Query Params

api_token:
stringsecret-api-token
Required if api_token is not passed in header

Examples


Result Format


Documentation

## Download a custom export Download an export that you've created specified by `id`. Obtain an `id` from [Create Custom Export](doc:create-custom-export). The `file_url` will return an HTTP 404 until `state` is `finished`. You may decide to poll this endpoint until the file is ready. `file_url` will expire 1 week from creation. This is to ensure that your exports are up to date. [block:callout] { "type": "warning", "body": "`id` refers to the id of this export, whereas `template_id` refers to the source template. You'll use `id` to GET the export that you've created.", "title": "NOTE: id vs. template_id" } [/block] ## Response Schema * **created_at** * Required: no * Type: string * Format: date-time * Example: "2020-04-15T11:24:27.585-07:00" * **updated_at** * Required: no * Type: string * Format: date-time * Example: "2020-04-15T11:24:35.052-07:00" * **status** * Required: no * Type: string * Example: "finished" * **file_url** * Required: no * Type: string * Example: "https://fountain-uploads.s3-us-west-1.amazonaws.com/uploads/export/file/101023/export_10102320200415-3-82so6k.csv?X-Amz-Expires=604800&X-Amz-Date=20200415T182458Z&XAmz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJQOABKUE66R2SJPQ/20200415/us-west-1/s3/aws4_request&X-Amz-SignedHeaders=host&XZ-Amz-Signature=96efe92999cea704c88ca46a4771de4212c86a000000708eb80585d287dc5794" * **id** * Required: no * Type: string * Example: "791862a4-000a-4b46-954f-47a2b7d2bd07" * **template** * Required: no * additionalProperties: false * **title** * Required: no * Type: string * Example: "Applicants" * **id** * Required: no * Type: string * Example: "675eaaa6-b7d0-459f-1117b-01a877ec1473"

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}