#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

description

string

Optional description providing additional context about the workspace

enforceMfa

boolean

Whether members must complete multi-factor authentication at sign in

enrollRequestedAt

string (date-time)

Timestamp when enrollment was requested for this workspace

faq

string

Frequently Asked Questions about this workspace stored as JSON

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

publishedAt

string (date-time)

Timestamp when the workspace was published/made public

shortDescription

string

Short description for the workspace

slug

string

Unique slug for the workspace (URL-friendly identifier)

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

tags

string

Comma-separated tags for the workspace

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)

website

string

Website URL for the workspace

Learn more

Learn more about workspaces in Linkbreakers.

Example object

{
  "country": "string",
  "createdAt": "2025-12-29T01:50:32.281Z",
  "description": "string",
  "enforceMfa": false,
  "enrollRequestedAt": "2025-12-29T01:50:32.281Z",
  "faq": "string",
  "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0",
  "inactiveSince": "2025-12-29T01:50:32.281Z",
  "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "name": "string",
  "publishedAt": "2025-12-29T01:50:32.281Z",
  "shortDescription": "string",
  "slug": "string",
  "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN",
  "tags": "string",
  "timezone": "string",
  "updatedAt": "2025-12-29T01:50:32.281Z",
  "verifiedAt": "2025-12-29T01:50:32.281Z",
  "website": "string"
}

GET/v1/public/workspaces/{slug}Requires auth

#Get a public workspace by slug

Retrieve public information about a workspace that has been published.

#Parameters

path parameters

slug

stringRequiredpath

Workspace slug to retrieve

#Response

200

Everything worked as expected.

description

string

Optional description providing additional context about the workspace

faq

string

Frequently Asked Questions about this workspace stored as JSON

name

string

Human-readable display name

publishedAt

string (date-time)

Timestamp when the workspace was published/made public

shortDescription

string

Short description for the workspace

slug

string

Unique slug for the workspace (URL-friendly identifier)

tags

string

Comma-separated tags for the workspace

website

string

Website URL for the workspace

#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/public/workspaces/{slug}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "description": "string",
  "faq": "string",
  "name": "string",
  "publishedAt": "2025-12-29T01:50:32.250Z",
  "shortDescription": "string",
  "slug": "string",
  "tags": "string",
  "website": "string"
}

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

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

description

string

Optional description providing additional context about the workspace

enforceMfa

boolean

Whether members must complete multi-factor authentication at sign in

enrollRequestedAt

string (date-time)

Timestamp when enrollment was requested for this workspace

faq

string

Frequently Asked Questions about this workspace stored as JSON

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

publishedAt

string (date-time)

Timestamp when the workspace was published/made public

shortDescription

string

Short description for the workspace

slug

string

Unique slug for the workspace (URL-friendly identifier)

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

tags

string

Comma-separated tags for the workspace

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)

website

string

Website URL for the workspace

#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-12-29T01:50:32.251Z",
  "description": "string",
  "enforceMfa": false,
  "enrollRequestedAt": "2025-12-29T01:50:32.251Z",
  "faq": "string",
  "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0",
  "inactiveSince": "2025-12-29T01:50:32.251Z",
  "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "name": "string",
  "publishedAt": "2025-12-29T01:50:32.279Z",
  "shortDescription": "string",
  "slug": "string",
  "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN",
  "tags": "string",
  "timezone": "string",
  "updatedAt": "2025-12-29T01:50:32.279Z",
  "verifiedAt": "2025-12-29T01:50:32.279Z",
  "website": "string"
}

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

description

string

Optional description providing additional context about the workspace

enforceMfa

boolean

Whether members must complete multi-factor authentication at sign in

enrollRequestedAt

string (date-time)

Timestamp when enrollment was requested for this workspace

faq

string

Frequently Asked Questions about this workspace stored as JSON

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

publishedAt

string (date-time)

Timestamp when the workspace was published/made public

shortDescription

string

Short description for the workspace

slug

string

Unique slug for the workspace (URL-friendly identifier)

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

tags

string

Comma-separated tags for the workspace

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)

website

string

Website URL for the workspace

