---
title: "The workspace, its plan and this period's credits and meetings"
method: GET
path: "/workspace"
tags: ["Workspace"]
---

# The workspace, its plan and this period's credits and meetings

`GET /workspace`

## Request

- Base URL: `https://api.meetdarwin.ai/v1`
- URL: `https://api.meetdarwin.ai/v1/workspace`
- Auth: HTTP bearer

## Response `200`

OK

- Workspace
  - `id` string, uuid, required
  - `object` 'workspace', required
  - `name` string, required
  - `website` string, required
  - `live` boolean, required
  - `installed` boolean, required
  - `installed_at` string, date-time, nullable, required
  - `site_key` string, required
  - `embed_snippet` string, required
  - `plan` 'free' | 'growth' | 'agency' | 'origin' | 'adapt' | 'evolve' | 'apex', required: The plan whose terms apply now: free, growth or agency. origin, adapt, evolve and apex are plans from before credits, kept by subscriptions that have them. More values may be added; treat an unknown one as a paid plan.
  - `billing_status` string, required
  - `period` object, required
    - `start` string, date-time, nullable, required
    - `end` string, date-time, nullable, required
    - `meetings_booked` integer, required
  - `credits` object, nullable, required: This credit period. A credit is a meeting booked or a request that fits; a lead that fails a form's fit rules costs nothing. null for a client workspace billed through an Agency (the pool is the Agency's) and for complimentary access.
    - `period_start` string, date-time, nullable, required
    - `period_end` string, date-time, nullable, required
    - `used` number, required: Credits used this period, in tenths of a credit (31.4).
    - `included` number, required: Credits available this period: included, add-on, rolled over and added free credits (intro credits on Free).
    - `left` number, required
    - `over` number, required: Credits beyond the allowance, billed at the plan's rate.
  - `created_at` string, date-time, nullable, required

## Other responses

- `400`: Invalid request (`invalid_request`, `unsupported_version`).
- `401`: Missing or invalid key (`authentication_required`, `invalid_api_key`).
- `402`: The workspace must add a card before the API can be used (`payment_required`).
- `403`: The key lacks the scope (`insufficient_scope`), the feature is off (`feature_disabled`), or the workspace's plan doesn't include it (`plan_required`, with `required_plan`).
- `404`: No such object in this workspace (`not_found`).
- `409`: Conflicts with the current state (`conflict`, `idempotency_key_in_use`), or the change would leave a live agent with no calendar or live form (`goal_required`).
- `422`: Refused by a rule (`unprocessable`, `idempotency_key_reused`).
- `429`: Rate limited (`rate_limited`) or a monthly allowance used (`quota_exceeded`); see Retry-After.

## Changes

- **2026-10-20** `f93b0bcb454a`: 3 warning, 25 info
  - added the new `agency` enum value to the `plan` response property for the response status `200`
  - added the new `free` enum value to the `plan` response property for the response status `200`
  - added the new `growth` enum value to the `plan` response property for the response status `200`
  - added the optional property `feature` to the response with the `400` status
  - …24 more

[Operation history](https://skmtc.dev/meetdarwin/apis/darwin-api/changes/workspace/get.md)

---

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