---
title: "Get the account WhatsApp settings"
method: GET
path: "/public/v1/settings/whatsapp"
tags: ["Data & Sync"]
---

# Get the account WhatsApp settings

`GET /public/v1/settings/whatsapp`

Returns the account-wide defaults for personal WhatsApp sync: whether contacts are created automatically, which chats are in scope, and whether muted, archived, or group chats are excluded. These govern each user's own connected WhatsApp — the Business numbers your agents answer on are separate, under Agent Channels. Read-only. A single write here changes behaviour for every user in the account at once — including data residency, retention and who may see whose activity — so these defaults are edited in the app by an administrator and there is no API or CLI write. `preferenceOverridePolicy` tells you whether they act as defaults each user may change in their own Max settings or as hard settings they cannot. Accepts an account API key, or a USER API key belonging to an OWNER or ADMIN.

## Response `200`

Account WhatsApp settings

- object
  - `ok` true, required
  - `data` object, required
    - `autoCreateContactsMode` 'ALL_CONTACTS' | 'SELECTIVE' | 'NONE', required
    - `linkMaxContactToPeople` boolean, required
    - `peopleSyncDefault` boolean, required
    - `activitySyncDefault` boolean, required
    - `syncScopeDefault` 'ALL_CHATS' | 'ONE_ON_ONE_ONLY' | 'EXISTING_CONTACTS_ONLY', required
    - `autoCreateContactsFromGroupsDefault` boolean, required
    - `excludeMutedChatsDefault` boolean, required
    - `excludeArchivedChatsDefault` boolean, required
    - `assignRecordToCreator` boolean, required
    - `peopleSyncRecordTypeId` number, nullable, required
    - `preferenceOverridePolicy` 'NONE' | 'ADMINS_AND_OWNERS' | 'ALL_USERS', required
    - `ignoreListOverridePolicy` 'NONE' | 'ADMINS_AND_OWNERS' | 'ALL_USERS', required
    - `adminViewAllActivity` boolean, required

## Other responses

- `401` — Unauthorized — the API key is missing or invalid
- `404` — The USER API key does not belong to an OWNER or ADMIN of the account

## Changes

- **2026-10-03** `666cd9efa9f3` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/getfrontline/apis/public-api/changes/public/v1/settings/whatsapp/get.md)

---

[API](https://skmtc.dev/getfrontline/apis/public-api.md) · [All operations](https://skmtc.dev/getfrontline/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getfrontline/apis/public-api/revisions/666cd9efa9f3?raw)