For AI agents: visit https://apidoc.factorialhr.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Guides API Reference Changelog

API Reference

Guides API Reference Changelog

Factorial API

ApiPublic > Credential
- Reads all Credentialsget
ApiPublic > WebhookSubscription
Approvals > MaterializedApprovalsFlow
- Approves an approval flow by resourcepost
- Rejects an approval flow by resourcepost
Ats > Answer
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 > Question
Ats > RejectionReason
- Reads all Rejection reasonsget
- Reads a single Rejection reasonget
Attendance > BreakConfiguration
Attendance > EditTimesheetRequest
Attendance > EstimatedTime
- Reads all Estimated timesget
Attendance > OpenShift
- Reads all Open shiftsget
Attendance > OvertimeRequest
Attendance > Review
Attendance > Shift
Attendance > WorkedTime
- Reads all Worked timesget
Banking > BankAccount
Banking > CardPayment
- Reads all Card paymentsget
- Reads a single Card paymentget
Banking > Transaction
- Reads all Transactionsget
- Reads a single Transactionget
BookkeepersManagement > Incidence
Companies > LegalEntity
Compensations > Concept
- Reads all Conceptsget
- Reads a single Conceptget
Contracts > Compensation
Contracts > ContractTemplate
- Reads all Contract templatesget
- Reads a single Contract templateget
Contracts > ContractVersion
Contracts > ContractVersionHistory
- Reads all Contract version historiesget
- Reads a single Contract version historyget
Contracts > ContractVersionMetaDatum
- Reads all Contract version meta dataget
Contracts > FrenchContractType
- Reads all French contract typesget
- Reads a single French contract typeget
Contracts > GermanContractType
- Reads all German contract typesget
- Reads a single German contract typeget
Contracts > MaterializedTemplate
- Reads all Materialized templatesget
Contracts > PortugueseContractType
- Reads all Portuguese contract typesget
- Reads a single Portuguese contract typeget
Contracts > ReferenceContract
- Reads all Reference contractsget
Contracts > SpanishContractType
Contracts > SpanishEducationLevel
Contracts > SpanishProfessionalCategory
Contracts > SpanishWorkingDayType
Contracts > Taxonomy
- Reads all Taxonomiesget
- Reads a single Taxonomyget
CustomFields > Field
CustomFields > Option
CustomFields > ResourceField
CustomFields > Value
CustomResources > Resource
- Reads all Resourcesget
- Reads a single Resourceget
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
Expenses > Expense
- Reads all Expensesget
- Reads a single Expenseget
Expenses > Mileage
- Reads all Mileagesget
- Reads a single Mileageget
Expenses > PerDiem
- Reads all Per diemsget
- Reads a single Per diemget
Finance > Account
Finance > AccountingSetting
Finance > BudgetOption
- Reads all Budget optionsget
- Reads a single Budget optionget
Finance > Category
- Reads all Categoriesget
- Reads a single Categoryget
Finance > Contact
Finance > CostCenter
Finance > CostCenterMembership
- Reads all Cost center membershipsget
- Bulk create updates a Cost center membershippost
Finance > FinancialDocument
- Reads all Financial documentsget
- Reads a single Financial documentget
Finance > JournalEntry
Finance > JournalLine
- Reads all Journal linesget
- Reads a single Journal lineget
Finance > LedgerAccountResource
Finance > TaxRate
Finance > TaxType
Holidays > CompanyHoliday
- Reads all Company holidaysget
- Reads a single Company holidayget
Integrations > SyncRunOutput
- Creates a Sync run outputpost
Integrations > SyncableItem
- Reads all Syncable itemsget
Integrations > SyncableSyncRun
- Updates a Syncable sync runput
ItManagement > ItAsset
ItManagement > ItAssetModel
JobCatalog > Level
- Reads all Levelsget
- Reads a single Levelget
JobCatalog > NodeAttribute
- Reads all Node attributesget
JobCatalog > Role
- Reads all Rolesget
- Reads a single Roleget
JobCatalog > TreeNode
- Reads all Tree nodesget
Locations > Location
Locations > WorkArea
Marketplace > Installation
- Creates an Installationpost
Marketplace > InstallationSetting
- Reads all Installation settingsget
Payroll > FamilySituation
Payroll > PolicyPeriod
- Change statuses a Policy periodpost
Payroll > Supplement
PayrollEmployees > Identifier
PayrollIntegrationsBase > Code
Performance > Agreement
Performance > CompanyEmployeeScoreScale
Performance > EmployeeScoreScale
- Reads all Employee score scalesget
- Reads a single Employee score scaleget
Performance > ReviewEvaluation
Performance > ReviewEvaluationAnswer
- Reads all Review evaluation answersget
Performance > ReviewEvaluationScore
- Reads all Review evaluation scoresget
- Reads a single Review evaluation scoreget
Performance > ReviewOwner
Performance > ReviewProcess
Performance > ReviewProcessCustomTemplate
- Reads all Review process custom templatesget
- Reads a single Review process custom templateget
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
Procurement > PurchaseOrder
- Reads all Purchase ordersget
- Reads a single Purchase orderget
Procurement > PurchaseRequest
- Reads all Purchase requestsget
- Reads a single Purchase requestget
Procurement > Type
- Reads all Typesget
- Reads a single Typeget
ProjectManagement > BudgetStrategy
ProjectManagement > ExpenseRecord
- Reads all Expense recordsget
- Reads a single Expense recordget
ProjectManagement > ExportableExpense
- Reads all Exportable expensesget
ProjectManagement > ImputableProject
- Reads all Imputable projectsget
- Reads a single Imputable projectget
ProjectManagement > PlannedRecord
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 > PolicyAssignment
Timeoff > PolicyTimeline
- Reads all Policy timelinesget
TimePlanning > PlannedBreak
TimePlanning > PlanningVersion
TimeSettings > BreakConfiguration
Trainings > Category
Trainings > Session
Trainings > SessionAccessMembership
Trainings > SessionAttendance
Trainings > Training
Trainings > TrainingClass
Trainings > TrainingMembership
WorkSchedule > DayConfiguration
WorkSchedule > OverlapPeriod
WorkSchedule > Schedule
Webhooks

Powered by

Teams > Team > Deletes

wbhk

Webhooks > Teams > Team > Deletes

Subscription_type: teams/team/delete

Payload

Callback payload

id

string

required

name

string

required

description

string

avatar

string

employee_ids

array of strings

employee_ids

lead_ids

array of strings

lead_ids

company_id

string

required

Response

200

Return a 200 status to indicate that the data was received successfully

Updated 3 months ago

Teams > Team > Creates

Teams > Team > Projects

Did this page help you?

Loading…

Updated 3 months ago

Teams > Team > Creates

Teams > Team > Projects

Did this page help you?