---
title: "Get the Max overview settings"
method: GET
path: "/public/v1/max/settings/overview"
tags: ["Max Settings"]
---

# Get the Max overview settings

`GET /public/v1/max/settings/overview`

Returns the assistant's headline state for the calling user: whether Max is enabled, the WhatsApp and Slack connections, and a summary of connected accounts. This is the best first call for understanding what a user's Max can currently do. Requires a USER API key.

## Response `200`

Overview settings

- object
  - `ok` true, required
  - `data` object, required
    - `status` 'ENABLED' | 'DISABLED', required
    - `phoneNumber` string, nullable, required
    - `phoneNumberValidated` boolean, required
    - `enabled` boolean, required
    - `freeDaysAllowed` number, required
    - `freeDaysActivatedAt` string, nullable, required
    - `maxSeat` object, nullable, required
      - `id` number, required
      - `assignedAt` string, nullable, required
      - `isActive` boolean, required
      - `billingPlan` object, required
        - `id` number, required
        - `name` string, required
        - `description` string, nullable, required
        - `subscriptionInterval` 'MONTHLY' | 'ANNUAL', required
        - `capabilities` string[], required
    - `connectedAccounts` object, required
      - `gmail` object, required
        - `isConnected` boolean, required
        - `email` string, nullable, required
        - `connectedAt` string, nullable, required
        - `id` number, nullable
      - `googleCalendar` object, required
        - `isConnected` boolean, required
        - `email` string, nullable, required
        - `connectedAt` string, nullable, required
        - `id` number, nullable
      - `outlook` object, required
        - `isConnected` boolean, required
        - `email` string, nullable, required
        - `connectedAt` string, nullable, required
        - `id` number, nullable
      - `slack` object, required
        - `isConnected` boolean, required
        - `slackUserId` string, nullable, required
        - `slackTeamName` string, nullable, required
      - `teams` object, required
        - `isConnected` boolean, required
        - `teamsUserId` string, nullable, required
        - `teamsTenantId` string, nullable, required
        - `teamsDisplayName` string, nullable, required
    - `availableTools` object, nullable
    - `timezone` string, nullable, required
    - `maxAgentId` string, required
    - `maxUserProfileId` number, nullable, required

## Other responses

- `401` — Unauthorized — a USER API key is required

## Changes

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

[Change history](https://skmtc.dev/getfrontline/apis/public-api/changes/public/v1/max/settings/overview/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)