developer-fountain-com/
596 pages · Updated July 26, 2026
Pages
- Fountain API Overview
- Create User
- Create a new Location
- Link Applicant to Files in S3
- Update opening
- Update User
- Retrieve Webhook Setting
- Update A Worker
- Create Webhook Setting
- Get Worker Info
- Delete Option Bank
- Delete Webhook Setting
- List Workers
- Get Option Bank
- Create a new Position
- Get Users
- Update Position
- List User Activities
- change user opening access
- Assign Company Attributes to Location
- List All Openings
- List Hiring Goals
- Update Location
- Assign or remove Company Attributes from an Opening
- Delete a Location
- Remove from Option Bank
- File Upload to S3
- Assign Company Attributes to Position
- Send SMS Message
- Update Location Group
- Delete a Position
- List shifts
- Append to Option Bank
- List All Opening Stages
- Create Option Bank
- Retrieve Location
- Retrieve Opening
- Delete a Location Group
- List Positions
- Delete a Hiring Goal
- List All Option Banks
- Retrieve stage
- Assign Company Attributes to Hiring Goals
- Create a new hiring goal
- Create a new Location Group
- List Locations
- Update Hiring Goal
- Retrieve Location Group
- List Calendar Slots
- Download Timestamped Export
- Create Timestamped Export
- List Rejection Reasons
- Delete an opening
- Create Custom Export
- Add values to a company attribute
- List Location Groups
- Request an async PDF print of an applicant
- Delete Calendar Slots
- List Timestamped Export Templates
- Update Applicant Note
- List All Timestamped Export Templates
- List company attributes
- List data keys
- Create company attribute
- GDPR-anonymize an Applicant, preserving selected data keys
- List Available Slots
- Trigger file recollection for an applicant
- Update Calendar Slot
- Book an Available Slot
- Poll an async print request for its PDF
- Create Applicant Note
- List Custom Export Templates
- Create Calendar Slots
- Send Document Rejection Notification
- Update Label for Applicant
- exposeAsMcpTool
- Delete Applicant Note
- Notify applicant
- Get Applicant Files
- Get Applicant SMS Messages
- Bulk Interview Sessions for Multiple Applicants
- GDPR-anonymize an Applicant
- List Archived Reasons
- duplicate applicants
- Upload File and Link to Applicant
- List Labels for Applicant
- Get Applicant Notes
- Approve Applicant Documents
- Bulk Transition History for Multiple Applicants
- Get Latest Applicant
- Get Interview Sessions
- Get Transition History
- Create a worker request rule and associate it with a location or location group
- Update one or multiple talent
- Create a timesheet flag rule and associate it with a location or location group
- Get audience campaigns for a talent
- Create one or multiple unified jobs
- Creates bulk demand for a given period
- Delete one or more timesheet flag rules
- One stop setup for I9Center V2
- Get partner status with partnerStatus
- find many openings
- count shiftTags
- Delete multiple shifts
- /api/serviceattendance/processes/shifts/{shiftUuid}
- Update audience via Copilot
- Publish multiple shifts
- find many attendanceActivityLogs
- find one opening
- Find and update a talent
- find one attendanceActivityLog
- Count audience campaigns the talent has ever been part of (filterable)
- Find and update a unified job
- count openings
- create one or multiple shifts
- Get dashboard pending tasks summary
- Count holiday rule settings for a given location
- Creates shifts for a specific demand or list of demands
- Create audiences via Copilot
- Retrieve a short-lived authenticated URL for a worker's portal
- count attendanceActivityLogs
- Update shifts, validated by rules. Fails with a 409 if there are any blockers. Note: When adding breaks use v4 uuid.
- /api/serviceattendance/processes/shifts/{locationUuid}/publish
- Find and update an audience
- Per-day entrance / exit counts for an audience inside the resolved [from, to] window
- Publish an individual shift
- Api endpoint to get workers by start date
- find many shifts
- Get worker task flows
- Get counts of workers with tasks in different statuses
- find one shift
- workbright
- Retrieve a unified job by its unique identifier
- Create one or multiple audiences
- audienceCampaign
- fetch list of active campaigns for a given audience
- Delete a unified job
- fetch list of talent
- Get audience history grouped by audience for a talent
- Restart a profile submission(s)
- Retrieve an audience by its unique identifier
- count shifts
- Count audiences in a talent history (filterable by lastEventType)
- Find unifiedJobs matches for a given talent based on aggregate vector match
- Count talent
- Fetch a count of audiences
- create one or multiple employerNotes
- find one employerNote
- find many viewEmploymentProfilesI9
- fetch list of audiences
- Count unifiedJobs
- find many logNotes
- find many viewEmploymentProfilesW4
- fetch list of unified jobs
- find many employerNotes
- count employerNotes
- Retrieve a submission file
- Retrieve a talent by its unique identifier
- hirePapi
- Fetch all template attributes available for talents
- count viewEmploymentProfilesW4
- Retrieve a submission file
- find one viewEmploymentProfileW4
- find one logNote
- find many viewEmploymentProfiles
- find one viewEmploymentProfileI9
- Sync viewEmploymentProfile and Partner resources for a given worker
- count logNotes
- partially update one existing employmentProfile
- Returns exported headers, rows, filename for timesheets. Specify target timesheets by uuid or by filter
- delete many tags
- create one or multiple tags
- count tags
- partially update many existing tag
- count viewEmploymentProfilesI9
- find one viewEmploymentProfile
- delete one tag
- Rehire a profile submission(s)
- find one survey
- count viewEmploymentProfiles
- partially update one existing tag
- find one employmentProfile
- Set the disabled flag for a worker case and emit activity events
- find many tags
- find one tag
- Update allowed properties for an employment profile
- count employmentProfiles
- Delete one or more worker request rules
- Create a holiday rule and associate it with a location
- find one generalSetting
- partially update many existing employmentProfile
- create one or multiple timesheets
- Clone automatic break settings with automatic break rules
- count generalSettings
- Create an automatic break rule and associate it with a location
- find many employmentProfiles
- Clone holiday rule settings
- Find allowance settings for a given location group
- /api/serviceattendance/processes/generalSettings
- Update holiday rule(s) and invalidate overlapping schedules for re-evaluation
- Clone allowance settings with allowances
- Count holiday rule settings for a given location group
- Get active holiday rules for specified locations within a date range
- delete one pulseSettings
- Delete holiday rule settings and re-evaluate workers for inheritance
- find many generalSettings
- Find holiday rule settings for a given location
- Find holiday rule settings for a given location group
- partially update one existing timesheet
- /api/serviceattendance/processes/timesheets/{timesheetUuid}/addClockEvent
- partially update one existing shiftTag
- Count allowance for a given location
- Count allowance for a given location group
- Delete one or more automatic break rules
- Count automatic break rules for a given location
- find many demands
- Find and update a documentSubmission
- Find automatic break settings for a given location group
- Delete one or more holiday rules
- partially update many existing shiftTag
- i9Profiles
- find many shiftTags
- find many timesheets
- delete many shiftTags
- count timesheets
- create one or multiple shiftTags
- Initialize referral setting
- find one shiftTag
- Count automatic break rules for a given location group
- find one demand
- Returns exported headers, rows, filename for timesheets. Specify target timesheets by uuid or by filter
- find many workerRequests
- replace many referralCampaigns which exists or not
- find one workerRequest
- count workerRequests
- partially update many existing timesheet
- Marks a timesheet as deleted and cancels scheduled events
- find one timesheet
- Create an allowance and associate it with a location
- /api/serviceattendance/processes/timeOff
- /api/serviceattendance/processes/timeOff/{timeOffUuid}
- count demands
- find many timeOff
- find one timeOff
- Process a referral campaign request
- replace one referralCampaign which exists or not
- Find attendance policy for a given location
- Delete one or more allowances
- Delete time-off
- delete one shiftTag
- Get referral setting by company UUID (public)
- count timeOff
- partially update one existing referralCampaign
- Find attendance policy for a given location group
- partially update many existing referralCampaign
- partially update one existing pulseSettings
- create one or multiple defaultNotificationTemplates
- create one or multiple surveys
- find one referralCampaign
- find many pulseSettings
- find many referralCampaigns
- Create one or multiple documentTypes
- create one or multiple pulseSettings
- onboardProviders
- Create one documentSubmission
- delete many pulseSettings
- partially update one existing defaultNotificationTemplate
- Find and update a requirement
- partially update many existing pulseSettings
- count pulseSettings
- find one pulseSettings
- find one defaultNotificationTemplate
- delete many defaultNotificationTemplates
- partially update one existing theme
- find many defaultNotificationTemplates
- partially update many existing survey
- partially update many existing defaultNotificationTemplate
- delete many themes
- delete one defaultNotificationTemplate
- Create one or multiple documentTypes simplified
- create one or multiple themes
- delete one theme
- Provides a list of schedule events for the current employer user
- partially update many existing theme
- create one or multiple questionBanks
- find one theme
- delete many surveys
- List workerComplianceProfiles
- Retrieve a documentSubmission by its unique identifier
- partially update many existing questionBank
- Provides a list of openings for a current employer user
- count questionBanks
- find one participant
- Search workerComplianceProfiles (Atlas Search)
- Create one or multiple requirements
- Retrieve a short-lived authenticated URL for a worker's portal
- count surveys
- delete one survey
- Retrieve the workerComplianceProfile for an authenticated worker
- partially update one existing questionBank
- count participants
- Provides the opening approvals task metric for the current employer user
- find many participants
- delete many questionBanks
- fetch list of documentSubmissions
- delete one questionBank
- Provides the review files task metric for the current employer user
- List requirements
- Provides the new applicants metric for the current employer user
- Provides the applicants pipeline metric for the current employer user
- Retreive a requirement by its unique identifier
- Provides the respond to messages task metric for the current employer user
- Retreive a workerComplianceProfile by its unique identifier
- Provides the mark attendance task metric for the current employer user
- Retreive a documentType by its unique identifier
- Provides the review applicants task metric for the current employer user
- Add a new partner event to an assigned partner task
- fetch list of documentTypes
- Reprocess worker onboarding
- partially update many existing task
- retrigger an webhook programmatically for an assignedTask
- find many w4Profiles
- count w4Profiles
- Retrieve an assigned partner task
- One stop setup for PAPI
- Query Yardstik for the full list of account packages associated with the account defined by the API key
- partially update one existing task
- partially update one existing taskFlow
- mark an webhook assignedTask as done programmatically and resend it
- partially update many existing assignedTask
- find one w4Profile
- find many assignedTasks
- find many tasks
- trigger the init process of a task again
- create one or multiple taskFlows
- Retrieve all taskFlows for a given worker with data such as completion rate of tasks
- trigger the init process of a task again
- mark an assignedTask as done programmatically
- Create task flow for copilot
- create one or multiple tasks
- delete many tasks
- count assignedTasks
- delete one task
- partially update one existing storedFile
- Clone a draft task flow as a Test flow for copilot
- find one task
- Apply Test task flow changes back to its source draft
- Delete a Test task flow for copilot
- Publish a Test task flow for copilot
- count signDocs
- delete one taskFlow
- Retrieve all information about one worker and its taskFlow completion
- delete one storedFile
- create one or multiple eins
- Retrieve all workers of a taskFlow with data such as completion rate of tasks
- Create a file and get an upload presigned URL for an object storage in the edm bucket
- find many taskFlows
- delete many taskFlows
- find one taskFlow
- generate a signed file url to access a file
- Upload one or two files from a publicly accessible URL to our object storage. The combined file must not exceed 15MB.
- count taskFlows
- clone task flow(s)
- Create a file and get an upload presigned URL for an object storage in the attachments bucket
- Create a file and get an upload presigned URL for an object storage in the csv imports bucket
- Return the attachment of a signatureRequest as a buffer
- create one or multiple opensignups
- Check if a calendar group is used by any task flows
- find many storedFiles
- find one storedFile
- find many signDocs
- List files from CSV imports storage folder only
- find one opensignup
- find one signDoc
- delete many copilotAuditLogs
- partially update many existing storedFile
- Retrieve a link or download files linked to a signatureRequest document
- create one or multiple copilotAuditLogs
- partially update one existing opensignup
- delete many storedFiles
- Count files from CSV imports storage folder only
- find many apikeys
- find one apikey
- Update one or multiple existing Employer Identification Numbers (EINs) metadata
- replace one copilotAuditLog which exists or not
- delete one copilotAuditLog
- delete one apikey
- partially update many existing opensignup
- count opensignups
- delete many apikeys
- count apikeys
- find one copilotAuditLog
- Delete an employer with slot reassignment
- delete many eins
- replace many copilotAuditLogs which exists or not
- partially update one existing ein
- count copilotAuditLogs
- replace one ein which exists or not
- replace one brand which exists or not
- delete one ein
- create one or multiple companyAttributeSets
- find many eins
- Submit SMS brand registration for a company
- partially update many existing ein
- count eins
- partially update one existing companyAttribute
- count companyAttributeSets
- partially update one existing companyAttributeSet
- replace one company which exists or not
- find many companyAttributeSets
- delete one companyAttributeSet
- create one or multiple employers
- partially update one existing company
- delete many companyAttributeSets
- partially update many existing companyAttributeSet
- replace one companyAttributeSet which exists or not
- create one or multiple companyAttributes
- replace one companyAttribute which exists or not
- delete many companyAttributes
- partially update many existing companyAttribute
- partially update many existing company
- find many companies
- replace many companyAttributes which exists or not
- partially update one existing employer
- delete one companyAttribute
- partially update one existing brand
- count companies
- get a company default brand
- count companyAttributes
- find many brands
- create one or multiple brands
- find one company
- delete many brands
- find one companyAttribute
- find one brand
- find one audienceJob
- partially update many existing brand
- partially update many existing employer
- count brands
- replace one employer which exists or not
- partially update one existing location
- Update a location group and replace its Company Attributes with the payload
- partially update one existing locationGroup
- create one or multiple locations
- replace many brands which exists or not
- delete one brand
- delete many employers
- Compliance External Processing URL — Configuration Guide
- find many audienceOpenings
- replace many employers which exists or not
- Create a location group and replace its Company Attributes with the payload
- count audienceJobs
- count audienceOpenings
- find many audienceLocations
- delete one employer
- find many audienceJobs
- find many locationGroupTrees
- delete many locationGroups
- count employers
- find one employer
- find many locationGroups
- delete one locationGroup
- count locationGroupTrees
- create one or multiple locationGroups
- replace one location which exists or not
- find one audienceLocation
- delete one location
- find one locationGroupTree
- find one audienceOpening
- find one locationGroup
- partially update many existing locationGroup
- delete many locations
- replace one locationGroup which exists or not
- Create a location and replace its Company Attributes with the payload
- Update multiple locations and replace their Company Attributes with the payload
- find many customAttributes
- find many locations
- Deletes a Location and its Company Attributes by its hireLocationUuid if they exist
- Automation Webhooks
- partially update one existing worker
- Create an Applicant
- replace many locations which exists or not
- count locationGroups
- partially update many existing location
- Create a job and replace its Company Attributes with the payload
- partially update one existing customAttribute
- partially update many existing customAttribute
- find one location
- replace many customAttributes which exists or not
- count customAttributes
- delete many customAttributes
- delete many workers
- Update a job and replace its Company Attributes with the payload
- Partner Tasks
- find one customAttribute
- create one or multiple jobs
- delete one customAttribute
- partially update many existing job
- delete many jobs
- replace many jobs which exists or not
- find many jobs
- Universal Tasks Webhooks (Onboard)
- Hire Webhooks
- Update Applicant Info
- Get the worker profile without sensitive filters
- Delete a worker custom attribute
- partially update one existing job
- List All Applicants
- replace one job which exists or not
- delete one job
- count jobs
- Create or update a worker custom attribute value
- Delete an Applicant
- Custom Attribute Webhooks
- Custom Integrations
- find one worker
- Create or update a worker's custom attributes values
- count workers
- message one or many workers
- find many workers
- delete one worker
- Embedding the Worker Portal
- partially update many existing worker
- Connecting a Custom Form
- create one or multiple workers
- Advance an Applicant
- Bulk Advance Multiple Applicants
- Delete a Workflow
- Get Applicant Info
- API Deprecations
- List Webhook Settings
- List all Workflows
- Deactivate A Worker
- Get user opening access
- Activate A Worker
- Sync with your HRIS
- Hire API Overview
- Rate Limits
- Frequently Asked Questions
- Tenant API URLs
- Slack Integration
- API Deprecations
- partially update one existing survey
- Create one or multiple talent
- find many surveys
- fetch list of contactable worker uuids for audience within a given audience
- Get worker W-4 document assignments
- find one questionBank
- partially update many existing taskFlow
- replace many companies which exists or not
- Find allowance settings for a given location
- /api/serviceattendance/processes/shifts/{shiftUuid}/resetNextVersion
- create one or multiple referralCampaigns
- Update tags associated to a profile
- retrieve a list of Hire openings with targeting
- count referralCampaigns
- count tasks
- Exports timesheets to the preconfigured payroll webhook integration
- partially update many existing copilotAuditLog
- delete one referralCampaign
- find one assignedTask
- delete many referralCampaigns
- count defaultNotificationTemplates
- create a new API key based on caller rights
- find many copilotAuditLogs
- Update a location and replace its Company Attributes with the payload
- find many questionBanks
- count themes
- create a new API key based on caller rights
- replace one customAttribute which exists or not
- find many opensignups
- replace many eins which exists or not
- Create a new opening
- find one companyAttributeSet
- count storedFiles
- create one or multiple customAttributes
- find one ein
- find many companyAttributes
- replace many companyAttributeSets which exists or not
- replace many locationGroups which exists or not
- count locations
- count audienceLocations
- Delete User
- Webhooks and External API Calls
- find one job
- Reassign Opening to Different Workflow (Alpha)
- Terminate a worker access
- Download Custom Export
- List user roles
- List All Labels in Stage
- Retrieve Position
- Fountain API Overview
- Replace Option Bank
- Cancel a booked slot
- List all Custom Export Templates
- Get a specific company attribute by type