Sign in
Max Settings

Get the Max overview settings

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.

get/public/v1/max/settings/overview

Response

Overview settings

oktrue required

Example response

{
  "ok": true,
  "data": {
    "status": "ENABLED",
    "phoneNumber": "example",
    "freeDaysAllowed": 1,
    "freeDaysActivatedAt": "example",
    "maxSeat": {
      "id": 1,
      "assignedAt": "example",
      "billingPlan": {
        "id": 1,
        "name": "example",
        "description": "example",
        "subscriptionInterval": "MONTHLY",
        "capabilities": [
          "MAX_PLAN"
        ]
      }
    },
    "connectedAccounts": {
      "gmail": {
        "email": "example",
        "connectedAt": "example",
        "id": 1
      },
      "googleCalendar": {
        "email": "example",
        "connectedAt": "example",
        "id": 1
      },
      "outlook": {
        "email": "example",
        "connectedAt": "example",
        "id": 1
      },
      "slack": {
        "slackUserId": "example",
        "slackTeamName": "example"
      },
      "teams": {
        "teamsUserId": "example",
        "teamsTenantId": "example",
        "teamsDisplayName": "example"
      }
    },
    "timezone": "example",
    "maxUserProfileId": 1
  }
}

Changes

Changed in 1 of the 2 revisions of this API.1