For AI agents: the docs index is at https://developer.fountain.com/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

API Reference

Log In

API Reference

Log In

API Reference

Fountain API Documentation

Fountain API Overview

Hire Documentation

Hire API Overview
Hire Webhooks
Rate Limits
Frequently Asked Questions
API Deprecations
Tenant API URLs

Hire API Use Cases

Custom Integrations
Slack Integration
Sync with your HRIS
Connecting a Custom Form

Hire Public API

Applicants
exposeAsMcpTool
Labels
Notes
transitions
- List Archived Reasonsget
- List Rejection Reasonsget
Calendar Slots
Company Attributes
Data Keys
- List data keysget
Export Management
Openings and Stages
Hiring Goals
Locations and Location Groups
Openings
- Reassign Opening to Different Workflow (Alpha)post
- Assign or remove Company Attributes from an Openingpost
Option Bank
Positions
Roles
- List user rolesget
Shifts
- List shiftsget
Users
Webhook Settings
Posthire Worker Management
Workflows
- List all Workflowsget
- Delete a Workflowdel

Worker Experience Documentation

Webhooks and External API Calls
Embedding the Worker Portal
Partner Tasks
API Deprecations

Worker Experience Public API

workers
attributeSections
jobs
customAttributes
locations
locationGroups
locationGroupTrees
audienceLocations
audienceJobs
location-groups
- Update a location group and replace its Company Attributes with the payloadpatch
- Create a location group and replace its Company Attributes with the payloadpost
audienceOpenings
openings
employers
brands
companies
companyAttributes
companyAttributeSets
staff-employers
- Delete an employer with slot reassignmentdel
eins
copilotAuditLogs
demoDataCollections
users
- Retrieve a short-lived authenticated URL for a worker's portalget
apikeys
opensignups
papi
- One stop setup for PAPIpost
jwks
- get JSON Web Key Setget
storedFiles
signDocs
signatureRequests
- Retrieve a link or download files linked to a signatureRequest documentget
- Return the attachment of a signatureRequest as a bufferget
taskFlows
tasks
assignedTasks
w4Profiles
yardstik
- Query Yardstik for the full list of account packages associated with the account defined by the API keyget
partner
- Retrieve an assigned partner taskget
- Add a new partner event to an assigned partner taskpost
todo-workers
processes-dashboard-pending-tasks
- Get dashboard pending tasks summaryget
notificationQueue
universalDashboard
documentTypes
documentSubmissions
requirements
workerComplianceProfiles
participants
onboardProviders
questionBanks
surveys
themes
defaultNotificationTemplates
pulseSettings
incentives
- List referral incentivesget
- Mark a referral incentive as paidpatch
referralCampaigns
referralSettings
- Initialize referral settingpost
- Get referral setting by company UUID (public)get
attendanceActivityLog
attendancePolicies
- Find attendance policy for a given locationget
- Find attendance policy for a given location groupget
allowances
- Create an allowance and associate it with a locationpost
- Delete one or more allowancespost
shifts
i9Profiles
timeOff
timesheets
workerRequests
demands
shiftTags
allowanceSettings
automaticBreakSettings
automaticBreakRules
- Create an automatic break rule and associate it with a locationpost
- Delete one or more automatic break rulespost
holidayRules
holidayRuleSettings
generalSettings
workerRequestRules
- Create a worker request rule and associate it with a location or location grouppost
- Delete one or more worker request rulespost
timesheetFlagRules
- Create a timesheet flag rule and associate it with a location or location grouppost
- Delete one or more timesheet flag rulespost
workbright
hirePapi
workerNotificationSettings
employmentProfiles
tags
demand
- Creates bulk demand for a given periodpost
- Creates shifts for a specific demand or list of demandspost
audienceCampaign
shifts
- Delete multiple shiftsdel
- Publish multiple shiftspost
users
- Retrieve a short-lived authenticated URL for a worker's portalget
viewEmploymentProfiles
viewEmploymentProfilesI9
viewEmploymentProfilesW4
logNotes
employerNotes
i9center
- One stop setup for I9Center V2post
dataPipelines
dataPipelineMappings
dataPipelineEvents
talent
unifiedJobs
audiences

exposeAsMcpTool

Updated about 1 year ago

GDPR-anonymize an Applicant, clearing selected data keys

Labels

Did this page help you?

Updated about 1 year ago

GDPR-anonymize an Applicant, clearing selected data keys

Labels

Did this page help you?