Jump to Content
API Reference
v2.0
v2.1
Log In
API Reference
Log In
Automation Effort
API Reference
workbright
All
Pages
Start typing to search…
JUMP TO
Fountain API Documentation
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
List All Applicants
get
Create an Applicant
post
Get Applicant Info
get
Update Applicant Info
put
Delete an Applicant
del
Advance an Applicant
put
Bulk Advance Multiple Applicants
post
Get Transition History
get
Bulk Transition History for Multiple Applicants
post
duplicate applicants
get
Get Interview Sesssions
get
Bulk Interview Sessions for Multiple Applicants
post
Notify applicant
post
Get Latest Applicant
get
Get Applicant Files
get
File Upload to S3
post
Link Applicant to Files in S3
post
Trigger file recollection for an applicant
post
Approve Applicant Documents
post
exposeAsMcpTool
Labels
List Labels for Applicant
get
Update Label for Applicant
put
List All Labels in Stage
get
Notes
Get Applicant Notes
get
Create Applicant Note
post
Delete Applicant Note
del
Update Applicant Note
put
transitions
List Archived Reasons
get
List Rejection Reasons
get
Calendar Slots
Create Calendar Slots
post
Book an Available Slot
post
Delete Calendar Slots
del
Cancel a booked slot
post
List calendar slots
get
List available slots
get
Openings
Reassign Opening to Different Workflow (Alpha)
post
Assign or remove Company Attributes from an Opening
post
Data Keys
List data keys
get
Export Management
List all Custom Exports
get
Create Custom Export
post
Download Custom Export
get
List all Custom Export Templates
get
List All Timestamped Export Templates
get
Download Timestamped Export
get
Create Timestamped Exports
post
List all Timestamped Exports
get
Openings and Stages
List All Openings
get
Create a new opening
post
Retrieve Opening
get
Update opening
put
Delete an opening
del
List All Opening Stages
get
Retrieve stage
get
Hiring Goals
List Hiring Goals
get
Create a new hiring goal
post
Update Hiring Goal
put
Delete a Hiring Goal
del
Assign Company Attributes to Hiring Goals
post
Locations and Location Groups
List Location Groups
get
Create a new Location Group
post
Retrieve Location Group
get
Update Location Group
put
Delete a Location Group
del
List Locations
get
Create a new Location
post
Retrieve Location
get
Update Location
put
Delete a Location
del
Assign Company Attributes to Location
post
Option Bank
List All Option Banks
get
Create Option Bank
post
Get Option Bank
get
Replace Option Bank
put
Delete Option Bank
del
Remove from Option Bank
del
Append to Option Bank
put
Positions
List Positions
get
Create a new Position
post
Retrieve Position
get
Update Position
put
Delete a Position
del
Assign Company Attributes to Position
post
Roles
List user roles
get
Users
Get User Activities
get
Get user opening access
get
change user opening access
put
Create User
post
Get Users
get
Update User
put
Delete User
del
Posthire Worker Management
Get Workers
get
Get A Worker
get
Update A Worker
patch
Activate A Worker
post
Deactivate A Worker
post
Workflows
List all Workflows
get
Delete a Workflow
del
Company Attributes
Get a specific company attribute by type
get
List company attributes
get
Create company attribute
post
Add values to a company attribute
post
Shifts
List shifts
get
Worker Experience Documentation
Webhooks and External API Calls
Automation Webhooks
Custom Attribute Webhooks
Universal Tasks Webhooks (Onboard)
External Processing API (Compliance)
Embedding the Worker Portal
Partner Tasks
API Deprecations
Worker Experience Public API
workers
count workers
get
find one worker
get
partially update one existing worker
patch
delete one worker
del
find many workers
get
create one or multiple workers
post
partially update many existing worker
patch
delete many workers
del
message one or many workers
post
Create or update a worker custom attribute value
put
Delete a worker custom attribute
del
Create or update a worker's custom attributes values
put
Get the worker profile without sensitive filters
get
Terminate a worker access
post
jobs
count jobs
get
find one job
get
replace one job which exists or not
put
partially update one existing job
patch
delete one job
del
find many jobs
get
create one or multiple jobs
post
replace many jobs which exists or not
put
partially update many existing job
patch
delete many jobs
del
Create a job and replace its Company Attributes with the payload
post
Update a job and replace its Company Attributes with the payload
patch
customAttributes
count customAttributes
get
find one customAttribute
get
replace one customAttribute which exists or not
put
partially update one existing customAttribute
patch
delete one customAttribute
del
find many customAttributes
get
create one or multiple customAttributes
post
replace many customAttributes which exists or not
put
partially update many existing customAttribute
patch
delete many customAttributes
del
locations
count locations
get
find one location
get
replace one location which exists or not
put
partially update one existing location
patch
delete one location
del
find many locations
get
create one or multiple locations
post
replace many locations which exists or not
put
partially update many existing location
patch
delete many locations
del
Update a location and replace its Company Attributes with the payload
patch
Create a location and replace its Company Attributes with the payload
post
Deletes a Location and its Company Attributes by its hireLocationUuid if they exist
del
Update a location and replace its Company Attributes with the payload
patch
locationGroups
count locationGroups
get
find one locationGroup
get
replace one locationGroup which exists or not
put
partially update one existing locationGroup
patch
delete one locationGroup
del
find many locationGroups
get
create one or multiple locationGroups
post
replace many locationGroups which exists or not
put
partially update many existing locationGroup
patch
delete many locationGroups
del
locationGroupTrees
count locationGroupTrees
get
find one locationGroupTree
get
find many locationGroupTrees
get
location-groups
Update a location group and replace its Company Attributes with the payload
patch
Create a location group and replace its Company Attributes with the payload
post
employers
count employers
get
find one employer
get
replace one employer which exists or not
put
partially update one existing employer
patch
delete one employer
del
find many employers
get
create one or multiple employers
post
replace many employers which exists or not
put
partially update many existing employer
patch
delete many employers
del
staff-employers
Delete an employer with slot reassignment
del
brands
count brands
get
find one brand
get
replace one brand which exists or not
put
partially update one existing brand
patch
delete one brand
del
find many brands
get
create one or multiple brands
post
replace many brands which exists or not
put
partially update many existing brand
patch
delete many brands
del
get a company default brand
get
companies
count companies
get
find one company
get
replace one company which exists or not
put
partially update one existing company
patch
find many companies
get
replace many companies which exists or not
put
partially update many existing company
patch
companyAttributes
count companyAttributes
get
find one companyAttribute
get
replace one companyAttribute which exists or not
put
partially update one existing companyAttribute
patch
delete one companyAttribute
del
find many companyAttributes
get
create one or multiple companyAttributes
post
replace many companyAttributes which exists or not
put
partially update many existing companyAttribute
patch
delete many companyAttributes
del
companyAttributeSets
count companyAttributeSets
get
find one companyAttributeSet
get
replace one companyAttributeSet which exists or not
put
partially update one existing companyAttributeSet
patch
delete one companyAttributeSet
del
find many companyAttributeSets
get
create one or multiple companyAttributeSets
post
replace many companyAttributeSets which exists or not
put
partially update many existing companyAttributeSet
patch
delete many companyAttributeSets
del
eins
count eins
get
find one ein
get
replace one ein which exists or not
put
partially update one existing ein
patch
delete one ein
del
find many eins
get
create one or multiple eins
post
replace many eins which exists or not
put
partially update many existing ein
patch
delete many eins
del
Update one or multiple existing Employer Identification Numbers (EINs) metadata
patch
copilotAuditLogs
count copilotAuditLogs
get
find one copilotAuditLog
get
replace one copilotAuditLog which exists or not
put
partially update one existing copilotAuditLog
patch
delete one copilotAuditLog
del
find many copilotAuditLogs
get
create one or multiple copilotAuditLogs
post
replace many copilotAuditLogs which exists or not
put
partially update many existing copilotAuditLog
patch
delete many copilotAuditLogs
del
users
Retrieve a short-lived authenticated URL for a worker's portal
get
apikeys
count apikeys
get
find one apikey
get
delete one apikey
del
find many apikeys
get
delete many apikeys
del
create a new API key based on caller rights
post
create a new API key based on caller rights
post
opensignups
count opensignups
get
find one opensignup
get
partially update one existing opensignup
patch
find many opensignups
get
create one or multiple opensignups
post
partially update many existing opensignup
patch
papi
One stop setup for PAPI
post
storedFiles
count storedFiles
get
find one storedFile
get
partially update one existing storedFile
patch
delete one storedFile
del
find many storedFiles
get
partially update many existing storedFile
patch
delete many storedFiles
del
Create a file and get an upload presigned URL for an object storage in the edm bucket
post
Create a file and get an upload presigned URL for an object storage in the attachments bucket
post
generate a signed file url to access a file
get
Create a file and get an upload presigned URL for an object storage in the custom scripts bucket
post
Upload one or two files from a publicly accessible URL to our object storage. The combined file must not exceed 15MB.
post
Create a file and get an upload presigned URL for an object storage in the csv imports bucket
post
List files from CSV imports storage folder only
get
Count files from CSV imports storage folder only
get
signDocs
count signDocs
get
find one signDoc
get
find many signDocs
get
signatureRequests
Retrieve a link or download files linked to a signatureRequest document
get
Return the attachment of a signatureRequest as a buffer
get
taskFlows
count taskFlows
get
find one taskFlow
get
partially update one existing taskFlow
patch
delete one taskFlow
del
find many taskFlows
get
create one or multiple taskFlows
post
partially update many existing taskFlow
patch
delete many taskFlows
del
clone task flow(s)
post
Check if a calendar group is used by any task flows
get
Retrieve all workers of a taskFlow with data such as completion rate of tasks
get
Retrieve all information about one worker and its taskFlow completion
get
Retrieve all taskFlows for a given worker with data such as completion rate of tasks
get
Create task flow for copilot
post
tasks
count tasks
get
find one task
get
partially update one existing task
patch
delete one task
del
find many tasks
get
create one or multiple tasks
post
partially update many existing task
patch
delete many tasks
del
assignedTasks
count assignedTasks
get
find one assignedTask
get
partially update one existing assignedTask
patch
find many assignedTasks
get
partially update many existing assignedTask
patch
mark an webhook assignedTask as done programmatically and resend it
post
retrigger an webhook programmatically for an assignedTask
post
trigger the init process of a task again
post
trigger the init process of a task again
post
mark an assignedTask as done programmatically
post
onboardProviders
i9Profiles
w4Profiles
count w4Profiles
get
find one w4Profile
get
find many w4Profiles
get
workbright
hirePapi
yardstik
Query Yardstik for the full list of account packages associated with the account defined by the API key
get
partner
Retrieve an assigned partner task
get
Add a new partner event to an assigned partner task
post
todoWorkers
Reprocess worker onboarding
post
todo-workers
Get worker task flows
get
Api endpoint to get workers by task date
get
Get counts of workers with tasks in different statuses
get
Get partner status with partnerStatus
get
processes-dashboard-pending-tasks
Provides a summary of pending tasks for a current employer user
get
i9center
One stop setup for I9Center V2
post
participants
count participants
get
find one participant
get
find many participants
get
questionBanks
count questionBanks
get
find one questionBank
get
partially update one existing questionBank
patch
delete one questionBank
del
find many questionBanks
get
create one or multiple questionBanks
post
partially update many existing questionBank
patch
delete many questionBanks
del
surveys
count surveys
get
find one survey
get
partially update one existing survey
patch
delete one survey
del
find many surveys
get
create one or multiple surveys
post
partially update many existing survey
patch
delete many surveys
del
themes
count themes
get
find one theme
get
partially update one existing theme
patch
delete one theme
del
find many themes
get
create one or multiple themes
post
partially update many existing theme
patch
delete many themes
del
defaultNotificationTemplates
count defaultNotificationTemplates
get
find one defaultNotificationTemplate
get
partially update one existing defaultNotificationTemplate
patch
delete one defaultNotificationTemplate
del
find many defaultNotificationTemplates
get
create one or multiple defaultNotificationTemplates
post
partially update many existing defaultNotificationTemplate
patch
delete many defaultNotificationTemplates
del
pulseSettings
count pulseSettings
get
find one pulseSettings
get
partially update one existing pulseSettings
patch
delete one pulseSettings
del
find many pulseSettings
get
create one or multiple pulseSettings
post
partially update many existing pulseSettings
patch
delete many pulseSettings
del
attendancePolicies
Find attendance policy for a given location
get
Find attendance policy for a given location group
get
allowances
Create an allowance and associate it with a location
post
Delete one or more allowances
post
shifts
count shifts
get
find one shift
get
find many shifts
get
create one or multiple shifts
post
Update shifts, validated by rules. Fails with a 409 if there are any blockers. Note: When adding breaks use v4 uuid.
patch
/api/serviceattendance/processes/shifts/{shiftUuid}
del
/api/serviceattendance/processes/shifts/{locationUuid}/publish
post
/api/serviceattendance/processes/shifts/{shiftUuid}/resetNextVersion
post
Publish an individual shift
post
timeOff
count timeOff
get
find one timeOff
get
find many timeOff
get
/api/serviceattendance/processes/timeOff
post
/api/serviceattendance/processes/timeOff/{timeOffUuid}
patch
Delete time-off
del
timesheets
count timesheets
get
find one timesheet
get
partially update one existing timesheet
patch
find many timesheets
get
create one or multiple timesheets
post
partially update many existing timesheet
patch
Marks a timesheet as deleted and cancels scheduled events
post
/api/serviceattendance/processes/timesheets/{timesheetUuid}/addClockEvent
patch
Exports timesheets to the preconfigured payroll webhook integration
post
Returns exported headers, rows, filename for timesheets. Specify target timesheets by uuid or by filter
post
Returns exported headers, rows, filename for timesheets. Specify target timesheets by uuid or by filter
post
workerRequests
count workerRequests
get
find one workerRequest
get
find many workerRequests
get
demands
count demands
get
find one demand
get
find many demands
get
demand
Creates bulk demand for a given period
post
Creates shifts for a specific demand or list of demands
post
shiftTags
count shiftTags
get
find one shiftTag
get
partially update one existing shiftTag
patch
delete one shiftTag
del
find many shiftTags
get
create one or multiple shiftTags
post
partially update many existing shiftTag
patch
delete many shiftTags
del
allowanceSettings
Find allowance settings for a given location
get
Find allowance settings for a given location group
get
Count allowance for a given location
get
Count allowance for a given location group
get
Clone allowance settings with allowances
post
automaticBreakSettings
Find automatic break settings for a given location
get
Find automatic break settings for a given location group
get
Count automatic break rules for a given location
get
Count automatic break rules for a given location group
get
Clone automatic break settings with automatic break rules
post
automaticBreakRules
Create an automatic break rule and associate it with a location
post
Delete one or more automatic break rules
post
holidayRules
Create a holiday rule and associate it with a location
post
Delete one or more holiday rules
post
Update holiday rule(s) and invalidate overlapping schedules for re-evaluation
patch
Get active holiday rules for specified locations within a date range
post
holidayRuleSettings
Find holiday rule settings for a given location
get
Find holiday rule settings for a given location group
get
Count holiday rule settings for a given location
get
Count holiday rule settings for a given location group
get
Clone holiday rule settings
post
Delete holiday rule settings and re-evaluate workers for inheritance
del
generalSettings
count generalSettings
get
find one generalSetting
get
find many generalSettings
get
/api/serviceattendance/processes/generalSettings
get
employmentProfiles
count employmentProfiles
get
find one employmentProfile
get
find many employmentProfiles
get
partially update one existing employmentProfile
patch
partially update many existing employmentProfile
patch
Update tags associated to a profile
patch
Update allowed properties for an employment profile
patch
Get worker W-4 document assignments
get
Restart a profile submission(s)
post
Rehire a profile submission(s)
post
Set the disabled flag for a worker case and emit activity events
patch
talent
fetch list of talent
get
Create one or multiple talent
post
List talent
get
Retrieve a talent by its unique identifier
get
Find and update a talent
put
Delete a talent
del
Get audience campaigns for a talent
get
Fetch aggregated custom attributes from talents
get
unifiedJobs
Find unifiedJobs matches for a given talent based on aggregate vector match
get
fetch list of unified jobs
get
Create one or multiple unified jobs
post
List unifiedJobs
get
Retrieve a unified job by its unique identifier
get
Find and update a unified job
put
Delete a unified job
del
audiences
fetch list of audiences
get
Create one or multiple audiences
post
List audiences
get
Retrieve an audience by its unique identifier
get
Find and update an audience
patch
Delete an audience
del
fetch list of contactable worker uuids for talent within a given audience
get
Create audiences via Copilot
post
Update audience via Copilot
patch
audienceCampaign
fetch list of audience campaigns
get
Create one or multiple audience campaigns
post
Get count of audience campaigns
get
Retrieve an audience campaign by its unique identifier
get
Find and update an audience campaign
put
Delete an audience campaign
del
Duplicate an audience campaign
post
Activates an audience campaign
post
Create a complete multi-day audience campaign
post
shifts
/api/serviceattendance/processes/shifts/deleteShifts
del
Publish multiple shifts
post
users
Retrieve a short-lived authenticated URL for a worker's portal
get
openings
count openings
get
find one opening
get
find many openings
get
audienceLocations
count audienceLocations
get
find one audienceLocation
get
find many audienceLocations
get
audienceJobs
count audienceJobs
get
find one audienceJob
get
find many audienceJobs
get
audienceOpenings
count audienceOpenings
get
find one audienceOpening
get
find many audienceOpenings
get
documentTypes
fetch list of documentTypes
get
Create one or multiple documentTypes
post
Create one or multiple documentTypes simplified
post
Retreive a documentType by its unique identifier
get
documentSubmissions
fetch list of documentSubmissions
get
Create one documentSubmission
post
Retrieve a documentSubmission by its unique identifier
get
Find and update a documentSubmission
put
requirements
Create one or multiple requirements
post
List requirements
get
Retreive a requirement by its unique identifier
get
Find and update a requirement
put
workerComplianceProfiles
List workerComplianceProfiles
get
Retreive a workerComplianceProfile by its unique identifier
get
Retrieve the workerComplianceProfile for an authenticated worker
get
tags
count tags
get
find one tag
get
partially update one existing tag
patch
delete one tag
del
find many tags
get
create one or multiple tags
post
partially update many existing tag
patch
delete many tags
del
viewEmploymentProfiles
count viewEmploymentProfiles
get
find one viewEmploymentProfile
get
find many viewEmploymentProfiles
get
Sync viewEmploymentProfile and Partner resources for a given worker
post
Retrieve a submission file
get
Retrieve a submission file
get
viewEmploymentProfilesI9
count viewEmploymentProfilesI9
get
find one viewEmploymentProfileI9
get
find many viewEmploymentProfilesI9
get
viewEmploymentProfilesW4
count viewEmploymentProfilesW4
get
find one viewEmploymentProfileW4
get
find many viewEmploymentProfilesW4
get
logNotes
count logNotes
get
find one logNote
get
find many logNotes
get
employerNotes
count employerNotes
get
find one employerNote
get
find many employerNotes
get
create one or multiple employerNotes
post
workbright
Ask AI
