Skip to main content
GET
Get a workspace

Authorizations

Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

id
string<uuid>
required

Workspace ID

Response

Workspace retrieved successfully

id
string<uuid>

Unique identifier for the workspace

name
string

Workspace name

Maximum string length: 255
protected
boolean

Protected workspaces cannot be deleted

api_key
string | null

Unique API key for this workspace. Used for authenticating API requests scoped to this workspace.

created_date
string<date-time>

Workspace creation timestamp

updated_date
string<date-time>

Workspace last update timestamp

webhook_enabled
boolean

Whether workspace-level webhooks are enabled

webhook_secret
string | null

Webhook signing secret for this workspace

webhook_secret_rotated_at
string<date-time> | null

Timestamp of the last webhook secret rotation

webhook_secret_created_at
string<date-time> | null

Timestamp when the webhook secret was first created

ignore_company_webhooks
boolean

When true, company-level webhooks do not fire for events in this workspace