Available Deel APIs

Tanisha Ray

Updated November 25, 2024 07:51

When you configure an export, import, or other type of flow step using the prebuilt Deel connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Deel API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Token	Create a public token		X
EOR	Retrieve country guide	X
	Retrieve employee payslips	X
	Get EOR contract benefits	X
	Download payslip PDF	X
	Employee cost calculator		X
	Create an EOR contract		X
Milestones	List of milestones by contract	X
	Retrieve a single milestone	X
	Create a milestone		X
	Delete a milestone		X
	Review a single milestone		X
	Review multiple milestones		X
Contractors	Preview a contract agreement	X
	Create a new contract		X
	Amend contract		X
	Terminate contract		X
	Upgrade to premium		X
	Downgrade from premium		X
Accounting	Retrieve invoices	X
	Retrieve deel invoices	X
	Retrieve payment receipts	X
	Retrieve a payment breakdown	X
Invoices	Invoice line items by contract	X
	List invoice adjustments	X
	Retrieve attachment file URL	X
	Create an invoice adjustment		X
	Update an invoice adjustment		X
	Delete an invoice adjustment		X
	Review an invoice adjustment		X
	Bulk review invoice adjustments		X
Lookups	Country list	X
	Currency list	X
	Job titles list	X
	Seniority levels	X
	Time off types	X
Webhooks	List of webhooks	X
	Retrieve a single webhook	X
	List of webhook event types	X
	Create a webhook		X
	Edit a webhook		X
	Delete a webhook		X
Timesheets	List of timesheets by contract	X
	List of timesheets	X
	Retrieve a single timesheet entry	X
	Create a timesheet entry		X
	Update a timesheet entry		X
	Delete a timesheet entry		X
	Review a single timesheet		X
	Review multiple timesheets		X
Managers	List of managers	X
Managers	Create a manager		X
Contracts	List of contracts	X
	Retrieve a single contract	X
	Get contract templates	X
	External ID		X
	Attach a file to contract		X
	Sign a contract		X
	Send contract to worker		X
	Remove invite		X
	Calculate first payment amount		X
Tasks	List of tasks	X
	Create new task		X
	Review multiple tasks		X
	Review a single task		X
	Delete task		X
People	List of people	X
	Retrieve a single person	X
	Update department		X
	Update working location		X
	Delete a time off request		X
Adjustments	Retrieve an adjustment	X
	Retrieve categories	X
	Retrieve adjustments	X
	Create a new adjustment		X
	Update an adjustment		X
	Delete an adjustment		X
User	List users	X
	Retrieve a single user	X
	Partially update/patch a user		X
Off-cycle payments	List of off-cycle payments	X
	Retrieve a single off-cycle payment	X
	Add off-cycle payment		X
Organizations	List of legal entities	X
	Get current organization	X
	Get team list	X
	Retrieve departments	X
	Retrieve working locations	X
Global payroll	Retrieve employee payslips	X
	Retrieve bank accounts	X
	Retrieve bank guide	X
	Download payslip PDF	X
	List payroll events by legal entity	X
	List gross to net report	X
	Create a contract		X
	Update address		X
	Add bank account		X
	Modify bank account		X
	Update compensation		X
	Update PTO policy		X
	Update employee information		X
	Download gross to net report	X
	Request termination		X
Candidates	Add candidate		X
Candidates	Update candidate		X