{"_id":"59de6011debd1200240f6927","version":"59de6011debd1200240f68ee","category":"59de6011debd1200240f68fb","__v":0,"user":"547504ed59fade080004cb8b","parentDoc":null,"project":"59de6011debd1200240f68ec","updates":["5834295b1a80690f00d31eed","58342dcc4c5f192f00c9d4cc","585293f988b5e82f00748076"],"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: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\nYou can find your API token by logging into the Fountain dashboard, click on your account name in the top-right corner, and selecting `Company Settings`. On the `API` page, click the `Show API Key` button to view your keys.\n\nThere are two ways to pass your API token to the API endpoints. You may pass the token in the `X-ACCESS-TOKEN` request header, or in the `api_token` body parameter.\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 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\nNote that the private API key can also create applicants.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Unique Identifiers\"\n}\n[/block]\nMost Fountain entities — applicants, stages, slots — 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","childrenPages":[]}
[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 You can find your API token by logging into the Fountain dashboard, click on your account name in the top-right corner, and selecting `Company Settings`. On the `API` page, click the `Show API Key` button to view your keys. There are two ways to pass your API token to the API endpoints. You may pass the token in the `X-ACCESS-TOKEN` request header, or in the `api_token` body parameter. ## 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 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. Note that the private API key can also create applicants. [block:api-header] { "type": "basic", "title": "Unique Identifiers" } [/block] Most Fountain entities — applicants, stages, slots — 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.