Skip to content

Deel: Retrieve a list of ATS job boards

Deel ats.retrieveAlistOfAtsJobBoards: arguments, response, policy and SDK examples.

← ATS operations · Get started

Operation deel.ats_retrievealistofatsjobboards_v2026_02_09

Provider route: GET /ats/job-boards. 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["ats"]["retrieveAlistOfAtsJobBoards"]>[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.ats.retrieveAlistOfAtsJobBoards(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.retrieve_alist_of_ats_job_boards(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.cursorstringOptional

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 ATS job boards — 200 response body

Referenced models: Retrieve a list of ATS job boards — 200 response body

Retrieve a list of ATS job boards — 200 response body
FieldTypePresenceDescription and constraints
$objectRootPaginated list of job boards with cursor-based pagination
dataarrayRequired within parentPage of job boards
data[]ModelEach itemExpand Retrieve a list of ATS job boards — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more job boards to fetch
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page of results
next_cursor (anyOf 2)nullAlternativeCursor for the next page of results
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of job boards available
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a list of ATS job boards — 200 response body — data item

Retrieve a list of ATS job boards — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRootJob board with type, status, settings, and associated career page configuration if applicable
career_page_settingJSONOptionalCareer page settings associated with the job board
career_page_setting (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS job boards — 200 response body — data item career page setting Career page settings associated with the job board
career_page_setting (anyOf 2)nullAlternative
created_atstringRequired within parentTimestamp when the job board was created
Format: date-time
idstringRequired within parentJob board unique identifier
Format: uuid
settings_jsonJSONRequired within parentJob board specific settings
settings_json (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS job boards — 200 response body — data item settings json Job board specific settings
settings_json (anyOf 2)nullAlternative
status_enumstringRequired within parentCurrent status of the job board
Known values: ENABLED, DISABLED, ARCHIVED
type_enumstringRequired within parentType of the job board
Known values: INTERNAL_CAREER_PAGE, EXTERNAL_CAREER_PAGE, LINKEDIN
updated_atstringRequired within parentTimestamp when the job board was last updated
Format: date-time

Referenced models: Retrieve a list of ATS job boards — 200 response body — data item settings json Job board specific settings, Retrieve a list of ATS job boards — 200 response body — data item career page setting Career page settings associated with the job board

Retrieve a list of ATS job boards — 200 response body — data item settings json Job board specific settings
FieldTypePresenceDescription and constraints
$objectRootJob board specific settings
company_idstringOptionalCompany ID for external job boards (e.g., LinkedIn)
Retrieve a list of ATS job boards — 200 response body — data item career page setting Career page settings associated with the job board
FieldTypePresenceDescription and constraints
$objectRootCareer page settings associated with the job board
banner_image_urlJSONRequired within parent
banner_image_url (anyOf 1)stringAlternativeURL for the banner image
banner_image_url (anyOf 2)nullAlternativeURL for the banner image
dark_mode_color_primary_hexcodeJSONRequired within parent
dark_mode_color_primary_hexcode (anyOf 1)stringAlternativePrimary color hex code for dark mode
dark_mode_color_primary_hexcode (anyOf 2)nullAlternativePrimary color hex code for dark mode
dark_mode_logo_urlJSONRequired within parent
dark_mode_logo_url (anyOf 1)stringAlternativeURL for the logo in dark mode
dark_mode_logo_url (anyOf 2)nullAlternativeURL for the logo in dark mode
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription displayed on the career page
description (anyOf 2)nullAlternativeDescription displayed on the career page
idstringRequired within parentCareer page setting unique identifier
Format: uuid
is_primarybooleanRequired within parentWhether this is the primary career page setting
light_mode_color_primary_hexcodeJSONRequired within parent
light_mode_color_primary_hexcode (anyOf 1)stringAlternativePrimary color hex code for light mode
light_mode_color_primary_hexcode (anyOf 2)nullAlternativePrimary color hex code for light mode
light_mode_logo_urlJSONRequired within parent
light_mode_logo_url (anyOf 1)stringAlternativeURL for the logo in light mode
light_mode_logo_url (anyOf 2)nullAlternativeURL for the logo in light mode
organization_idstringRequired within parentOrganization unique identifier
Format: uuid
preferred_organization_namestringRequired within parentDisplay name for the organization on the career page
should_show_banner_on_job_details_pagebooleanRequired within parentWhether to show the banner on job details page
should_show_job_filtersbooleanRequired within parentWhether to show job filtering options
should_show_logobooleanRequired within parentWhether to show the organization logo
titleJSONRequired within parent
title (anyOf 1)stringAlternativeTitle displayed on the career page
title (anyOf 2)nullAlternativeTitle displayed on the career page
url_slugstringRequired within parentURL slug for the career page

SDK function policy ID: deel.ats_retrievealistofatsjobboards_v2026_02_09. Catalog operation: ats_retrievealistofatsjobboards_v2026_02_09. 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-09"}

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.