Skip to navigation

Get additional information

Beta

Lets a worker review the additional information saved on their own EOR employee agreement — data that could previously only be written, not read back. Absent values are omitted from the response rather than returned as null.

Token scopes: worker: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-05.

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/

Path parameters

contract_idstringRequired
Deel contract id.

Response

Successful operation.
dataobject

Only fields with a saved value are included. Keys not listed above are country/state-specific additional information fields, keyed the same way as the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error