← Back to API Reference overview

Workspaces

Endpoints for managing workspaces in Linkbreakers. These endpoints allow you to update and get workspaces.

Shortcut: ⌘K

#The Workspace object

Serves as the tenant boundary in Linkbreakers, grouping links, members, settings, billing state, and analytics under a single organization's environment.

country

string

ISO 3166-1 alpha-2 country code inferred from the owner signup or link activity

createdAt

string (date-time)

Timestamp when the workspace record was created

enforceMfa

boolean

Whether members must complete multi-factor authentication at sign in

id

string

Unique identifier for the workspace (UUID)

inactiveSince

string (date-time)

When the workspace was flagged as inactive due to lack of activity (cleared on next sign-in/scan)

linkSettingId

string

Link setting configuration that governs visitor data collection (UUID)

name

string

Human-readable display name chosen during signup

subscriptionType

string (enum)

Billing plan currently applied to the workspace

Allowed values
SUBSCRIPTION_TYPE_UNSPECIFIED

Subscription plan not yet assigned

SUBSCRIPTION_TYPE_FREE_TRIAL

Workspace is currently in the free trial period

SUBSCRIPTION_TYPE_FREE_FOREVER

Workspace is on the free forever plan with limited features

SUBSCRIPTION_TYPE_PRO_PLAN

Workspace has an active Pro plan subscription

SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

Workspace is managed under an Enterprise contract

timezone

string

Default timezone used to render analytics and schedules (IANA name)

updatedAt

string (date-time)

Timestamp of the last workspace-level update

verifiedAt

string (date-time)

Timestamp when the workspace passed verification (e.g., owner email confirmed)

GET/v1/workspaceRequires auth

#Get my workspace

Return the workspace associated with the authenticated member's current session.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

country

string

ISO 3166-1 alpha-2 country code inferred from the owner signup or link activity

createdAt

string (date-time)

Timestamp when the workspace record was created

enforceMfa

boolean

Whether members must complete multi-factor authentication at sign in

id

string

Unique identifier for the workspace (UUID)

inactiveSince

string (date-time)

When the workspace was flagged as inactive due to lack of activity (cleared on next sign-in/scan)

linkSettingId

string

Link setting configuration that governs visitor data collection (UUID)

name

string

Human-readable display name chosen during signup

subscriptionType

string (enum)

Billing plan currently applied to the workspace

Allowed values
SUBSCRIPTION_TYPE_UNSPECIFIED

Subscription plan not yet assigned

SUBSCRIPTION_TYPE_FREE_TRIAL

Workspace is currently in the free trial period

SUBSCRIPTION_TYPE_FREE_FOREVER

Workspace is on the free forever plan with limited features

SUBSCRIPTION_TYPE_PRO_PLAN

Workspace has an active Pro plan subscription

SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

Workspace is managed under an Enterprise contract

timezone

string

Default timezone used to render analytics and schedules (IANA name)

updatedAt

string (date-time)

Timestamp of the last workspace-level update

verifiedAt

string (date-time)

Timestamp when the workspace passed verification (e.g., owner email confirmed)

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

GET/v1/workspaces/{id}Requires auth

#Get a workspace by ID

Retrieve workspace details for the provided identifier, typically for internal tooling.

#Parameters

path parameters

id

stringRequiredpath

Workspace identifier (UUID) to retrieve

#Response

200

Everything worked as expected.

country

string

ISO 3166-1 alpha-2 country code inferred from the owner signup or link activity

createdAt

string (date-time)

Timestamp when the workspace record was created

enforceMfa

boolean

Whether members must complete multi-factor authentication at sign in

id

string

Unique identifier for the workspace (UUID)

inactiveSince

string (date-time)

When the workspace was flagged as inactive due to lack of activity (cleared on next sign-in/scan)

linkSettingId

string

Link setting configuration that governs visitor data collection (UUID)

name

string

Human-readable display name chosen during signup

subscriptionType

string (enum)

Billing plan currently applied to the workspace

Allowed values
SUBSCRIPTION_TYPE_UNSPECIFIED

Subscription plan not yet assigned

SUBSCRIPTION_TYPE_FREE_TRIAL

Workspace is currently in the free trial period

SUBSCRIPTION_TYPE_FREE_FOREVER

Workspace is on the free forever plan with limited features

SUBSCRIPTION_TYPE_PRO_PLAN

Workspace has an active Pro plan subscription

SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

Workspace is managed under an Enterprise contract

timezone

string

Default timezone used to render analytics and schedules (IANA name)

updatedAt

string (date-time)

Timestamp of the last workspace-level update

verifiedAt

string (date-time)

Timestamp when the workspace passed verification (e.g., owner email confirmed)

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

PUT/v1/workspaceRequires auth

#Update a workspace

Modify workspace settings such as the display name and MFA enforcement policy.

#Parameters

This endpoint does not accept any parameters.

#Request body

enforceMfa

boolean

Toggle for enforcing MFA on member sign-in; omitempty leaves current policy

name

string

New display name for the workspace

#Response

200

Everything worked as expected.

country

string

ISO 3166-1 alpha-2 country code inferred from the owner signup or link activity

createdAt

string (date-time)

Timestamp when the workspace record was created

enforceMfa

boolean

Whether members must complete multi-factor authentication at sign in

id

string

Unique identifier for the workspace (UUID)

inactiveSince

string (date-time)

When the workspace was flagged as inactive due to lack of activity (cleared on next sign-in/scan)

linkSettingId

string

Link setting configuration that governs visitor data collection (UUID)

name

string

Human-readable display name chosen during signup

subscriptionType

string (enum)

Billing plan currently applied to the workspace

Allowed values
SUBSCRIPTION_TYPE_UNSPECIFIED

Subscription plan not yet assigned

SUBSCRIPTION_TYPE_FREE_TRIAL

Workspace is currently in the free trial period

SUBSCRIPTION_TYPE_FREE_FOREVER

Workspace is on the free forever plan with limited features

SUBSCRIPTION_TYPE_PRO_PLAN

Workspace has an active Pro plan subscription

SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

Workspace is managed under an Enterprise contract

timezone

string

Default timezone used to render analytics and schedules (IANA name)

updatedAt

string (date-time)

Timestamp of the last workspace-level update

verifiedAt

string (date-time)

Timestamp when the workspace passed verification (e.g., owner email confirmed)

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.