---
title: "Get Setup Status"
method: GET
path: "/setup"
tags: ["Setup"]
---

# Get Setup Status

`GET /setup`

## Request

- Base URL: `https://api.supersend.io/v2`
- URL: `https://api.supersend.io/v2/setup`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/supersend/apis/supersend-api/docs/setup/get.ts> (a function with typed inputs; its response is checked against the schema)

One call to see what an account still needs before it can send: billing (trial or plan),
inboxes and warmup, sender profiles, LinkedIn accounts, and campaigns.

`next_steps` lists what is missing, in order. Each step says who does it: `agent` (with the
MCP tool and API call to use), `human` (with a dashboard link for browser-only steps such as
adding a card or Google/Microsoft sign-in), or `human_or_agent`.

Warmup counts as done 14 days after it starts. `ready_to_send` is true when billing allows
sending and at least one sender profile has an active inbox.

## Query parameters

- `team_id` string, uuid

## Response `200`

Setup status and next steps

- SetupStatusResponse
  - `success` boolean
  - `request_id` string
  - `data` SetupStatus
    - `object` string
    - `ready_to_send` boolean: True when billing allows sending and at least one sender profile has an active inbox.
    - `team` object
      - `id` string, uuid
      - `name` string
    - `billing` object
      - `status` 'trialing' | 'active' | 'needs_card' | 'inactive': `trialing`: in the free trial. `active`: on a plan. `needs_card`: no card yet (add one to start the trial or pick a plan). `inactive`: billing lapsed and must be reactivated.
      - `can_send` boolean
      - `plan` string, nullable
      - `trial_available` boolean: True when adding a card starts the free trial (status is `needs_card` and the trial wasn't used).
      - `trial_ends_at` string, date-time, nullable: Set only while `trialing`.
    - `inboxes` object
      - `total` integer
      - `active` integer
      - `disabled` integer
      - `warming` integer: Active inboxes in warmup for less than 14 days.
      - `warmed` integer: Active inboxes in warmup for 14 days or more.
      - `not_warming` integer: Active inboxes with warmup off.
      - `in_sender_profile` integer: Active inboxes assigned to a sender profile.
      - `days_until_first_warmed` integer, nullable: 0 when an inbox is already warmed; days until the first one is; null when none are warming.
    - `sender_profiles` object
      - `total` integer
      - `with_active_inboxes` integer
    - `linkedin` object
      - `enabled` boolean: Whether LinkedIn is available to this organization.
      - `accounts` integer
    - `campaigns` object: Top-level campaigns (subsequences not counted).
      - `total` integer
      - `active` integer
      - `drafts` integer
    - `next_steps` SetupNextStep[]: What's still missing, in order. Empty when nothing is.
      - `id` 'add_card' | 'reactivate_billing' | 'add_inboxes' | 'fix_disabled_inboxes' | 'start_warmup' | 'group_inboxes' | 'create_campaign', required
      - `who` 'human' | 'agent' | 'human_or_agent', required
      - `mcp_tool` string: MCP tool for the agent to call (agent steps).
      - `api` string: Equivalent API call (agent steps).
      - `url` string, uri: Dashboard link for the human (human steps).
      - `why` string, required
      - `inboxes` object[]: `fix_disabled_inboxes` only. Up to 25 disabled inboxes.
        - `id` string, uuid
        - `email` string
        - `status` string, nullable
      - `sender_ids` string[]: `start_warmup` only. Up to 25 inbox IDs with warmup off.
    - `links` object: Dashboard links for steps that need a browser. Each opens the sign-in page first if needed.
      - `add_card` string, uri
      - `billing` string, uri
      - `connect_google_or_outlook` string, uri
      - `connect_smtp` string, uri
      - `buy_inboxes` string, uri
      - `connect_linkedin` string, uri: Omitted when LinkedIn isn't enabled for the organization.

## Other responses

- `400`: Bad Request - Invalid parameters
- `401`: Unauthorized - Invalid or missing API key
- `403`: Forbidden - Access denied
- `404`: Not Found - Resource does not exist

## Changes

- **2026-10-03** `e4e7dcbc09be`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/supersend/apis/supersend-api/changes/setup/get.md)

---

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