Fountain Connect Package Required
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.
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.
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] to request API Access.
To simplify data import from third-party sources, we offer a Trusted Party API Key. The Trusted Party 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 trusted third-party service to import applicants into your pipeline with no worries that sensitive data will be exposed.
Requests using the Trusted Party API Key should only come from server-side requests so as to hide the Trusted Party API Key from malicious entities which could otherwise obtain the key from client-side assets. Failure to do so could lead to exposure of the Trusted Party API Key and spam creation of applicants.
Note: The Trusted Party API Key is subject to the same rate limiting as the private API Key.
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.