Skip to content

Deel: Retrieve a list of published ATS email templates

Deel atsEmailTemplates.retrieveAlistOfPublishedAtsEmailTemplates: arguments, response, policy and SDK examples.

← ATS email templates operations · Get started

Operation deel.atsemailtemplates_retrievealistofpublishedatsemailtemplates_v2026_02_11

Provider route: GET /ats/email-templates. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["atsEmailTemplates"]["retrieveAlistOfPublishedAtsEmailTemplates"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.atsEmailTemplates.retrieveAlistOfPublishedAtsEmailTemplates(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.ats_email_templates.retrieve_alist_of_published_ats_email_templates(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptionalMaximum length: 1000
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.updated_afterstringOptionalFormat: date-time
query.typearrayOptional
query.type[]ModelEach itemExpand Retrieve a list of published ATS email templates — request body — query type item

Referenced models: Retrieve a list of published ATS email templates — request body — query type item

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a list of published ATS email templates — 200 response body

Referenced models: Retrieve a list of published ATS email templates — 200 response body

Retrieve a list of published ATS email templates — request body — query type item
FieldTypePresenceDescription and constraints
$stringRootOne of: CUSTOM, DEFAULT_APPLICATION_CONFIRMATION, DEFAULT_ARCHIVE, DEFAULT_OFFER, DEFAULT_CANDIDATE_INTERVIEW_SCHEDULING, DEFAULT_QUESTIONNAIRE, DEFAULT_REFERRAL_CONFIRMATION, DEFAULT_DOCUMENT, DEFAULT_INTERVIEW_SCHEDULED_CANDIDATE, DEFAULT_INTERVIEW_SCHEDULED_INTERVIEWERS, DEFAULT_INTERVIEW_SCHEDULED_RECRUITERS, DEFAULT_INTERVIEW_RESCHEDULED_CANDIDATE, DEFAULT_INTERVIEW_RESCHEDULED_INTERVIEWERS, DEFAULT_INTERVIEW_RESCHEDULED_RECRUITERS, DEFAULT_INTERVIEW_CANCELLED_CANDIDATE, DEFAULT_INTERVIEW_CANCELLED_INTERVIEWERS, DEFAULT_INTERVIEW_CANCELLED_RECRUITERS, DEFAULT_INTERVIEWER_ADDED, DEFAULT_INTERVIEWER_REMOVED, DEFAULT_INTERVIEWERS_CHANGED_RECRUITERS, DEFAULT_INTERVIEW_RESCHEDULE_REQUEST_CANDIDATE, DEFAULT_INTERVIEW_LOCATION_UPDATED_CANDIDATE
Retrieve a list of published ATS email templates — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of email templates.
data[]ModelEach itemExpand Retrieve a list of published ATS email templates — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to fetch the next page; null when there are no more pages.
next_cursor (anyOf 2)nullAlternativeCursor to fetch the next page; null when there are no more pages.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of email templates matching filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a list of published ATS email templates — 200 response body — data item

Retrieve a list of published ATS email templates — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
bodystringRequired within parentEmail body as HTML. May contain ${{token}} placeholders that are filled in when the email is sent.
created_atstringRequired within parentTimestamp of when the email template was created
Format: date-time
idstringRequired within parentEmail template unique identifier
Format: uuid
subjectstringRequired within parentEmail subject. May contain ${{token}} placeholders that are filled in when the email is sent.
titlestringRequired within parentEmail template title
typeModelRequired within parentExpand Retrieve a list of published ATS email templates — 200 response body — data item type
Template type. CUSTOM templates are written by the organization; DEFAULT_* types back built-in emails.
updated_atstringRequired within parentTimestamp of when the email template was last updated
Format: date-time

Referenced models: Retrieve a list of published ATS email templates — 200 response body — data item type

Retrieve a list of published ATS email templates — 200 response body — data item type
FieldTypePresenceDescription and constraints
$stringRootTemplate type. CUSTOM templates are written by the organization; DEFAULT_* types back built-in emails.
Known values: CUSTOM, DEFAULT_APPLICATION_CONFIRMATION, DEFAULT_ARCHIVE, DEFAULT_OFFER, DEFAULT_CANDIDATE_INTERVIEW_SCHEDULING, DEFAULT_QUESTIONNAIRE, DEFAULT_REFERRAL_CONFIRMATION, DEFAULT_DOCUMENT, DEFAULT_INTERVIEW_SCHEDULED_CANDIDATE, DEFAULT_INTERVIEW_SCHEDULED_INTERVIEWERS, DEFAULT_INTERVIEW_SCHEDULED_RECRUITERS, DEFAULT_INTERVIEW_RESCHEDULED_CANDIDATE, DEFAULT_INTERVIEW_RESCHEDULED_INTERVIEWERS, DEFAULT_INTERVIEW_RESCHEDULED_RECRUITERS, DEFAULT_INTERVIEW_CANCELLED_CANDIDATE, DEFAULT_INTERVIEW_CANCELLED_INTERVIEWERS, DEFAULT_INTERVIEW_CANCELLED_RECRUITERS, DEFAULT_INTERVIEWER_ADDED, DEFAULT_INTERVIEWER_REMOVED, DEFAULT_INTERVIEWERS_CHANGED_RECRUITERS, DEFAULT_INTERVIEW_RESCHEDULE_REQUEST_CANDIDATE, DEFAULT_INTERVIEW_LOCATION_UPDATED_CANDIDATE

SDK function policy ID: deel.atsemailtemplates_retrievealistofpublishedatsemailtemplates_v2026_02_11. Catalog operation: atsemailtemplates_retrievealistofpublishedatsemailtemplates_v2026_02_11. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["ats:read", "worker:read"]

Pinned headers: {"X-Version": "2026-02-11"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.