Workspace

Get current workspace

Returns information about the workspace this request resolved to: name, plan, credit balance, member count and the role of the user who created the key.

A key bound to one workspace always resolves to it. A key bound to several resolves to the one in the X-Workspace-Id header, so call this whenever you need to confirm which workspace a request is actually hitting.

get/workspace

Request

  • Base URL: https://api.cut.pro/api/v1
  • URL: https://api.cut.pro/api/v1/workspace
  • Auth: API key in header X-Api-Key

Response

Response for status 200

idstring required

Unique workspace ID

namestring required

Workspace name

is_personalboolean required

true if this is the user's personal workspace, false if it is a team workspace

statusstring required

Workspace status — typically active

role'admin' | 'member' required
plan_idstring required

ID of the current subscription plan

plan_namestring nullable required

Display name of the current plan

plan_is_freeboolean required

true if the workspace is on the free plan

creditsnumber required

Current credit balance for this workspace

credits_unlimitedboolean required

true while usage is free for this workspace: jobs run without consuming the balance

credits_unlimited_untilstring nullable required

ISO 8601 timestamp when the free-usage window ends; null means it has no end date

seat_countnumber required

Extra purchased seats. Legacy: always 0 today, seats come with the plan

max_total_seatsnumber required

Maximum total seats available on the current plan, including any plan-included free seats

member_countnumber required

Total members currently in the workspace, including the owner

created_atstring required

ISO 8601 timestamp of when the workspace was created

Changes

No recorded changes to this operation across all 1 revision of this API.