Get employee agreement draft preview | Deel

Initiates or polls for async generation of an employee agreement template PDF draft. On first call (no task_id), kicks off generation and returns a task_id with is_processing: true. Poll with ?task_id=<value> until is_processing is false, at which point url contains a signed download link valid for 15 minutes.

Token scopes: contracts:read

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.deel.training/rest/v2/contracts' \
>   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about 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 curl -X GET 'https://api.deel.training/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

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

Path parameters

contract_idstringRequiredformat: "^(([a-z0-9]{6,})|([a-z0-9-_]{20,})|(-2[0-9]{2}))$"

The unique identifier of the EOR contract.

template_idstringRequiredformat: "uuid"

The UUID of the employee agreement template.

Query parameters

task_idintegerOptional

Task ID from a previous response. Omit on first call. Provide on subsequent calls to poll for completion.

Response

Draft preview initiated or ready.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	{
2	"data": {
3	"url": "https://s3.amazonaws.com/employee-agreements/draft-38j84xg-bd48de88-8d87-4f1a-990c-dfba6d757424.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20240601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240601T120000Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
4	"task_id": 987654321,
5	"is_processing": true
6	}
7	}

$	curl -X GET 'https://api.deel.training/rest/v2/contracts' \
>	-H 'Authorization: Bearer YOUR-TOKEN-HERE'

$	curl -G https://api.letsdeel.com/rest/rest/eor/contracts/38j84xg/employee-agreement-templates/bd48de88-8d87-4f1a-990c-dfba6d757424/preview-draft \
>	-H "Authorization: Bearer <token>" \
>	-d task_id=12345