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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve a list of ATS job boards — 200 response body |
Referenced models: Retrieve a list of ATS job boards — 200 response body
Schemas
Section titled “Schemas”Retrieve a list of ATS job boards — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated list of job boards with cursor-based pagination |
data | array | Required within parent | Page of job boards |
data[] | Model | Each item | Expand Retrieve a list of ATS job boards — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more job boards to fetch |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page of results |
next_cursor (anyOf 2) | null | Alternative | Cursor for the next page of results |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of job boards available |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job board with type, status, settings, and associated career page configuration if applicable |
career_page_setting | JSON | Optional | Career page settings associated with the job board |
career_page_setting (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
created_at | string | Required within parent | Timestamp when the job board was created Format: date-time |
id | string | Required within parent | Job board unique identifier Format: uuid |
settings_json | JSON | Required within parent | Job board specific settings |
settings_json (anyOf 1) | Model | Alternative | Expand Retrieve a list of ATS job boards — 200 response body — data item settings json Job board specific settings |
settings_json (anyOf 2) | null | Alternative | |
status_enum | string | Required within parent | Current status of the job board Known values: ENABLED, DISABLED, ARCHIVED |
type_enum | string | Required within parent | Type of the job board Known values: INTERNAL_CAREER_PAGE, EXTERNAL_CAREER_PAGE, LINKEDIN |
updated_at | string | Required within parent | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job board specific settings |
company_id | string | Optional | Company 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Career page settings associated with the job board |
banner_image_url | JSON | Required within parent | |
banner_image_url (anyOf 1) | string | Alternative | URL for the banner image |
banner_image_url (anyOf 2) | null | Alternative | URL for the banner image |
dark_mode_color_primary_hexcode | JSON | Required within parent | |
dark_mode_color_primary_hexcode (anyOf 1) | string | Alternative | Primary color hex code for dark mode |
dark_mode_color_primary_hexcode (anyOf 2) | null | Alternative | Primary color hex code for dark mode |
dark_mode_logo_url | JSON | Required within parent | |
dark_mode_logo_url (anyOf 1) | string | Alternative | URL for the logo in dark mode |
dark_mode_logo_url (anyOf 2) | null | Alternative | URL for the logo in dark mode |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description displayed on the career page |
description (anyOf 2) | null | Alternative | Description displayed on the career page |
id | string | Required within parent | Career page setting unique identifier Format: uuid |
is_primary | boolean | Required within parent | Whether this is the primary career page setting |
light_mode_color_primary_hexcode | JSON | Required within parent | |
light_mode_color_primary_hexcode (anyOf 1) | string | Alternative | Primary color hex code for light mode |
light_mode_color_primary_hexcode (anyOf 2) | null | Alternative | Primary color hex code for light mode |
light_mode_logo_url | JSON | Required within parent | |
light_mode_logo_url (anyOf 1) | string | Alternative | URL for the logo in light mode |
light_mode_logo_url (anyOf 2) | null | Alternative | URL for the logo in light mode |
organization_id | string | Required within parent | Organization unique identifier Format: uuid |
preferred_organization_name | string | Required within parent | Display name for the organization on the career page |
should_show_banner_on_job_details_page | boolean | Required within parent | Whether to show the banner on job details page |
should_show_job_filters | boolean | Required within parent | Whether to show job filtering options |
should_show_logo | boolean | Required within parent | Whether to show the organization logo |
title | JSON | Required within parent | |
title (anyOf 1) | string | Alternative | Title displayed on the career page |
title (anyOf 2) | null | Alternative | Title displayed on the career page |
url_slug | string | Required within parent | URL slug for the career page |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}