---
title: "Get advisor settings (v4)"
method: GET
path: "/api/v1/alpha/advisor-settings-v4/{id}"
tags: ["alpha"]
---

# Get advisor settings (v4)

`GET /api/v1/alpha/advisor-settings-v4/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/alpha/advisor-settings-v4/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Get Advisor's organization-wide settings (id "organization"), which every campaign of every product runs with: when Advisor reviews the list (monthly or weekly), the priorities it weighs, autotracking (off; suggest, where a met website check asks a person to confirm; or complete, where it completes the action), and listSize, how many open actions each review keeps on the list (3, 5, 10, 15 or 20; the rest are set aside, still listed), as the current revision with who saved it and when, and the newest 50 revisions as history, newest first. Revision 0 is the product defaults (monthly, no priorities, autotracking off, 5 actions), before the organization's first save.

## Path parameters

- `id` 'organization', required: "organization", Advisor's one org-wide scope

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- AlphaAdvisorSettingsGetV4Response
  - `id` 'organization', required: "organization", Advisor's one org-wide scope
  - `refreshInterval` 'weekly' | 'monthly', required: When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday
  - `priorities` string, nullable, required: What Advisor weighs, and sets aside what conflicts with; null is none
  - `implementationTracking` 'off' | 'suggest' | 'complete', required: Autotracking: off; suggest (Alpha checks the public website and a met check asks a person to confirm the action is done); complete (a met check completes an action whose status no person has set)
  - `listSize` 3 | 5 | 10 | 15 | 20, required: How many open actions Advisor keeps on the list: each review places that many, the largest opportunities first, and sets the rest aside, still listed
  - `revision` integer, required: The current revision; 0 before the first save, when the product defaults run
  - `savedBy` object, nullable, required: Who saved the current revision; null before any
    - `kind` 'person' | 'api_key' | 'unknown', required: A member (person), an API key (api_key), or unknown for settings carried from before Advisor recorded who saved them
    - `id` string, uuid, nullable, required: The member's user id or the API key's id; null when unknown
    - `name` string: The member's name (else their email) or the key's name, while it exists
  - `savedAt` string, date-time, nullable, required: When the current revision was saved; null before any
  - `history` object[], required: The newest 50 revisions, newest first (the first is the current one); empty before the first save
    - `refreshInterval` 'weekly' | 'monthly', required: When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday
    - `priorities` string, nullable, required: What Advisor weighs, and sets aside what conflicts with; null is none
    - `implementationTracking` 'off' | 'suggest' | 'complete', required: Autotracking: off; suggest (Alpha checks the public website and a met check asks a person to confirm the action is done); complete (a met check completes an action whose status no person has set)
    - `listSize` 3 | 5 | 10 | 15 | 20, required: How many open actions Advisor keeps on the list: each review places that many, the largest opportunities first, and sets the rest aside, still listed
    - `revision` integer, required: The revision's number: each save adds one
    - `savedBy` object, required: Who saved it
      - `kind` 'person' | 'api_key' | 'unknown', required: A member (person), an API key (api_key), or unknown for settings carried from before Advisor recorded who saved them
      - `id` string, uuid, nullable, required: The member's user id or the API key's id; null when unknown
      - `name` string: The member's name (else their email) or the key's name, while it exists
    - `savedAt` string, date-time, required: When it was saved

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)
