Get Workspace Info

Endpoint

GET https://api.parcelengineering.com/api/v1/workspace

Returns the workspace’s effective plan, the full entitlement set, seat usage (active members and pending invites vs the seat limit), and the workspace settings object.

Get workspace info costs 0 credits. It never throttles, so a workspace at its credit ceiling can always call this endpoint.

Caution

The Workspace API requires the Pro plan. A request from a non-Pro workspace receives 403 forbidden.

Query parameters

Parameter	Type	Required	Description
workspace_id	string (UUID)	No	Override the workspace resolved from your API key. Useful for admin tooling.

Example

cURL

Get workspace info

curl https://api.parcelengineering.com/api/v1/workspace \
  -H "Authorization: Bearer pcl_your_api_key"

JavaScript

Get workspace info

const response = await fetch(
  'https://api.parcelengineering.com/api/v1/workspace',
  {
    headers: {
      'Authorization': 'Bearer pcl_your_api_key',
    },
  }
);

const { data, metadata } = await response.json();

Response

Response

{
  "data": {
    "plan": "pro",
    "entitlements": {
      "signalHistoryDays": null,
      "seats": 10,
      "emailAlerts": true,
      "teamsAlerts": true,
      "apiCreditCeiling24h": 250000
    },
    "seats": {
      "used": 3,
      "limit": 10,
      "members": 2,
      "pending_invites": 1
    },
    "settings": {}
  },
  "metadata": { "credits": 0 }
}

Response fields

Field	Type	Description
data.plan	string	The workspace’s effective plan (e.g. "pro"). Reflects any plan override applied by an admin.
data.entitlements	object	The full entitlement set for the effective plan.
data.entitlements.signalHistoryDays	integer or null	How many days of signal history the workspace can access. null means unlimited.
data.entitlements.seats	integer	Total seat entitlement (base seats plus any purchased additions).
data.entitlements.emailAlerts	boolean	Whether the plan includes email alert delivery.
data.entitlements.teamsAlerts	boolean	Whether the plan includes Microsoft Teams alert delivery.
data.entitlements.apiCreditCeiling24h	integer	Maximum API credits the workspace may consume in a rolling 24-hour window.
data.seats.used	integer	Total occupied seats: active members plus pending invites.
data.seats.limit	integer	Seat entitlement ceiling (equals entitlements.seats).
data.seats.members	integer	Number of active workspace members.
data.seats.pending_invites	integer	Number of invitations that have been sent but not yet accepted.
data.settings	object	Workspace settings (free-form JSON). May be an empty object {} if no settings have been configured.
metadata.credits	integer	Always 0.

Errors

Status	Code	Description
403	forbidden	The workspace is not on the Pro plan.