{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/exports/templates","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n  \"templates\": [\n    {\n      \"id\": \"540eff78-4f0d-438a-99ff-36b888cd6fb6\",\n      \"title\": \"test exp\",\n      \"fields\": [\n        \"email\",\n        \"phone_number\"\n      ],\n      \"funnel_ids\": [\n        \"56525182-ed3e-4e40-81ac-5e777a66f872\",\n        \"25b2f225-47eb-400a-96c8-4fee881cb602\",\n        \"0c915f5c-2379-49eb-bbcc-db6c68c88afa\"\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"first\": 1,\n    \"previous\": null,\n    \"current\": 1,\n    \"next\": null,\n    \"last\": 1\n  }\n}","language":"json","status":200}]},"params":[{"name":"api_token","type":"string","default":"secret-api-token","desc":"API Token (not required if passed in header)","required":false,"in":"query","ref":"","_id":"5ebf0a664a72b2002b7e006a"}],"examples":{"codes":[{"code":"curl -X GET -d 'api_token=secret-api-token' 'https://api.fountain.com/v2/exports/templates'","language":"curl"},{"code":"https://www.onboardiq.com/api/v2/exports/templates?api_token=secret-api-token","language":"text"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"List Custom Export Templates","type":"endpoint","slug":"list-custom-export-templates","excerpt":"","body":"# List Custom Export Templates\n\nLists all custom export templates in the account.\n\nTemplate data includes which data keys are used and the Openings (funnels) applicants are being pulled from for each export.\n\nUse the page parameter to indicate the page for pagination, e.g. &page=2 to get to the 2nd page of the listing.\n\n# Response Schema\n\n*   templates\n    *   Required: no\n    *   Type: array\n    *   Items\n        *   Required: no\n        *   id\n            *   Required: no\n            *   Type: string\n            *   Example: \"540eff78-4f0d-438a-99ff-36b888cd6fb6\"\n        *   title\n            *   Required: no\n            *   Type: string\n            *   Example: \"test exp\"\n        *   fields\n            *   Required: no\n            *   Type: array\n            *   Items\n                *   Required: no\n                *   Type: string\n                *   Example: \"email\", \"phone_number\"\n        *   funnel_ids\n            *   Required: no\n            *   Type: array\n            *   Items\n                *   Required: no\n                *   id\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"56525182-ed3e-4e40-81ac-5e777a66f872\"\n*   pagination\n    *   Required: no\n    *   first\n        *   Required: no\n        *   Type: integer\n        *   Example: 1\n    *   previous\n        *   Required: no\n        *   Type: null\n        *   Example: null\n    *   current\n        *   Required: no\n        *   Type: integer\n        *   Example: 1\n    *   next\n        *   Required: no\n        *   Type: null\n        *   Example: null\n    *   last\n        *   Required: no\n        *   Type: integer\n        *   Example: 1","updates":[],"order":999,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ebf0a664a72b2002b7e0069","createdAt":"2020-05-15T21:32:22.969Z","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":0}

getList Custom Export Templates


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

api_token:
stringsecret-api-token
API Token (not required if passed in header)

Examples


Result Format


Documentation

# List Custom Export Templates Lists all custom export templates in the account. Template data includes which data keys are used and the Openings (funnels) applicants are being pulled from for each export. Use the page parameter to indicate the page for pagination, e.g. &page=2 to get to the 2nd page of the listing. # Response Schema * templates * Required: no * Type: array * Items * Required: no * id * Required: no * Type: string * Example: "540eff78-4f0d-438a-99ff-36b888cd6fb6" * title * Required: no * Type: string * Example: "test exp" * fields * Required: no * Type: array * Items * Required: no * Type: string * Example: "email", "phone_number" * funnel_ids * Required: no * Type: array * Items * Required: no * id * Required: no * Type: string * Example: "56525182-ed3e-4e40-81ac-5e777a66f872" * pagination * Required: no * first * Required: no * Type: integer * Example: 1 * previous * Required: no * Type: null * Example: null * current * Required: no * Type: integer * Example: 1 * next * Required: no * Type: null * Example: null * last * Required: no * Type: integer * Example: 1

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 }}