{"_id":"59de6011debd1200240f6927","version":"59de6011debd1200240f68ee","category":"59de6011debd1200240f68fb","__v":2,"user":"547504ed59fade080004cb8b","parentDoc":null,"project":"59de6011debd1200240f68ec","updates":["5834295b1a80690f00d31eed","58342dcc4c5f192f00c9d4cc","585293f988b5e82f00748076","5e6cbe8ffa53250050714fe0","5e6cbef639013e001887df78"],"next":{"pages":[],"description":""},"createdAt":"2016-02-19T00:12:36.851Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Fountain Connect Package Required\",\n  \"body\": \"This feature is only offered in our Fountain Connect package. Please contact your designated Fountain representative or support:::at:::fountain.com if you'd like to learn more.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"You are required to pass API tokens via the `X-ACCESS-TOKEN` request header to authenticate Fountain API requests.\\nIf you already use the `X-ACCESS-TOKEN` header to authenticate Fountain API requests, no additional action is required. Current syntax of the API token using query parameters is no longer valid.\\n\\n## Example\\n**Current GET List Applicants *(Invalid after August 5th)***\\ncurl -X GET -d 'api_token=secret-api-token&funnel_id=11111111-0000-0000-0000-000000000000&stage_id=22222222-0000-0000-0000-000000000000' 'https://api.fountain.com/v2/applicants'\\n\\n**Required GET List Applicants *(Valid now and after August 5th)***\\ncurl -X GET -H 'X-ACCESS-TOKEN: secret-api-token' -d 'funnel_id=11111111-0000-0000-0000-000000000000&stage_id=22222222-0000-0000-0000-000000000000' 'https://api.fountain.com/v2/applicants'\\n\\n\\nIf you have any additional questions about the new required API request format, please contact us at [[email protected]](mailto:[email protected]).\",\n  \"title\": \"ATTENTION\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Fountain API v2.0 Overview\"\n}\n[/block]\nFountain offers a REST API that allows you to programmatically manage your applicants. You can use these API's to automate tasks, trigger actions when changes occur, or synchronize your external systems with Fountain.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Tokens and Authentication\"\n}\n[/block]\n## Private API Key\nTo authenticate your API requests, you must pass your API Token in the `X-ACCESS-TOKEN` request header.\n\nYou can find your API Token by logging into the Fountain dashboard, clicking on your account name in the top-right corner, and selecting `Company Settings`. On the `API` page under `Developer Settings`, click the `Show API Keys` button to view your keys.\n\nIf you do not see any API settings available, please email [[email protected]](mailto:[email protected]) to request API Access.\n\n## Public API Key\n\nTo simplify data import from third-party sources, such as a web form, we offer a Public API Key. The Public API Key is only allowed to create applicants. This key cannot be used to retrieve, create, delete, or modify applicant data. This key can be shared with a third-party service to import applicants into your pipeline with no worries that sensitive data will be exposed.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Unique Identifiers\"\n}\n[/block]\nMost Fountain entities — applicants, stages, interview sessions, etc. — have a unique global identifier (UUID), sometimes referred to as just “ID”. Use this unique identifier to reference entities, such as an applicant.\n\nWe recommend storing UUIDs of Fountain entities in your database to later reference them via API. For example, saving the ID returned during applicant creation will allow you to later retrieve information or make updates to that specific applicant.","excerpt":"","slug":"overview","type":"basic","title":"Overview","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
[block:callout] { "type": "info", "title": "Fountain Connect Package Required", "body": "This feature is only offered in our Fountain Connect package. Please contact your designated Fountain representative or [email protected] if you'd like to learn more." } [/block] [block:callout] { "type": "warning", "body": "You are required to pass API tokens via the `X-ACCESS-TOKEN` request header to authenticate Fountain API requests.\nIf you already use the `X-ACCESS-TOKEN` header to authenticate Fountain API requests, no additional action is required. Current syntax of the API token using query parameters is no longer valid.\n\n## Example\n**Current GET List Applicants *(Invalid after August 5th)***\ncurl -X GET -d 'api_token=secret-api-token&funnel_id=11111111-0000-0000-0000-000000000000&stage_id=22222222-0000-0000-0000-000000000000' 'https://api.fountain.com/v2/applicants'\n\n**Required GET List Applicants *(Valid now and after August 5th)***\ncurl -X GET -H 'X-ACCESS-TOKEN: secret-api-token' -d 'funnel_id=11111111-0000-0000-0000-000000000000&stage_id=22222222-0000-0000-0000-000000000000' 'https://api.fountain.com/v2/applicants'\n\n\nIf you have any additional questions about the new required API request format, please contact us at [[email protected]](mailto:[email protected]).", "title": "ATTENTION" } [/block] [block:api-header] { "type": "basic", "title": "Fountain API v2.0 Overview" } [/block] Fountain offers a REST API that allows you to programmatically manage your applicants. You can use these API's to automate tasks, trigger actions when changes occur, or synchronize your external systems with Fountain. [block:api-header] { "type": "basic", "title": "Tokens and Authentication" } [/block] ## Private API Key To authenticate your API requests, you must pass your API Token in the `X-ACCESS-TOKEN` request header. You can find your API Token by logging into the Fountain dashboard, clicking on your account name in the top-right corner, and selecting `Company Settings`. On the `API` page under `Developer Settings`, click the `Show API Keys` button to view your keys. If you do not see any API settings available, please email [[email protected]](mailto:[email protected]) to request API Access. ## Public API Key To simplify data import from third-party sources, such as a web form, we offer a Public API Key. The Public API Key is only allowed to create applicants. This key cannot be used to retrieve, create, delete, or modify applicant data. This key can be shared with a third-party service to import applicants into your pipeline with no worries that sensitive data will be exposed. [block:api-header] { "type": "basic", "title": "Unique Identifiers" } [/block] Most Fountain entities — applicants, stages, interview sessions, etc. — have a unique global identifier (UUID), sometimes referred to as just “ID”. Use this unique identifier to reference entities, such as an applicant. We recommend storing UUIDs of Fountain entities in your database to later reference them via API. For example, saving the ID returned during applicant creation will allow you to later retrieve information or make updates to that specific applicant.