---
title: "Account state"
method: GET
path: "/v1/account"
tags: ["Account"]
---

# Account state

`GET /v1/account`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/account`
- Auth: HTTP bearer

## Response `200`

OK

- AccountState
  - `status` 'onboarding' | 'active' | 'suspended' | 'closed', required
  - `handle` string, nullable, required
  - `confirmPhrase` string, required
  - `closedAt` string, date-time, required
  - `purgeAfter` string, date-time, required
  - `closedBy` 'owner' | 'staff', nullable, required
  - `canUndo` boolean, required
  - `exportAvailable` boolean, required
  - `stepUpMaxAgeS` integer, required
  - `graceDays` integer, required
  - `forwards` boolean
  - `stopCode` string, nullable
  - `stopAlt` string, nullable
  - `forwardPhones` object[]
    - `phone` string, required
    - `code` string, nullable, required
    - `alt` string, nullable, required
  - `suspension` AccountSuspension
    - `reason` 'payment' | 'unusual_calls' | 'reports' | 'identity' | 'other', required
    - `note` string, nullable, required
    - `takesMessages` boolean, required
    - `messagesKept` integer, required
    - `reviewRequested` boolean, required
    - `since` string, date-time, required

## Other responses

- `401`: Missing, expired or invalid bearer token.
- `500`: Unexpected server error (reported to Sentry).

---

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