Skip to navigation

Retrieve contract creation schema

Beta

Returns the list of fields accepted when creating a Global Payroll contract for a worker, with their types, whether they are required, permitted values and validation constraints, so clients can build a valid request before submitting a contract.

Token scopes: global-payroll:read

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-30.

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/

Headers

X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Response

Successful operation.
datalist of objects

Fields accepted when creating a Global Payroll contract. Keys use the casing the contract-creation endpoint expects, dotted for nested objects and suffixed with [] for array items.

Errors

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