#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-12-29T01:50:32.281Z",
  "description": "string",
  "enforceMfa": false,
  "enrollRequestedAt": "2025-12-29T01:50:32.281Z",
  "faq": "string",
  "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0",
  "inactiveSince": "2025-12-29T01:50:32.281Z",
  "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "name": "string",
  "publishedAt": "2025-12-29T01:50:32.281Z",
  "shortDescription": "string",
  "slug": "string",
  "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN",
  "tags": "string",
  "timezone": "string",
  "updatedAt": "2025-12-29T01:50:32.281Z",
  "verifiedAt": "2025-12-29T01:50:32.281Z",
  "website": "string"
}

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

POST/v1/workspace/origin-inquiryRequires auth

#Update workspace origin inquiry

Persist how a workspace discovered Linkbreakers without exposing the value to other workspace APIs.

#Parameters

This endpoint does not accept any parameters.

#Request body

originInquiry

string

Free-form text describing how the workspace found Linkbreakers

#Response

200

Everything worked as expected.

No structured schema available for this section.

#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 POST "https://api.linkbreakers.com/v1/workspace/origin-inquiry" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"originInquiry":"string"}'

Sample payload (application/json)

{
  "originInquiry": "string"
}

Typical response

{}

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

POST/v1/workspace/request-enrollmentRequires auth

#Request workspace enrollment

Submit a request for workspace enrollment, setting the enroll_requested_at timestamp.

#Parameters

This endpoint does not accept any parameters.

#Request body

message

string

Optional message or reason for enrollment request

#Response

200

Everything worked as expected.

No structured schema available for this section.

#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 POST "https://api.linkbreakers.com/v1/workspace/request-enrollment" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"message":"string"}'

Sample payload (application/json)

{
  "message": "string"
}

Typical response

{}

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

description

string

Optional description providing additional context about the workspace

enforceMfa

boolean

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

faq

string

FAQ data to update (JSON string)

name

string

New display name for the workspace

shortDescription

string

Short description for the workspace

slug

string

Workspace slug (immutable once set)

tags

string

Comma-separated tags for the workspace

website

string

Website URL 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

description

string

Optional description providing additional context about the workspace

enforceMfa

boolean

Whether members must complete multi-factor authentication at sign in

enrollRequestedAt

string (date-time)

Timestamp when enrollment was requested for this workspace

faq

string

Frequently Asked Questions about this workspace stored as JSON

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

publishedAt

string (date-time)

Timestamp when the workspace was published/made public

shortDescription

string

Short description for the workspace

slug

string

Unique slug for the workspace (URL-friendly identifier)

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

tags

string

Comma-separated tags for the workspace

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)

website

string

Website URL for the workspace

#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 '{"description":"string","enforceMfa":false,"faq":"string","name":"string","shortDescription":"string","slug":"string","tags":"string","website":"string"}'

Sample payload (application/json)

{
  "description": "string",
  "enforceMfa": false,
  "faq": "string",
  "name": "string",
  "shortDescription": "string",
  "slug": "string",
  "tags": "string",
  "website": "string"
}

Typical response

{
  "country": "string",
  "createdAt": "2025-12-29T01:50:32.280Z",
  "description": "string",
  "enforceMfa": false,
  "enrollRequestedAt": "2025-12-29T01:50:32.280Z",
  "faq": "string",
  "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0",
  "inactiveSince": "2025-12-29T01:50:32.280Z",
  "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "name": "string",
  "publishedAt": "2025-12-29T01:50:32.280Z",
  "shortDescription": "string",
  "slug": "string",
  "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN",
  "tags": "string",
  "timezone": "string",
  "updatedAt": "2025-12-29T01:50:32.280Z",
  "verifiedAt": "2025-12-29T01:50:32.280Z",
  "website": "string"
}

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

Workspaces

#The Workspace object

Allowed values

#Get a public workspace by slug

#Parameters

path parameters

#Response

#Error response

#Get my workspace

#Parameters

#Response

Allowed values

#Error response

#Get a workspace by ID

#Parameters

path parameters

#Response

Allowed values

#Error response

#Update workspace origin inquiry

#Parameters

#Request body

#Response

#Error response

#Request workspace enrollment

#Parameters

#Request body

#Response

#Error response

#Update a workspace

#Parameters

#Request body

#Response

Allowed values

#Error response