Fountain offers a REST API that allows you to programmatically manage your applicants. You can use these APIs to automate tasks, trigger actions when changes occur, or synchronize your external systems with Fountain.
This feature is only offered in certain Fountain packages. Please contact your designated Fountain representative or [email protected] if you'd like to learn more about this capability, and enable it in your account.
Please view our Developer API Documentation to view all of our API features and more in-depth technical tutorials on implementing APIs.
Private and Public API Key
To view your API token from Fountain, follow the steps below:
Click your initials in the top right corner of any Fountain page. Then click on Company Settings in the dropdown.
Under Developer Settings in the left side panel, click API.
Click Show API Key to view your keys.
API Features
Below is a list of API features. For more API features, review the Fountain Developer Docs.
Applicant Management
Notes Management
Session and Slot Management
Positions and Stages
Export Management
Worker Management
Option Bank
Users
Common API Questions
Find an applicant by email: GET /v2/applicants?email=<email> returns the applicants whose email matches exactly. GET /v2/applicants/latest_applicant?email=<email> (or ?phone_number=<phone>) returns the most recent match with full details.
Applicant secure documents: GET /v2/applicants/{id}/secure_documents needs secure-data access on your account. Fountain turns it on for you: contact your CSM or [email protected]. Once a document is approved, the response includes approved_at and who approved it.
Read-only keys: There is no read-only API key. A Private key has full read and write access. A Trusted Party key can only create applicants. Keep Private keys out of shared tools.
Assessment PDFs: Fountain does not email applicants their assessment report. The PDF link is in the assessments[].file_url field of GET /v2/applicants/{id}, so you can build that email in your own tool.
Secure file download links: A secure file download link lasts 24 hours at most. Request a new link after that.
Document Deletion Is Not API-Supported
The API can upload, link, and approve applicant documents, but it does not include an endpoint for deleting them. To permanently remove documents, contact Fountain at [email protected] to request the compliance-based deletion process.