---
title: "Get workspace status"
method: GET
path: "/api/v1/status"
tags: ["Workspace"]
---

# Get workspace status

`GET /api/v1/status`

## Request

- Base URL: `https://www.vestiarion.xyz`
- URL: `https://www.vestiarion.xyz/api/v1/status`
- Auth: HTTP bearer

What this workspace is, and what it can actually do. The first call a client should make: whether payments and yield are live, simulated or unavailable, the workspace clock, running totals, and a description of its configuration. Secrets are never included.

`unavailable` means nothing can pay in this workspace now: its Circle credentials are stored but cannot be read; or it is on Arc mainnet with no Circle account connected yet, or not live yet; or this deployment has Arc mainnet switched off. A cycle refuses to pay then rather than fall back to simulation, so status does not report it as `simulate`. Yield is also `unavailable` on a network with no yield reserve, such as Arc mainnet.

## Response `200`

OK

- GetStatusResponse
  - `data` object, required: What this workspace is, and what it can actually do.
    - `businessName` string, required: The workspace's name.
    - `provenance` object, required: Payments and yield differ and are reported separately, as in the UI. `unavailable` means nothing can pay in the workspace now: its Circle credentials are stored but could not be read; or it is on Arc mainnet with no Circle account connected yet, or not live yet; or Arc mainnet is switched off on this deployment; or payments are switched off for every workspace, or whether they are could not be read. Cycles refuse to pay then rather than simulate, so neither leg is live or simulated. Yield is also `unavailable` on a network with no yield reserve, such as Arc mainnet.
      - `payments` 'live' | 'simulate' | 'unavailable', required
      - `yield` 'live' | 'simulate' | 'unavailable', required
      - `screening` 'live' | 'simulate', required
    - `clock` object, required: The workspace's clock, and when its last cycle ran.
      - `mode` 'real' | 'simulate', required
      - `day` number, required
      - `lastCycleAt` string, nullable, required
    - `totals` object, required: Running totals across the workspace.
      - `decisionsLogged` number, required
      - `totalPaidOut` number, required
      - `flagged` number, required
    - `configuration` object, required: What is configured for this workspace, as flags and modes. Never carries a secret.
    - `apiVersion` 'v1', required

## Other responses

- `401`: unauthorized
- `403`: forbidden
- `500`: internal

---

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