Retrieve the Global Payroll worker creation schema
Returns the fields POST /rest/gp/workers accepts, with whether each is required, its permitted values and its validation rules. Pass country, or legal_entity_id and payroll_group_id, to get the rules that apply to that case: contract_state and its provinces, work_location for US entities, postal code format, allowed currencies and the employee_number requirement of a Payroll Connect group. Build the form from this response and the create will not reject it.
Token scopes: contracts: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-12.
Authentication
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'
Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/
Query parameters
ISO 3166-1 alpha-2 country of the legal entity. Adds the country rules. Must match the legal entity when legal_entity_id is also given.
Payroll group of the legal entity. When it is a Payroll Connect (Soft GP) group, employee_number is reported as required. Requires legal_entity_id.
Response
Fields accepted by POST /rest/gp/workers. A field absent from the list is not accepted for the given country.