Skip to navigation

Create a Global Payroll worker

Beta

Creates a Global Payroll worker and their contract in a single call, so API clients and partner integrations can onboard Global Payroll workers directly instead of using the legacy POST /rest/contracts/gp flow. No invitation email is sent to the worker unless the request asks for one.

Token scopes: contracts:write

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-12.

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Request

Worker, contract and compensation details.
dataobjectRequired

Response

The worker and their contract were created. data.id is the contract id; data.employee.id is the worker id to use with the other Global Payroll worker endpoints.

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error