Reference

Workspace

Returns the active workspace's plan + limits + usage. Test-mode keys see the same values a live key would; usage queries filter to mode='live' (test activity is free).

Retrieve the workspace bound to this key

get /v1/workspace

Returns the workspace's plan, limits, and current usage. Useful for agents bootstrapping context — `usage` against `limits` tells you how much headroom is left before quota.

curl TypeScript

curl -X GET "https://api.clement.so/v1/workspace" \
  -H "Authorization: Bearer $CLEMENT_API_KEY"

import { Clement } from "@clement/sdk";

const c = new Clement({ apiKey: process.env.CLEMENT_API_KEY! });
const result = await c.request("GET", `/v1/workspace`);

Response200

Property Type Description

id required string

object required

enum (1)

"workspace"

name required string

slug required string | null

plan required

enum (3) | null

Active subscription tier. null when no entitling subscription is in effect.

"pro""scale""hyper"

plan_status required

enum (3) | null

Status of the active subscription, mirroring Stripe values.

"trialing""active""past_due"

trial_ends_at required string (date-time) | null

current_period_end required string (date-time) | null

cancel_at_period_end required boolean

limits required

WorkspaceLimits | null

Plan caps. null when no active subscription.

Show properties

Property	Type	Description
`contacts` required	integer \| null	null = unlimited
`sends_per_month` required	integer \| null	null = unlimited
`webhooks` required	integer \| null	null = unlimited
`inboxes` required	integer \| null	null = unlimited

usage required

WorkspaceUsage

Show properties

Property	Type	Description
`contacts` required	integer
`sends_this_month` required	integer	Live sends created this calendar month (UTC) that are queued, sending, sent or failed. Sends canceled before pickup don't count.
`webhooks` required	integer
`inboxes` required	integer

created_at required string (date-time)

Example response

{
  "id": "wsp_01HZ8X3J9K7P2QV6R5N4M3T2LD",
  "object": "workspace",
  "name": "Acme",
  "slug": "acme",
  "plan": "scale",
  "plan_status": "active",
  "trial_ends_at": null,
  "current_period_end": "2026-05-15T00:00:00Z",
  "cancel_at_period_end": false,
  "limits": {
    "contacts": 30000,
    "sends_per_month": 100000,
    "webhooks": 20,
    "inboxes": null
  },
  "usage": {
    "contacts": 4218,
    "sends_this_month": 12483,
    "webhooks": 3,
    "inboxes": 7
  },
  "created_at": "2026-03-01T08:00:00Z"
}

Errors

400 Invalid request
401 Authentication failed
403 Insufficient scope
404 Not found
409 Conflict
422 Validation failed
429 Rate limited

See Errors for the full envelope and per-code reference.