Jump to Content
Home
Guides
API Reference
Changelog
Discussions
v2.0
v2024-10-01
v2025-01-01
v2025-04-01
v2025-07-01
API Reference
Moon (Dark Mode)
Sun (Light Mode)
v2.0 - bernoulli
Home
Guides
API Reference
Changelog
Discussions
Reads all Teams
Search
These docs are for v2.0. Click to read the latest docs for v2025-04-01.
JUMP TO
Factorial API
ApiPublic > Credential
Reads all Credentials
get
ApiPublic > WebhookSubscription
Reads all Webhook subscriptions
get
Creates a Webhook subscription
post
Reads a single Webhook subscription
get
Updates a Webhook subscription
put
Deletes a Webhook subscription
delete
Ats > Answer
Reads all Answers
get
Reads a single Answer
get
Ats > Application
Reads all Applications
get
Creates an Application
post
Reads a single Application
get
Updates an Application
put
Deletes an Application
delete
Ats > ApplicationPhase
Reads all Application phases
get
Reads a single Application phase
get
Ats > Candidate
Reads all Candidates
get
Creates a Candidate
post
Reads a single Candidate
get
Updates a Candidate
put
Deletes a Candidate
delete
Ats > CandidateSource
Reads all Candidate sources
get
Reads a single Candidate source
get
Ats > EvaluationForm
Reads all Evaluation forms
get
Reads a single Evaluation form
get
Save as templates an Evaluation form
post
Ats > Feedback
Reads all Feedbacks
get
Creates a Feedback
post
Reads a single Feedback
get
Updates a Feedback
put
Deletes a Feedback
delete
Ats > HiringStage
Reads all Hiring stages
get
Reads a single Hiring stage
get
Ats > JobPosting
Reads all Job postings
get
Creates a Job posting
post
Reads a single Job posting
get
Updates a Job posting
put
Deletes a Job posting
delete
Duplicates a Job posting
post
Ats > Message
Reads all Messages
get
Creates a Message
post
Reads a single Message
get
Ats > RejectionReason
Reads all Rejection reasons
get
Reads a single Rejection reason
get
Attendance > BreakConfiguration
Reads all Break configurations
get
Creates a Break configuration
post
Reads a single Break configuration
get
Updates a Break configuration
put
Attendance > EstimatedTime
Reads all Estimated times
get
Attendance > OpenShift
Reads all Open shifts
get
Attendance > OvertimeRequest
Reads all Overtime requests
get
Creates an Overtime request
post
Reads a single Overtime request
get
Updates an Overtime request
put
Deletes an Overtime request
delete
Approves an Overtime request
post
Rejects an Overtime request
post
Attendance > Shift
Reads all Shifts
get
Creates a Shift
post
Reads a single Shift
get
Updates a Shift
put
Deletes a Shift
delete
Autofills a Shift
post
Break ends a Shift
post
Break starts a Shift
post
Clocks in a shift
post
Clocks out a shift
post
Clock in/out a shift
post
Attendance > WorkedTime
Reads all Worked times
get
BookkeepersManagement > Incidence
Reads all Incidences
get
Reads a single Incidence
get
Updates an Incidence
put
Companies > LegalEntity
Reads all Legal entities
get
Reads a single Legal entity
get
Contracts > Compensation
Reads all Compensations
get
Creates a Compensation
post
Reads a single Compensation
get
Updates a Compensation
put
Deletes a Compensation
delete
Contracts > ContractVersion
Reads all Contract versions
get
Creates a Contract version
post
Reads a single Contract version
get
Updates a Contract version
put
Deletes a Contract version
delete
Contracts > ReferenceContract
Reads all Reference contracts
get
Contracts > Taxonomy
Reads all Taxonomies
get
Reads a single Taxonomy
get
CustomFields > Field
Reads all Fields
get
Creates a Field
post
Reads a single Field
get
Deletes a Field
delete
CustomFields > Option
Reads all Options
get
Creates an Option
post
Reads a single Option
get
CustomFields > ResourceField
Reads all Resource fields
get
Creates a Resource field
post
Reads a single Resource field
get
CustomFields > Value
Reads all Values
get
Creates a Value
post
Reads a single Value
get
Updates a Value
put
CustomResources > Schema
Reads all Schemas
get
Creates a Schema
post
Reads a single Schema
get
CustomResources > Value
Reads all Values
get
Creates a Value
post
Reads a single Value
get
Documents > Document
Reads all Documents
get
Creates a Document
post
Reads a single Document
get
Updates a Document
put
Deletes a Document
delete
Move to trash bins a Document
post
Restore from trash bins a Document
post
Documents > DownloadUrl
Bulk creates a Download url
post
Documents > Folder
Reads all Folders
get
Creates a Folder
post
Reads a single Folder
get
Updates a Folder
put
Employees > Employee
Reads all Employees
get
Reads a single Employee
get
Updates an Employee
put
Create with contracts an Employee
post
Invites an Employee
post
Terminates an Employee
post
Unterminates an Employee
post
EmployeeUpdates > Absence
Reads all Absences
get
Reads a single Absence
get
EmployeeUpdates > ContractChange
Reads all Contract changes
get
Reads a single Contract change
get
EmployeeUpdates > NewHire
Reads all New hires
get
Reads a single New hire
get
EmployeeUpdates > PersonalChange
Reads all Personal changes
get
Reads a single Personal change
get
EmployeeUpdates > Summary
Reads all Summaries
get
Reads a single Summary
get
EmployeeUpdates > Termination
Reads all Terminations
get
Reads a single Termination
get
Expenses > Expensable
Reads all Expensables
get
Reads a single Expensable
get
Expenses > Expense
Reads all Expenses
get
Reads a single Expense
get
Expenses > Mileage
Reads all Mileages
get
Reads a single Mileage
get
Finance > Account
Reads all Accounts
get
Creates an Account
post
Reads a single Account
get
Finance > CostCenter
Reads all Cost centers
get
Creates a Cost center
post
Reads a single Cost center
get
Deletes a Cost center
delete
Edits a Cost center
post
Finance > CostCenterMembership
Reads all Cost center memberships
get
Bulk create updates a Cost center membership
post
Holidays > CompanyHoliday
Reads all Company holidays
get
Reads a single Company holiday
get
JobCatalog > Level
Reads all Levels
get
Reads a single Level
get
JobCatalog > Role
Reads all Roles
get
Reads a single Role
get
Locations > Location
Reads all Locations
get
Creates a Location
post
Reads a single Location
get
Updates a Location
put
Deletes a Location
delete
Locations > WorkArea
Reads all Work areas
get
Creates a Work area
post
Reads a single Work area
get
Updates a Work area
put
Archives a Work area
post
Unarchives a Work area
post
Marketplace > InstallationSetting
Reads all Installation settings
get
Payroll > FamilySituation
Reads all Family situations
get
Creates a Family situation
post
Updates a Family situation
put
Payroll > PolicyPeriod
Change statuses a Policy period
post
Payroll > Supplement
Reads all Supplements
get
Creates a Supplement
post
Reads a single Supplement
get
Updates a Supplement
put
Deletes a Supplement
delete
PayrollEmployees > Identifier
Reads all Identifiers
get
Creates an Identifier
post
Reads a single Identifier
get
Updates an Identifier
put
Deletes an Identifier
delete
PayrollIntegrationsBase > Code
Reads all Codes
get
Creates a Code
post
Updates a Code
put
Deletes a Code
delete
Posts > Comment
Reads all Comments
get
Creates a Comment
post
Reads a single Comment
get
Updates a Comment
put
Deletes a Comment
delete
Posts > Group
Reads all Groups
get
Creates a Group
post
Reads a single Group
get
Updates a Group
put
Deletes a Group
delete
Archives a Group
post
Posts > Post
Reads all Posts
get
Creates a Post
post
Reads a single Post
get
Updates a Post
put
Deletes a Post
delete
ProjectManagement > ExpenseRecord
Reads all Expense records
get
Reads a single Expense record
get
ProjectManagement > ExportableExpense
Reads all Exportable expenses
get
ProjectManagement > ExportableProject
Reads all Exportable projects
get
ProjectManagement > FlexibleTimeRecord
Reads all Flexible time records
get
Creates a Flexible time record
post
Reads a single Flexible time record
get
Updates a Flexible time record
put
Deletes a Flexible time record
delete
ProjectManagement > FlexibleTimeRecordComment
Reads all Flexible time record comments
get
Creates a Flexible time record comment
post
Reads a single Flexible time record comment
get
Delete by flexible time records a Flexible time record comment
post
Update by flexible time records a Flexible time record comment
post
ProjectManagement > Project
Reads all Projects
get
Creates a Project
post
Reads a single Project
get
Updates a Project
put
Activates a Project
post
Change assignments a Project
post
Closes a Project
post
Soft deletes a Project
post
ProjectManagement > ProjectTask
Reads all Project tasks
get
Creates a Project task
post
Reads a single Project task
get
Updates a Project task
put
Bulk destroys a Project task
post
Bulk duplicates a Project task
post
ProjectManagement > ProjectWorker
Reads all Project workers
get
Creates a Project worker
post
Reads a single Project worker
get
Bulk assigns a Project worker
post
Bulk creates a Project worker
post
Unassigns a Project worker
post
ProjectManagement > Subproject
Reads all Subprojects
get
Creates a Subproject
post
Reads a single Subproject
get
Deletes a Subproject
delete
Renames a Subproject
post
ProjectManagement > TimeRecord
Reads all Time records
get
Creates a Time record
post
Reads a single Time record
get
Deletes a Time record
delete
Bulk deletes a Time record
post
Bulk processes a Time record
post
Update project workers a Time record
post
ShiftManagement > Shift
Reads all Shifts
get
Creates a Shift
post
Reads a single Shift
get
Deletes a Shift
delete
Bulk deletes a Shift
post
Tasks > Task
Reads all Tasks
get
Creates a Task
post
Reads a single Task
get
Updates a Task
put
Deletes a Task
delete
Bulk change statuses a Task
post
Bulk deletes a Task
post
Copies a Task
post
Create comments a Task
post
Resolves a Task
post
Tasks > TaskFile
Reads all Task files
get
Creates a Task file
post
Reads a single Task file
get
Deletes a Task file
delete
Teams > Membership
Reads all Memberships
get
Creates a Membership
post
Reads a single Membership
get
Updates a Membership
put
Deletes a Membership
delete
Teams > Team
Reads all Teams
get
Creates a Team
post
Reads a single Team
get
Updates a Team
put
Deletes a Team
delete
Timeoff > Allowance
Reads all Allowances
get
Creates an Allowance
post
Reads a single Allowance
get
Updates an Allowance
put
Deletes an Allowance
delete
Delete with alt allowances an Allowance
post
Timeoff > AllowanceIncidence
Reads all Allowance incidences
get
Creates an Allowance incidence
post
Reads a single Allowance incidence
get
Updates an Allowance incidence
put
Deletes an Allowance incidence
delete
Timeoff > AllowanceStat
Reads all Allowance stats
get
Reads a single Allowance stat
get
Timeoff > BlockedPeriod
Reads all Blocked periods
get
Creates a Blocked period
post
Updates a Blocked period
put
Deletes a Blocked period
delete
Timeoff > Leave
Reads all Leaves
get
Creates a Leave
post
Reads a single Leave
get
Updates a Leave
put
Deletes a Leave
delete
Approves a Leave
post
Rejects a Leave
post
Timeoff > LeaveType
Reads all Leave types
get
Creates a Leave type
post
Reads a single Leave type
get
Updates a Leave type
put
Timeoff > Policy
Reads all Policies
get
Creates a Policy
post
Reads a single Policy
get
Updates a Policy
put
Deletes a Policy
delete
Timeoff > PolicyTimeline
Reads all Policy timelines
get
TimePlanning > PlanningVersion
Reads all Planning versions
get
Creates a Planning version
post
Updates a Planning version
put
Deletes a Planning version
delete
Bulk creates a Planning version
post
TimeSettings > BreakConfiguration
Reads all Break configurations
get
Creates a Break configuration
post
Reads a single Break configuration
get
Updates a Break configuration
put
Trainings > Category
Reads all Categories
get
Creates a Category
post
Reads a single Category
get
Deletes a Category
delete
Trainings > Session
Reads all Sessions
get
Creates a Session
post
Reads a single Session
get
Updates a Session
put
Deletes a Session
delete
Trainings > SessionAccessMembership
Reads all Session access memberships
get
Reads a single Session access membership
get
Bulk creates a Session access membership
post
Bulk destroys a Session access membership
post
Trainings > SessionAttendance
Reads all Session attendances
get
Reads a single Session attendance
get
Bulk updates a Session attendance
post
Trainings > Training
Reads all Trainings
get
Creates a Training
post
Reads a single Training
get
Updates a Training
put
Deletes a Training
delete
Bulk deletes a Training
post
Bulk update catalogs a Training
post
Update statuses a Training
post
Trainings > TrainingMembership
Reads all Training memberships
get
Reads a single Training membership
get
Bulk creates a Training membership
post
Bulk destroys a Training membership
post
WorkSchedule > DayConfiguration
Reads all Day configurations
get
Reads a single Day configuration
get
Bulk cuds a Day configuration
post
WorkSchedule > OverlapPeriod
Reads all Overlap periods
get
Creates an Overlap period
post
Updates an Overlap period
put
Deletes an Overlap period
delete
WorkSchedule > Schedule
Reads all Schedules
get
Creates a Schedule
post
Reads a single Schedule
get
Updates a Schedule
put
Toggle archives a Schedule
post
Webhooks
ApiPublic > WebhookSubscription > Creates
post
ApiPublic > WebhookSubscription > Deletes
post
ApiPublic > WebhookSubscription > Updates
post
Payroll > PolicyPeriod > Change statuses
post
Ats > Application > Creates
post
Ats > Application > Deletes
post
Ats > Application > Updates
post
Ats > Candidate > Creates
post
Ats > Candidate > Deletes
post
Ats > Candidate > Updates
post
Ats > EvaluationForm > Save as templates
post
Ats > JobPosting > Creates
post
Ats > JobPosting > Deletes
post
Ats > JobPosting > Duplicates
post
Ats > JobPosting > Updates
post
Attendance > Shift > Autofills
post
Attendance > Shift > Break ends
post
Attendance > Shift > Break starts
post
Attendance > Shift > Clock ins
post
Attendance > Shift > Clock outs
post
Attendance > Shift > Creates
post
Attendance > Shift > Deletes
post
Attendance > Shift > Toggle clocks
post
Attendance > Shift > Updates
post
BookkeepersManagement > Incidence > Updates
post
Contracts > ContractVersion > Creates
post
Contracts > ContractVersion > Deletes
post
Contracts > ContractVersion > Updates
post
CustomResources > Schema > Creates
post
Documents > Document > Creates
post
Documents > Document > Deletes
post
Documents > Document > Move to trash bins
post
Documents > Document > Restore from trash bins
post
Documents > Document > Updates
post
Documents > Folder > Creates
post
Documents > Folder > Updates
post
Employees > Employee > Create with contracts
post
Employees > Employee > Invites
post
Employees > Employee > Terminates
post
Employees > Employee > Unterminates
post
Employees > Employee > Updates
post
Finance > CostCenter > Creates
post
Finance > CostCenter > Deletes
post
Finance > CostCenter > Edits
post
Locations > Location > Creates
post
Locations > Location > Deletes
post
Locations > Location > Updates
post
Payroll > Supplement > Creates
post
Payroll > Supplement > Deletes
post
Payroll > Supplement > Updates
post
PayrollIntegrationsBase > Code > Creates
post
PayrollIntegrationsBase > Code > Deletes
post
PayrollIntegrationsBase > Code > Updates
post
ShiftManagement > Shift > Bulk deletes
post
ShiftManagement > Shift > Creates
post
ShiftManagement > Shift > Deletes
post
Tasks > Task > Bulk change statuses
post
Tasks > Task > Bulk deletes
post
Tasks > Task > Copies
post
Tasks > Task > Creates
post
Tasks > Task > Create comments
post
Tasks > Task > Deletes
post
Tasks > Task > Resolves
post
Tasks > Task > Updates
post
Teams > Membership > Creates
post
Teams > Membership > Deletes
post
Teams > Membership > Updates
post
Teams > Team > Creates
post
Teams > Team > Deletes
post
Teams > Team > Projects
post
Teams > Team > Updates
post
Timeoff > BlockedPeriod > Creates
post
Timeoff > BlockedPeriod > Deletes
post
Timeoff > BlockedPeriod > Updates
post
Timeoff > LeaveType > Creates
post
Timeoff > LeaveType > Updates
post
Timeoff > Leave > Approves
post
Timeoff > Leave > Creates
post
Timeoff > Leave > Deletes
post
Timeoff > Leave > Rejects
post
Timeoff > Leave > Updates
post
Timeoff > Policy > Creates
post
Timeoff > Policy > Deletes
post
Timeoff > Policy > Updates
post
Trainings > Category > Creates
post
Trainings > Category > Deletes
post
Trainings > Training > Bulk deletes
post
Trainings > Training > Bulk update catalogs
post
Trainings > Training > Creates
post
Trainings > Training > Deletes
post
Trainings > Training > Updates
post
Trainings > Training > Update statuses
post
WorkSchedule > Schedule > Creates
post
WorkSchedule > Schedule > Toggle archives
post
WorkSchedule > Schedule > Updates
post
Reads all Teams
get
https://api.factorialhr.com/api/v2/resources/teams/teams
Gets all the teams
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
Bearer
URL
Base URL
https://api.factorialhr.com
/api/v2/resources/teams/teams
RESPONSE
Click
Try It!
to start a request and see the response here!