For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Support Deel Home

Overview Platform Employer of Record Contractors Global Payroll HR Embedded Deel IT API Reference Changelog

Resources
Endpoints

Get invoice by id
Retrieve a payment breakdown
Retrieve payment receipts
Download invoice PDF
Retrieve invoices
Retrieve refund statements
Retrieve Deel invoices
Create a new adjustment
Delete an adjustment
Retrieve adjustments
Retrieve an adjustment
Retrieve categories
Update an adjustment
List IT assets
Retrieve an IT asset
List interviews
Retrieve a list of ATS teams
Retrieve ATS Application form
Retrieve a list of ATS job boards
List job openings
List feedbacks for an application
Retrieve a list of ATS application sources
Add note to an application
Assign application to interview plan stage
Create ATS Application
Retrieve a list of ATS applications
Retrieve ATS application
Retrieve paginated list of ATS attachment files
Create ATS Candidate
Create candidate tags
Retrieve paginated list of ATS Candidates
Retrieve a list of ATS departments
Retrieve a list of published ATS email templates
Retrieve a list of ATS employment types
Retrieve ATS hiring members
Retrieve a list of ATS job postings
Retrieve ATS job posting
Retrieve ATS job postings
Create ATS Job
Retrieve a list of ATS jobs
Retrieve a list of ATS locations
Retrieve a list of ATS offers
Retrieve paginated list of ATS Rejection/Archivation reasons
List tags
Add Candidate
Create a consent token
Amend contract
List contract amendments
Attach a file to contract
Create contract signature
Get worker invite link
Preview a contract agreement
Remove invite
Retrieve contractor payment dates
Send contract to worker
Add external Id
Retrieve a single contract
Create a new contract
List of contracts
List contract termination reasons
Retrieve contract PDF download link
Approve an equity exercise
Update contract payment type
Create a request to exercise equity.
Sign worker contract
Reject contract
Retrieve contract templates
Calculate Employee Costs Globally
Get cost centers by legal entity
Assign cost centers to an employment contract
Sync cost centers for legal entity
Delete Contract custom field by Id
Get custom fields from contracts
List all custom fields
Retrieve custom fields for a contract
Update custom field value
Delete the custom field value from Worker by Id
Get custom field from people by id
List all people custom fields
Retrieve custom fields for a worker
Update custom field value
Get list of payslips for an EOR employee
Employee additional info template
Acknowledge assignment agreement
Get amendment data points configuration by country
Accept amendment
Cancel amendment
Confirm amendment
Contract amendment PDF
Create amendment
Get amendment by ID
Get amendment validation settings
Get amendments by contract
Retrieve Effective Date Limitations
Sign a contract amendment (employee)
Update amendment
Validate amendment data points
Retrieve Benefits for EOR Contract
Create an EOR contract
Retrieve EOR Contract Details
Update EOR Contract
Fetch EOR contract document
Fetch EOR contract documents
Cancel EOR Contract
Delay Onboarding
Fetch EOR Contract form
Fetch Start Date for EOR Contracts
Get EOR Additional Costs
Retrieve Benefits by Country
Retrieve detailed hiring guide for a country
Sign EOR contract document
Update Employee Information for EOR Contract
List of job scope templates for EOR contracts
Request job scope validation
Create client sign off
Get additional information required to request employee termination
Retrieve Employee Time Off Data for Offboarding
Retrieve offboarding attachment
Retrieve Offboarding Request
Retrieve restricted offboarding dates
Submit employee resignation PTO review
Submit employee sign-off review for offboarding documents
Retrieve employee payslip records
Accept EOR project assignment as client
Fetch EOR project assignment PDF
Fetch Project Assignment Checkin Questionnaire Data
Submit Project Assignment Checkin Questionnaire Data
Create Regular Termination
Create Resignation
Get Termination
Initiate EOR contract termination request
Create EOR Worker
Download employee agreement PDF
Preview job offer letter
Sign a contract
Get EOR Worker Bank Guide
Retrieve bank account guide
Retrieve Benefits for Employee
Acknowledge a compliance document
Download employee compliance document template
Download submitted compliance document
List of employee compliance documents
Upload employee compliance document
List HR verification letters and documents
Add additional information
Add bank account
List of tax documents for an employee
Update additional information
Change EOR Mailbox Password
Preview Resignation Letter
Request contract resignation
Retrieve worker resignations
Sign Resignation Letter
Submit EOR Worker Resignation
Retrieve payslip PDF download link
Create equity or token tax event
List equity grants with tax events
Complete a multipart upload
Create a file upload
Check file upload status
Fetch multiple EOR Contract forms
Get worker additional fields for (EOR)
Retrieve additional information fields for GP workers by country
Update employment type for a contract
Download a GP worker payslip
Create a Global Payroll (GP) contract
Request termination
Clone Group
Create a group
Delete a group
Edit a group
Return list of groups
Download HRX documents
Retrieve HRX documents
Delete IC invoicing tax
Update IC invoicing tax
Get IC invoicing taxes
Create IC invoicing tax
Get immigration case details
Immigration document
Get business visa eligibility and requirements
Retrieve onboarding right-to-work case for a worker
List of immigration cases for workers
Immigration visa types
List of immigration cases
Upload a required immigration document
Retrieve a required document for a case
Get specific immigration case details
Create an immigration case
List case notes
Get integration consent
Create an invoice adjustment
Delete adjustment
Invoice line item by Id
Invoice line items by contract
List invoice adjustments
Review a single invoice adjustment
Update an invoice adjustment
Retrieve worker's actionable journeys
Create a new legal entity
Create a new light legal entity
Delete a legal entity
Edit a legal entity
Get Legal Entities
List all industry subcategories
List of legal entities
Retrieve a legal entity
Update GP employee app access for a legal entity
List payroll cycles
Retrieve Seniority Levels
Retrieve Country List
Retrieve Time-Off Types
Job titles list
Retrieve Supported Currency List
Retrieve lookup information for currencies, countries, entity types, etc
Create magic link
Retrieve List of Managers
Create a Manager
Generate magic link for manager login
Create a Milestone
Delete a Milestone
Retrieve a single milestone
Retrieve Milestones by Contract
Add off-cycle payment
Get Contract Off Cycle Payment By Id
List of off-cycle payments
Retrieve offboarding list
Retrieve termination details by HRIS profile identifier
Retrieve termination details
Attach entries to On-Demand Payroll
Detach entries from On-Demand Payroll
Submit On-Demand Payroll
List On-Demand Payroll entries
Create On-Demand Payroll
Retrieve current On-Demand Payroll
Cancel On-Demand Payroll
List onboarding employees
Get onboarding details by employee HRIS profile ID
Get onboarding details by onboarding tracker ID
List IT orders
Retrieve an IT order
Create a new HRIS Organization Structure.
Delete an Org Structure from the Organization
Delete an Org Structure from the Organization by external ID
Get Organization Structure
Get Organization Structure by External ID
Get Organization Structures
Update an existing HRIS Org Structure
Update an existing HRIS Org Structure by external ID
Update organization structure
Update Team Custom Fields
List organization tasks
Get Current Organization
Create child organization
Update organization custom role
Retrieve working locations
Get the roles of the current organization.
Create organization custom role.
Retrieve Departments
Create a session token for a child organization
Get Teams
Retrieve a payment statement
Create and pay a payment statement
Update auto withdraw setting for contractor
Add/Edit Bank Details
Get Bank Details
Create a bank transfer method
Fetch all payout methods
Request to withdraw funds
Get bank transfer requirements
List Contractor Balances
Change the auto-withdrawal setting
Get the auto-withdrawal setting
Delete Bank Details
Dynamic Requirements
Get bank transfer supported routes for contractor
Update a bank transfer method
Retrieve employee payslips
Retrieve a single person
Create a person without a contract
List of People
Update working location
Create a direct employee
Get my current personal profile
Get personal information by id
Get worker profile by external ID
Profiles
Update personal information
Update personal information by external id
List IT hardware policies
Apply changes to positions.
Get Positions by Profile
Create Hourly Report Root Preset
Get Timesheets Preset By Id
Delete Timesheets Preset
Update Timesheets Preset
Get Hourly Report Presets
Create Hourly Report Preset
Retrieve refund statement credit-note breakdown
List payroll events by legal entity
Download gross to net report
List gross-to-net report.
Gets G2N report data for a given payroll cycle by it's ID.
Get entity screening details
Create Veriff session
Get verification method
Get worker's KYC details
Create manual verification screening
Delete task
List of tasks
Create a new task
Review a single task
Update Task By ID
Review multiple tasks
Delete Contract Termination Request
Terminate contract
Get Profile Entitlements
Update time-off request
Cancel time-off request
Retrieve policy validation templates
Get Work Schedule and Holidays
Create time-off request
List time-off requests
Validate time-off request
Approve or reject time-off requests
Process time-off requests from an external HRIS
Get Time Off Events for Profile
List policies
List time-off requests for Organization
Get time-off attachment download URL
Create a New Shift Rate
Delete a Shift Rate by external ID
Get Time Tracking Timesheets Upload Url
Retrieve a Paginated List of Shift Rates
Retrieve a Shift Rate by External ID
Retrieve a timesheet
Review a submitted timesheet
Update a Shift Rate
Delete a Shift by External ID
Update a shift
Get Shift details
Create shifts
List of shifts
Create raw time tracking shifts
Delete multiple shifts by External ID
Update Timesheet
Get Timesheet By Id
Review a single timesheet
Create a timesheet entry
List of timesheets
List of timesheets by contract
Upload Vendor Bill Attachment
Create Vendor Bill
Create a webhook
Delete a webhook
List webhook event types
List webhooks
Retrieve a single webhook
Update a webhook
Get HRX manager for worker
Add bank account
Add GP Workers Additional Information
Modify bank account
Retrieve bank accounts
Retrieve bank guide
Update address
Update compensation
Update employee information
Update GP Workers Additional Information
Update PTO policy
Add Worker Relation Child By External Id
Add Worker Relation Parent
Create a parent worker relation
Create a parent worker relation with external id
Create a worker relation
Create child worker relation
Create child worker relation with external Id
Create worker relation type
Create worker relation with external Ids
Delete a worker relation
Delete a worker relation by external id
Delete a worker relation type
Delete a worker relation type by external id
Delete Worker Relation Profile
Delete Worker Relation Profile By External Id
Delete Worker Relation Type By External Id
Fetch Worker Relations of a given HrisProfile by external id
Get Worker Relation Profile
List of worker relations
Retrieve all worker relation types
Update a worker relation type
Update a worker relation type by external id
Update Worker Relation Type
Update Worker Relation Type By External Id
Delete worker access token
Create worker access token
List of worker compliance documents
Retrieve IC worker invoice PDF download link
Get invoice details by ID
Create a new worker
Create a tax form for the authenticated worker
List tax forms for the authenticated worker
Update ATS Application
Update ATS Candidate
Upload ATS Candidate CV
Create a tax form for a contractor
Create a work statement payment policy
List work statement payment policies
Delay EOR employee onboarding
Add Files To Legal Entity Registration Document
Create Organization Secure Vault Folder
Delete Legal Entity Registration Document
Delete Legal Entity Registration Document Files
Delete Organization Secure Vault File
Delete Organization Secure Vault Folder
Download Legal Entity Registration Document File
Download Legal Entity Registration Document Requirement Template
Get Legal Entity Registration Document
Get Organization Secure Vault Folder
List Legal Entity Registration Documents
List Organization Registration Documents
List Organization Secure Vault Folder Items
List Organization Secure Vault Items
Submit Legal Entity Registration Documents
Update Legal Entity Registration Document Files
Update Organization Secure Vault Folder
Upload Organization Secure Vault Files
Upload Organization Secure Vault Files To Folder
Get employees from organization integrated with external benefits vendor
Get employee agreement draft preview
Modify bank account for an EOR employee
Reject an EOR quote
Request EOR Contract Resignation Made by Employee
List equity awards granted
List equity grant expense amortization records
List equity grant total expense records
List equity grant valuations
List equity option ledger entries
List equity participants
List Shareworks equity exercises
Get a payroll migration import
Get additional info for a contract
List payroll groups for a legal entity
Retrieve contract creation schema
Submit payroll migration files for a legal entity
Update job title for a contract
Archive an IT asset
Assign asset to new holder
Create a collection for an IT asset
Create a delivery request for an IT asset
Create an IT asset
Restore an archived IT asset
Update asset location
Retrieve a single off-cycle payment
Update auto withdraw setting for contractor
Create Hourly Report Root Preset
Delete Hourly Report Preset
Get Hourly Report Preset by ID
Get Hourly Report Root Preset by ID
Get Hourly Report Root Presets
Update Hourly Report Preset
List of something new new
Test 3y4t303
List job requests
Get Policies for Organization
Get Policies for Organization
Get Profiles Assigned to Policy
Get Profiles Assigned to Policy
Get time-off attachment download URL
Get time-off attachment download URL
Generate timesheet upload url
Delete a timesheet entry
Retrieve a single timesheet entry
Review multiple timesheets
Update a timesheet entry
Complete individual contractor profile setup
Delete the submission of one compliance document of a worker contract
Get a download URL for one compliance document of a worker contract
List compliance documents of a worker contract
Retrieve one compliance document of a worker contract
Submit files for one compliance document of a worker contract
Update a tax form for the authenticated worker

Support Deel Home

Endpoints Groups

Clone Group

POST

/groups/:id/clone

POST

/rest/groups/:id/clone

$ curl -X POST https://api.letsdeel.com/rest/groups/id/clone

Path parameters

idstringRequired

Was this page helpful?