Skip to navigation

Retrieve a list of published ATS email templates

Lists the published email templates of the organization. Use it to see which templates exist, or to keep a local copy in sync by fetching only those updated since your last check. Drafts and archived templates are not included.

Token scopes: ats:read, worker: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

OR
AuthorizationBearer

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

Query parameters

cursorstringOptional<=1000 characters
Cursor for pagination. Use the nextCursor value from the previous response to get the next page of results.
limitintegerOptional1-100Defaults to 20
Maximum number of email templates to return per page
updated_afterstringOptionalformat: "date-time"

Return only email templates that were updated after this timestamp (ISO 8601 format)

typelist of enumsOptional
Return only email templates of these types. CUSTOM templates are the ones the organization wrote itself.

Response

Successfully retrieved email templates
datalist of objects
Page of email templates.
has_moreboolean
Whether more pages are available.
next_cursorstring or null

Cursor to fetch the next page; null when there are no more pages.

total_countinteger
Total number of email templates matching filters.

Errors

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