Jump to Content
Guides
API Reference
Changelog
v2.1.0
v2.1.12
v2.1.13
v2.1.14
v2.1.15
v2.1.16
v2.1.17
v2.1.18
v2.1.19
v2.1.20
v2.1.21
v2.1.22
v2.1.23
v2.1.24
v2.1.26
v2.1.27
v2.1.28
v2.1.29
v2.1.30
v2.1.31
v2.1.33
v2.1.34
v2.1.36
v2.1.37
v2.1.38
v2.1.39
v2.1.40
v2.1.41
v2.1.42
v2.1.43
v2.1.44
v2.1.45
v2.1.46
v2.1.47
v2.1.48
v2.1.49
v2.1.50
v2.1.51
v2.1.52
v2.1.53
v2.1.54
v2.1.55
v2.1.56
v2.1.57
v2.1.58
v2.1.59
v2.1.60
v2.1.61
v2.1.62
v2.1.63
v2.1.64
v2.1.65
v2.1.66
v2.1.67
v2.1.68
v2.1.69
v2.1.70
v2.1.71
v2.1.72
v2.1.73
v2.1.74
v2.1.75
v2.1.76
v2.1.77
v2.1.78
v2.1.79
v2.1.80
v2.1.81
v2.1.82
v2.1.83
v2.1.84
v2.1.85
v2.1.86
v2.1.87
v2.1.88
v2.1.89
v2.1.90
v2.1.91
v2.1.92
v2.1.93
v2.1.94
v2.1.95
v2.1.96
v2.1.97
v2.1.98
v2.1.99
v2.1.100
API Reference
Moon (Dark Mode)
Sun (Light Mode)
v2.1.51
Guides
API Reference
Changelog
List users
Search
JUMP TO
Contractors
Contractors
Create a new contract
post
Preview a contract agreement
get
Amend contract
post
Terminate contract
post
Invoices
Invoice line items by contract
get
List invoice adjustments
get
Create an invoice adjustment
post
Review an invoice adjustment
post
Update an invoice adjustment
patch
Delete adjustment
delete
Invoice line item by Id
get
Milestones
Retrieve Milestones by Contract
get
Create a Milestone
post
Retrieve a single milestone
get
Delete a Milestone
delete
Review a single milestone
post
Review multiple milestones
post
Off-cycle Payments
List of off-cycle payments
get
Add off-cycle payment
post
Retrieve a single off-cycle payment
get
Tasks
List of tasks
get
Create a new task
post
Review multiple tasks
post
Review a single task
post
Delete task
delete
Timesheets
List of timesheets by contract
get
List of timesheets
get
Create a timesheet entry
post
Retrieve a single timesheet entry
get
Update a timesheet entry
patch
Delete a timesheet entry
delete
Review a single timesheet
post
Review multiple timesheets
post
Delete Hourly Report Preset
delete
Update Hourly Report Preset
patch
Get Hourly Report Preset by ID
get
Create Hourly Report Preset
post
Get Hourly Report Presets
get
Employee of Record
EOR
Retrieve detailed hiring guide for a country
get
Retrieve employee payslip records
get
Retrieve payslip PDF download link
get
Calculate Employee Costs Globally
post
Retrieve Benefits for EOR Contract
get
Create an EOR contract
post
Request EOR Contract Resignation Made by Employee
post
Update EOR Contract
patch
Cancel EOR Contract
post
Delay EOR employee onboarding
patch
Termination Request
post
Get termination
get
Request EOR Contract Resignation
post
List of worker documents
get
Global Payroll
Global Payroll
Create a contract
post
Update address
patch
Retrieve bank accounts
get
Add bank account
post
Modify bank account
patch
Retrieve bank guide
get
Update compensation
patch
Update PTO policy
patch
Update employee information
patch
Download gross-to-net report
get
Request termination
post
List payroll events by legal entity
get
Retrieve employee payslips
get
Download payslip PDF
get
List gross-to-net report
get
Time Tracking Shifts
Create shifts
post
List of shifts
get
Update a shift
patch
Get shift details
get
Delete a Shift by External ID
delete
Time Tracking Rates
Create a New Shift Rate
post
Retrieve a Paginated List of Shift Rates
get
Retrieve a Shift Rate by External ID
get
Update a shift rate
patch
Delete a ShiftRate by external ID
delete
Deel HR
Custom Fields
List all custom fields
get
Retrieve custom fields for a worker
get
Update custom field value
put
List all custom fields
get
Retrieve custom fields for a contract
get
Update custom field value
put
Delete Contract custom field by Id
delete
Get custom fields from contracts
get
Delete the custom field value from Worker by Id
delete
Get custom field from people by id
get
People
Get personal information by id
get
Update personal information
patch
Get personal information by external id
get
Update personal information by external id
patch
List of people
get
Create a direct employee
post
Get my current personal profile
get
Update department
put
Update working location
put
Retrieve a single person
get
Worker Relations
Create worker relation type
post
Retrieve all worker relation types
get
Delete a worker relation type
delete
Update a worker relation type
patch
Delete a worker relation type by external id
delete
Update a worker relation type by external id
patch
Create a worker relation
post
Create worker relation with external Ids
post
List of worker relations
get
Delete a worker relation
delete
Fetch Worker Relations of a given HrisProfile by external id
get
Delete a worker relation by external id
delete
Create a parent worker relation
put
Create child worker relation
put
Create a parent worker relation with external id
put
Create child worker relation with external Id
put
Deel REST API
Time Off
Get Profile Entitlements
get
List policies
get
List time-off requests
get
Create time-off request
post
List time-off requests for Organization
get
Update time-off request
patch
Delete time-off request
delete
Groups
Return list of groups
get
Create a group
post
Edit a group
patch
Delete a group
delete
Contracts
List of contracts
get
Retrieve a single contract
get
External Id
patch
Attach a file to contract
post
Sign a contract
post
Send contract to worker
post
Remove invite
delete
Get worker invite link
get
Retrieve contract templates
get
Download worker document
get
Get an estimate of withholding amount given an equity event.
get
Retrieve contractor payment dates
get
Lookups
Retrieve Country List
get
Retrieve Supported Currency List
get
Job titles list
get
Retrieve Seniority Levels
get
Retrieve Time-Off Types
get
Retrieve lookup information for currencies, countries, entity types, etc
get
Organizations
List of legal entities
get
Get Current Organization
get
Get Team List
get
Retrieve Departments
get
Retrieve working locations
get
Managers
Retrieve List of Managers
get
Create a Manager
post
Adjustments
Create a new adjustment
post
Retrieve an adjustment
get
Update an adjustment
patch
Delete an adjustment
delete
Retrieve categories
get
Retrieve adjustments
get
Webhooks
List of webhooks
get
Create a webhook
post
Retrieve a single webhook
get
Edit a webhook
patch
Delete a webhook
delete
List of webhook event types
get
Reports
Detailed payments report
get
Background Checks
List of background check options
get
Create background check
post
List background checks by contract
get
Equity
Equity Tax Events
post
Immigration
Immigration case details
get
Create an immigration case
post
Immigration visa types
get
Immigration document
get
Screenings
Create Veriff session
post
Get verification method
get
Create manual verification screening
post
Offboarding
Retrieve termination details
get
Retrieve termination details
get
Retrieve offboarding list
get
Accounting API
Accounting
Retrieve invoices
get
Retrieve Deel invoices
get
Retrieve payment receipts
get
Retrieve a payment breakdown
get
Download invoice PDF
get
Deel HR SCIM API
User
List users
get
Retrieve a single User
get
Onboarding API
Candidates
Add Candidate
post
Update Candidate
patch
Powered by
List users
get
https://api.letsdeel.com/scim/v2/Users
Retrieve a list of users in Deel HR.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
Log in to use your API keys
URL
Base URL
https://api.letsdeel.com/scim/v2
/Users
RESPONSE
Click
Try It!
to start a request and see the response here!