{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/exports","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n  \"created_at\":\"2020-04-15T11:24:27.585-07:00\",\n  \"updated_at\":\"2020-04-15T11:24:27.585-07:00\",\n  \"status\":\"new\",\n  \"file_url\":null,\n  \"id\":\"791862a4-4bca-4b46-555f-47a2b7d2bd07\",\n  \"template\":{\n    \"title\":\"Applicants\",\n    \"id\":\"675eaaa6-b7d0-567f-857b-01a877ec1473\"\n  }","language":"json","status":200}]},"params":[{"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":"5ea0fce2cf2279002e280fa6"},{"name":"template_id","type":"string","default":"675eaaa6-b7d0-567f-857b-01a865ec1329","desc":"ID of the source template for this export","required":true,"in":"query","ref":"","_id":"5ea0fd5f1e84b2006045fe4a"},{"name":"output","type":"string","default":"csv","desc":"Export format (\"csv\" or \"xlsx\")","required":false,"in":"query","ref":"","_id":"5ea0fd5f1e84b2006045fe49"}],"examples":{"codes":[{"code":"curl -X POST -H 'Content-Type: application/json' -d '{\"api_token\":\"secret_api_token\",\"template_id\":\"675eaaa6-b7d0-567f-857b-01a877ec1473\", \"output\":\"csv\"}' 'https://api.fountain.com/v2/exports'","language":"curl"},{"code":"https://www.onboardiq.com/api/v2/exports?api_token=secret-api-token&template_id=040560d0-ae53-4b34-989e-004cc7aaba1b","language":"text"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Create Custom Export","type":"endpoint","slug":"create-custom-export","excerpt":"","body":"# Create custom exports\nCreate a custom export based on the given template_id. To find a template_id, use List Export Templates.\n\nThe 'file_url' will expire 1 week from creation - this is to ensure your exports are up to date!\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"NOTE: id vs. template_id\",\n  \"body\": \"The 'id' refers to the id of this export, whereas the 'template_id' refers to the source template. You'll use the make sure to use 'id' to GET the export that you've created.\"\n}\n[/block]\n# Response Schema\n\n*   id\n    *   Required: no\n    *   Type: string\n    *   Example: \"00afbcf2-fb20-4f75-941b-eda1b7512efa\"\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:27.585-07:00\"\n*   status\n    *   Required: no\n    *   Type: string\n    *   Example: \"new\"\n*   template\n    *   Required: no\n    *   id\n        *   Required: no\n        *   Type: string\n        *   Example: \"675eaaa6-b7d0-567f-857b-01a877ec1473\"\n    *   title\n        *   Required: no\n        *   Type: string\n        *   Example: \"Applicants\"","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e9773321b1fdd03a6cdd4d2","createdAt":"2020-04-15T20:48:50.444Z","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":16,"parentDoc":null}

postCreate Custom Export


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

api_token:
stringsecret-api-token
Required if api_token is not passed in header
template_id:
required
string675eaaa6-b7d0-567f-857b-01a865ec1329
ID of the source template for this export
output:
stringcsv
Export format ("csv" or "xlsx")

Examples


Result Format


Documentation

# Create custom exports Create a custom export based on the given template_id. To find a template_id, use List Export Templates. The 'file_url' will expire 1 week from creation - this is to ensure your exports are up to date! [block:callout] { "type": "warning", "title": "NOTE: id vs. template_id", "body": "The 'id' refers to the id of this export, whereas the 'template_id' refers to the source template. You'll use the make sure to use 'id' to GET the export that you've created." } [/block] # Response Schema * id * Required: no * Type: string * Example: "00afbcf2-fb20-4f75-941b-eda1b7512efa" * 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:27.585-07:00" * status * Required: no * Type: string * Example: "new" * template * Required: no * id * Required: no * Type: string * Example: "675eaaa6-b7d0-567f-857b-01a877ec1473" * title * Required: no * Type: string * Example: "Applicants"

User Information

Try It Out

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