# API

Access your Fountain API keys and leverage REST API capabilities to programmatically manage candidate and account data.

Updated this week

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 [support@fountain.com](mailto:support@fountain.com) if you'd like to learn more about this capability, and enable it in your account.

Please view our [Developer API Documentation](https://developer.fountain.com/docs/overview) 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:

1. Click your initials in the top right corner of any Fountain page. Then click on **Company Settings** in the dropdown.
2. Under Developer Settings in the left side panel, click **API**.
3. 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](https://developer.fountain.com/reference/overview).

**Applicant Management**

- [List Applicants](https://developer.fountain.com/reference/get_v2-applicants)
- [Create an Applicant](https://developer.fountain.com/reference/post_v2-applicants)
- [Delete an Applicant](https://developer.fountain.com/reference/delete_v2-applicants-id)
- [Get Applicant Info](https://developer.fountain.com/reference/get_v2-applicants-id)
- [Update Applicant Info](https://developer.fountain.com/reference/put_v2-applicants-id)
- [Get Applicant Documents](https://developer.fountain.com/reference/get_v2-applicants-id-secure-documents)
- [Advance an Applicant](https://developer.fountain.com/reference/put_v2-applicants-id-advance)
- [Get Interview Sessions](https://developer.fountain.com/reference/get_v2-applicants-id-booked-slots)
- [Get Transition History](https://developer.fountain.com/reference/get_v2-applicants-id-transitions)

**Notes Management**

- [List Notes for Applicant](https://developer.fountain.com/reference/get_v2-applicants-id-notes)
- [Create a Note for Applicant](https://developer.fountain.com/reference/post_v2-applicants-id-notes)
- [Delete Applicant Note](https://developer.fountain.com/reference/delete_v2-applicants-id-notes-note-id)
- [Update Applicant Note](https://developer.fountain.com/reference/put_v2-applicants-id-notes-note-id)

**Session and Slot Management**

- [Create Slots](https://developer.fountain.com/reference/post_v2-available-slots)
- [List Available Slots](https://developer.fountain.com/reference/get_v2-sessions)
- [Delete Slots](https://developer.fountain.com/reference/delete_v2-available-slots-id)
- [Book an Available Slot](https://developer.fountain.com/reference/post_v2-available-slots-id-confirm)
- [List Available Slots](https://developer.fountain.com/reference/get_v2-stages-id-available-slots)
- [Cancel Booked Session](https://developer.fountain.com/reference/post_v2-booked-slots-id-cancel)
- [Delete Slots](https://developer.fountain.com/reference/delete_v2-available-slots-id)

**Positions and Stages**

- [List All Openings](https://developer.fountain.com/reference/get_v2-funnels)
- [Update Opening](https://developer.fountain.com/reference/put_v2-funnels-id)
- [List All Stages](https://developer.fountain.com/reference/get_v2-funnels-funnel-id-stages)
- [Retrieve Stages](https://developer.fountain.com/reference/get_v2-stages-id)

**Export Management**

- [Create Timestamped Export](https://developer.fountain.com/reference/post_v2-timestamped-exports)
- [Download Timestamped Export](https://developer.fountain.com/reference/get_v2-timestamped-exports-id)
- [List Timestamped Export Templates](https://developer.fountain.com/reference/get_v2-timestamped-exports-templates)

**Worker Management**

- [List Workers](https://developer.fountain.com/reference/get_v2-workers)
- [Get Worker Info](https://developer.fountain.com/reference/get_v2-workers-id)
- [Update Worker Info](https://developer.fountain.com/reference/patch_v2-workers-id)

**Option Bank**

- [List All Option Banks](https://developer.fountain.com/reference/get_v2-option-banks)
- [Create Option Bank](https://developer.fountain.com/reference/post_v2-option-banks)
- [Replace Option Bank](https://developer.fountain.com/reference/put_v2-option-banks-id)
- [Append to Option Bank](https://developer.fountain.com/reference/put_v2-option-banks-id-append)
- [Remove from Option Bank](https://developer.fountain.com/reference/delete_v2-option-banks-id-remove)
- [Delete Option Bank](https://developer.fountain.com/reference/delete_v2-option-banks-id)

**Users**

- [List all Users](https://developer.fountain.com/reference/get_v2-users)
- [List User Activities](https://developer.fountain.com/reference/get_v2-user-activities-id)

**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 [support@fountain.com](mailto:support@fountain.com) to request the compliance-based deletion process.