Jump to Content

Home Guides API Reference Changelog Discussions

API Reference

Home Guides API Reference Changelog Discussions

These docs are for v2024-10-01. Click to read the latest docs for v2025-01-01.

Factorial API

ApiPublic > Credential
- Reads all Credentialsget
ApiPublic > WebhookSubscription
Ats > Answer
- Reads all Answersget
- Reads a single Answerget
Ats > Application
Ats > ApplicationPhase
- Reads all Application phasesget
- Reads a single Application phaseget
Ats > Candidate
Ats > CandidateSource
- Reads all Candidate sourcesget
- Reads a single Candidate sourceget
Ats > EvaluationForm
Ats > Feedback
Ats > HiringStage
- Reads all Hiring stagesget
- Reads a single Hiring stageget
Ats > JobPosting
Ats > Message
Ats > RejectionReason
- Reads all Rejection reasonsget
- Reads a single Rejection reasonget
Attendance > BreakConfiguration
Attendance > EstimatedTime
- Reads all Estimated timesget
Attendance > OpenShift
- Reads all Open shiftsget
Attendance > OvertimeRequest
Attendance > Shift
Attendance > WorkedTime
- Reads all Worked timesget
BookkeepersManagement > Incidence
Companies > LegalEntity
- Reads all Legal entitiesget
- Reads a single Legal entityget
Contracts > Compensation
Contracts > ContractVersion
Contracts > ReferenceContract
- Reads all Reference contractsget
Contracts > Taxonomy
- Reads all Taxonomiesget
- Reads a single Taxonomyget
CustomFields > Field
CustomFields > Option
CustomFields > ResourceField
CustomFields > Value
CustomResources > Schema
CustomResources > Value
Documents > Document
Documents > DownloadUrl
- Bulk creates a Download urlpost
Documents > Folder
Employees > Employee
EmployeeUpdates > Absence
- Reads all Absencesget
- Reads a single Absenceget
EmployeeUpdates > ContractChange
- Reads all Contract changesget
- Reads a single Contract changeget
EmployeeUpdates > NewHire
- Reads all New hiresget
- Reads a single New hireget
EmployeeUpdates > PersonalChange
- Reads all Personal changesget
- Reads a single Personal changeget
EmployeeUpdates > Summary
- Reads all Summariesget
- Reads a single Summaryget
EmployeeUpdates > Termination
- Reads all Terminationsget
- Reads a single Terminationget
Expenses > Expensable
- Reads all Expensablesget
- Reads a single Expensableget
Expenses > Expense
- Reads all Expensesget
- Reads a single Expenseget
Expenses > Mileage
- Reads all Mileagesget
- Reads a single Mileageget
Finance > Account
Finance > CostCenter
Finance > CostCenterMembership
- Reads all Cost center membershipsget
- Bulk create updates a Cost center membershippost
Holidays > CompanyHoliday
- Reads all Company holidaysget
- Reads a single Company holidayget
JobCatalog > Level
- Reads all Levelsget
- Reads a single Levelget
JobCatalog > Role
- Reads all Rolesget
- Reads a single Roleget
Locations > Location
Locations > WorkArea
Marketplace > InstallationSetting
- Reads all Installation settingsget
Marketplace > Setting
- Reads all Settingsget
Payroll > FamilySituation
Payroll > PolicyPeriod
- Change statuses a Policy periodpost
Payroll > Supplement
PayrollEmployees > Identifier
PayrollIntegrationsBase > Code
Performance > Agreement
Performance > ReviewEvaluation
Performance > ReviewEvaluationAnswer
- Reads all Review evaluation answersget
Performance > ReviewOwner
Performance > ReviewProcess
Performance > ReviewProcessEstimatedTarget
- Reads all Review process estimated targetsget
Performance > ReviewProcessTarget
Performance > ReviewQuestionnaireByStrategy
Performance > ReviewVisibilitySetting
- Reads all Review visibility settingsget
- Updates a Review visibility settingput
Performance > TargetManager
- Reads all Target managersget
- Reads a single Target managerget
Posts > Comment
Posts > Group
Posts > Post
ProjectManagement > ExpenseRecord
- Reads all Expense recordsget
- Reads a single Expense recordget
ProjectManagement > ExportableExpense
- Reads all Exportable expensesget
ProjectManagement > ExportableProject
- Reads all Exportable projectsget
ProjectManagement > FlexibleTimeRecord
ProjectManagement > FlexibleTimeRecordComment
ProjectManagement > Project
ProjectManagement > ProjectTask
ProjectManagement > ProjectWorker
ProjectManagement > Subproject
ProjectManagement > TimeRecord
ShiftManagement > Shift
Tasks > Task
Tasks > TaskFile
Teams > Membership
Teams > Team
Timeoff > Allowance
Timeoff > AllowanceIncidence
Timeoff > AllowanceStat
- Reads all Allowance statsget
- Reads a single Allowance statget
Timeoff > BlockedPeriod
Timeoff > Leave
Timeoff > LeaveType
Timeoff > Policy
Timeoff > PolicyTimeline
- Reads all Policy timelinesget
TimePlanning > PlanningVersion
TimeSettings > BreakConfiguration
Trainings > Category
Trainings > Session
Trainings > SessionAccessMembership
Trainings > SessionAttendance
Trainings > Training
Trainings > TrainingMembership
WorkSchedule > DayConfiguration
WorkSchedule > OverlapPeriod
WorkSchedule > Schedule
Webhooks

