Jump to Content

API Reference

All

Pages

Start typing to search…

Hire Documentation

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
Data Keys
- List data keysget
Export Management
Openings and Stages
Hiring Goals
Locations and Location Groups
Openings
- Reassign Opening to Different Workflow (Alpha)post
Option Bank
Positions
Roles
- List user rolesget
Shifts
- List shiftsget
Users
Posthire Worker Management
Workflows
- List all Workflowsget
- Delete a Workflowdel

Worker Experience Documentation

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

Worker Experience Public API

workers
jobs
customAttributes
locations
locationGroups
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
locationGroupTrees
employers
brands
companies
companyAttributes
companyAttributeSets
eins
copilotAuditLogs
users
- Retrieve a short-lived authenticated URL for a worker's portalget
apikeys
opensignups
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
i9Profiles
w4Profiles
workbright
- Get the document assigned to a profileget
hirePapi
- Reject the Hire Papi Profile of an applicantpost
- Set rejected to `false` on the Hire Papi Profile of an applicantpost
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
- Provides a summary of pending tasks for a current employer userget
participants
questionBanks
surveys
themes
defaultNotificationTemplates
pulseSettings
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
timesheets
demands
demand
- Creates bulk demand for a given periodpost
- Creates shifts for a specific demand or list of demandspost
allowanceSettings
automaticBreakSettings
automaticBreakRules
- Create an automatic break rule and associate it with a locationpost
- Delete one or more automatic break rulespost
holidayRules
- Create a holiday rule and associate it with a locationpost
- Delete one or more holiday rulespost
holidayRuleSettings
generalSettings
employmentProfiles
shifts
- /api/serviceattendance/processes/shifts/deleteShiftsdel
talent
unifiedJobs
audiences
audienceCampaign
shifts
- Publish multiple shiftspost
shiftTags
onboardProviders
- get the onboard provider with sensitive informationget

Fountain Internal API

Get Workers

get https://api.fountain.com/v2/workers

List all workers within your account

Language

Credentials

Header

Click Try It! to start a request and see the response here!