Skip to content

Deel: 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, field data / item / career_page_setting / Career page settings associated with the job board. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: 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

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.