---
title: "Retrieve board settings"
method: GET
path: "/settings"
tags: ["Settings"]
---

# Retrieve board settings

`GET /settings`

## Request

- Base URL: `https://api.cavuno.com/v1`
- URL: `https://api.cavuno.com/v1/settings`
- Auth: HTTP bearer

Retrieves the settings for your board.

## Response `200`

Successful response.

- Settings
  - `id` string, required
  - `object` 'settings', required
  - `accountId` string, required
  - `name` string, required
  - `slug` string, required
  - `primaryDomainId` string, nullable, required
  - `logoUrl` string, nullable, required
  - `heroUrl` string, nullable, required
  - `config` OperatorSettingsConfig, required
    - `passwordProtectionEnabled` boolean
    - `jobAlertsEnabled` boolean
    - `jobRecommendationsEnabled` boolean, required
    - `recommendedTalentEnabled` boolean, required
    - `candidatesEnabled` boolean
    - `employersEnabled` boolean
    - `blogEnabled` boolean
    - `impressumEnabled` boolean
    - `requireApprovalFreeJobs` boolean
    - `postingRequiresMembership` boolean
    - `requireApprovalAggregatedJobs` boolean
    - `registrationWallEnabled` boolean
    - `nativeApplicationsEnabled` boolean
    - `countryGatingMode` 'sponsored_only' | 'all_jobs': Apply country gate mode. sponsored_only is the minimum mode for Sponsored inventory.
    - `applicantMessagingEnabled` boolean
    - `applyUrlAttribution` union: Query parameters appended to outbound apply URLs. Absent means the default `ref={{boardHost}}`.
      - object
        - `mode` 'off', required
      - object
        - `mode` 'append', required
        - `params` ApplyUrlParamTemplate[], required
          - `key` string, required
          - `valueTemplate` string, required
    - `requireCookieConsent` boolean
    - `showCavunoBranding` boolean
    - `cookieBannerTitle` string
    - `cookieBannerDescription` string
    - `cookieBannerRejectLabel` string
    - `cookieBannerAcceptLabel` string
    - `cookieBannerManageLabel` string
    - `talentNavLabel` string
    - `contactEmail` string, nullable
    - `companyLegalName` string, nullable
    - `companyAddress` string, nullable
    - `companyWebsiteUrl` string, nullable
    - `companyXHandle` string, nullable
    - `companyFacebookUrl` string, nullable
    - `companyLinkedinUrl` string, nullable
    - `companyInstagramUrl` string, nullable
    - `ga4MeasurementId` string, nullable
    - `gtmContainerId` string, nullable
    - `metaPixelId` string, nullable
    - `linkedinPartnerId` string, nullable
    - `linkedinConversionSignUpId` string, nullable
    - `linkedinConversionLoginId` string, nullable
    - `linkedinConversionApplyClickId` string, nullable
    - `linkedinConversionApplySubmitId` string, nullable
    - `linkedinConversionJobAlertSubscribeId` string, nullable
    - `passwordProtectionMessage` string, nullable: Deprecated: no longer shown on the password gate. Gate copy now lives on the board's builder-designed coming-soon page. Still accepted and returned for compatibility; it will be removed with the hosted board.
    - `defaultJobDurationDays` integer
    - `talentDirectoryVisibility` 'off' | 'public' | 'employers_only'
    - `defaultCandidateProfileVisibility` 'hidden' | 'logged_in_only' | 'public'
    - `signInMethods` SignInMethods, required: Which built-in sign-in methods are switched on for candidates and for employers. SSO connections are switched on per role on `/sso-connections`.
      - `candidate` BuiltInSignInMethods, required
        - `password` boolean, required: Email and password.
        - `magicLink` boolean, required: Emailed one-time sign-in link.
        - `google` boolean, required: Sign in with Google.
        - `linkedin` boolean, required: Sign in with LinkedIn.
      - `employer` BuiltInSignInMethods, required
        - `password` boolean, required: Email and password.
        - `magicLink` boolean, required: Emailed one-time sign-in link.
        - `google` boolean, required: Sign in with Google.
        - `linkedin` boolean, required: Sign in with LinkedIn.
  - `createdAt` string, required
  - `updatedAt` string, required

## Other responses

- `default`: An error. Every non-2xx response uses the same envelope; see the Errors section of the introduction.

## Changes

- **2026-10-20** `de39bd3242e2`: 9 info
  - added the optional property `config/ga4MeasurementId` to the response with the `200` status
  - added the optional property `config/gtmContainerId` to the response with the `200` status
  - added the optional property `config/linkedinConversionApplyClickId` to the response with the `200` status
  - added the optional property `config/linkedinConversionApplySubmitId` to the response with the `200` status
  - …5 more
- **2026-10-19** `c34152c38176`: 1 info
  - added the optional property `error/upgrade` to the response with the `default` status

[Operation history](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/changes/settings/get.md)

---

[API](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api.md) · [All operations](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/revisions/d5974dabff14?raw)