Factorial API

ApiPublic > Credential
- Reads all Credentialsget
ApiPublic > WebhookSubscription
Ats > Answer
- Reads all Answersget
- Reads a single Answerget
Ats > Application
Ats > ApplicationPhase
- Reads all Application phasesget
- Reads a single Application phaseget
Ats > Candidate
Ats > CandidateSource
- Reads all Candidate sourcesget
- Reads a single Candidate sourceget
Ats > EvaluationForm
Ats > Feedback
Ats > HiringStage
- Reads all Hiring stagesget
- Reads a single Hiring stageget
Ats > JobPosting
Ats > Message
Ats > RejectionReason
- Reads all Rejection reasonsget
- Reads a single Rejection reasonget
Attendance > BreakConfiguration
Attendance > EstimatedTime
- Reads all Estimated timesget
Attendance > OpenShift
- Reads all Open shiftsget
Attendance > OvertimeRequest
Attendance > Shift
Attendance > WorkedTime
- Reads all Worked timesget
BookkeepersManagement > Incidence
Companies > LegalEntity
- Reads all Legal entitiesget
- Reads a single Legal entityget
Contracts > Compensation
Contracts > ContractVersion
Contracts > ReferenceContract
- Reads all Reference contractsget
Contracts > Taxonomy
- Reads all Taxonomiesget
- Reads a single Taxonomyget
CustomFields > Field
CustomFields > Option
CustomFields > ResourceField
CustomFields > Value
CustomResources > Schema
CustomResources > Value
Documents > Document
Documents > DownloadUrl
- Bulk creates a Download urlpost
Documents > Folder
Employees > Employee
EmployeeUpdates > Absence
- Reads all Absencesget
- Reads a single Absenceget
EmployeeUpdates > ContractChange
- Reads all Contract changesget
- Reads a single Contract changeget
EmployeeUpdates > NewHire
- Reads all New hiresget
- Reads a single New hireget
EmployeeUpdates > PersonalChange
- Reads all Personal changesget
- Reads a single Personal changeget
EmployeeUpdates > Summary
- Reads all Summariesget
- Reads a single Summaryget
EmployeeUpdates > Termination
- Reads all Terminationsget
- Reads a single Terminationget
Expenses > Expensable
- Reads all Expensablesget
- Reads a single Expensableget
Expenses > Expense
- Reads all Expensesget
- Reads a single Expenseget
Expenses > Mileage
- Reads all Mileagesget
- Reads a single Mileageget
Finance > Account
Finance > CostCenter
Finance > CostCenterMembership
- Reads all Cost center membershipsget
- Bulk create updates a Cost center membershippost
Holidays > CompanyHoliday
- Reads all Company holidaysget
- Reads a single Company holidayget
JobCatalog > Level
- Reads all Levelsget
- Reads a single Levelget
JobCatalog > Role
- Reads all Rolesget
- Reads a single Roleget
Locations > Location
Locations > WorkArea
Marketplace > InstallationSetting
- Reads all Installation settingsget
Marketplace > Setting
- Reads all Settingsget
Payroll > FamilySituation
Payroll > PolicyPeriod
- Change statuses a Policy periodpost
Payroll > Supplement
PayrollEmployees > Identifier
PayrollIntegrationsBase > Code
Performance > Agreement
Performance > ReviewEvaluation
Performance > ReviewEvaluationAnswer
- Reads all Review evaluation answersget
Performance > ReviewOwner
Performance > ReviewProcess
Performance > ReviewProcessEstimatedTarget
- Reads all Review process estimated targetsget
Performance > ReviewProcessTarget
Performance > ReviewQuestionnaireByStrategy
Performance > ReviewVisibilitySetting
- Reads all Review visibility settingsget
- Updates a Review visibility settingput
Performance > TargetManager
- Reads all Target managersget
- Reads a single Target managerget
Posts > Comment
Posts > Group
Posts > Post
ProjectManagement > ExpenseRecord
- Reads all Expense recordsget
- Reads a single Expense recordget
ProjectManagement > ExportableExpense
- Reads all Exportable expensesget
ProjectManagement > ExportableProject
- Reads all Exportable projectsget
ProjectManagement > FlexibleTimeRecord
ProjectManagement > FlexibleTimeRecordComment
ProjectManagement > Project
ProjectManagement > ProjectTask
ProjectManagement > ProjectWorker
ProjectManagement > Subproject
ProjectManagement > TimeRecord
ShiftManagement > Shift
Tasks > Task
Tasks > TaskFile
Teams > Membership
Teams > Team
Timeoff > Allowance
Timeoff > AllowanceIncidence
Timeoff > AllowanceStat
- Reads all Allowance statsget
- Reads a single Allowance statget
Timeoff > BlockedPeriod
Timeoff > Leave
Timeoff > LeaveType
Timeoff > Policy
Timeoff > PolicyTimeline
- Reads all Policy timelinesget
TimePlanning > PlanningVersion
TimeSettings > BreakConfiguration
Trainings > Category
Trainings > Session
Trainings > SessionAccessMembership
Trainings > SessionAttendance
Trainings > Training
Trainings > TrainingMembership
WorkSchedule > DayConfiguration
WorkSchedule > OverlapPeriod
WorkSchedule > Schedule
Webhooks

Ats > Candidate > Updates

wbhk Webhooks > Ats > Candidate > Updates

Subscription_type: ats/candidate/update