Workspaces API Reference

#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

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)

Learn more

Learn more about workspaces in Linkbreakers.

Example object

{
  "country": "string",
  "createdAt": "2025-10-29T07:55:34.194Z",
  "enforceMfa": false,
  "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0",
  "inactiveSince": "2025-10-29T07:55:34.194Z",
  "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "name": "string",
  "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN",
  "timezone": "string",
  "updatedAt": "2025-10-29T07:55:34.194Z",
  "verifiedAt": "2025-10-29T07:55:34.194Z"
}

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

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.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/workspace" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "country": "string",
  "createdAt": "2025-10-29T07:55:34.189Z",
  "enforceMfa": false,
  "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0",
  "inactiveSince": "2025-10-29T07:55:34.189Z",
  "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "name": "string",
  "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN",
  "timezone": "string",
  "updatedAt": "2025-10-29T07:55:34.189Z",
  "verifiedAt": "2025-10-29T07:55:34.189Z"
}

Base URL: https://api.linkbreakers.com

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

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

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.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/workspaces/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "country": "string",
  "createdAt": "2025-10-29T07:55:34.191Z",
  "enforceMfa": false,
  "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0",
  "inactiveSince": "2025-10-29T07:55:34.191Z",
  "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "name": "string",
  "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN",
  "timezone": "string",
  "updatedAt": "2025-10-29T07:55:34.191Z",
  "verifiedAt": "2025-10-29T07:55:34.191Z"
}

Base URL: https://api.linkbreakers.com

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

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.

Example request (cURL)

curl -X PUT "https://api.linkbreakers.com/v1/workspace" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"enforceMfa":false,"name":"string"}'

Sample payload (application/json)

{
  "enforceMfa": false,
  "name": "string"
}

Typical response

{
  "country": "string",
  "createdAt": "2025-10-29T07:55:34.190Z",
  "enforceMfa": false,
  "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0",
  "inactiveSince": "2025-10-29T07:55:34.190Z",
  "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "name": "string",
  "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN",
  "timezone": "string",
  "updatedAt": "2025-10-29T07:55:34.190Z",
  "verifiedAt": "2025-10-29T07:55:34.190Z"
}

Base URL: https://api.linkbreakers.com