Logo of linkbreakers

Workspaces

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

#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

digestFrequency

string (enum)

How often the workspace receives traffic digest emails (none, weekly, monthly)

Allowed values
DIGEST_FREQUENCY_UNSPECIFIED

Not specified; defaults to monthly

DIGEST_FREQUENCY_NONE

No digest emails

DIGEST_FREQUENCY_WEEKLY

Weekly digest every Monday

DIGEST_FREQUENCY_MONTHLY

Monthly digest on the 1st of each month

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

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

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_SPONSORED_PRO

Workspace is on the sponsored pro plan with full pro features

SUBSCRIPTION_TYPE_PRO_PLAN

Workspace has an active Pro plan subscription

SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

Workspace is managed under an Enterprise contract

SUBSCRIPTION_TYPE_LIGHT_PLAN

Workspace has an active Light plan subscription

tags

string

Comma-separated tags for the workspace

timezone

string

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

trialEndsAt

string (date-time)

When the free trial period ends (null if not on trial)

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

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

string
Required
path

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

object
Required

Wrapped error response.

GET
/v1/workspace
Requires 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

digestFrequency

string (enum)

How often the workspace receives traffic digest emails (none, weekly, monthly)

Allowed values
DIGEST_FREQUENCY_UNSPECIFIED

Not specified; defaults to monthly

DIGEST_FREQUENCY_NONE

No digest emails

DIGEST_FREQUENCY_WEEKLY

Weekly digest every Monday

DIGEST_FREQUENCY_MONTHLY

Monthly digest on the 1st of each month

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

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

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_SPONSORED_PRO

Workspace is on the sponsored pro plan with full pro features

SUBSCRIPTION_TYPE_PRO_PLAN

Workspace has an active Pro plan subscription

SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

Workspace is managed under an Enterprise contract

SUBSCRIPTION_TYPE_LIGHT_PLAN

Workspace has an active Light plan subscription

tags

string

Comma-separated tags for the workspace

timezone

string

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

trialEndsAt

string (date-time)

When the free trial period ends (null if not on trial)

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

object
Required

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

string
Required
path

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

digestFrequency

string (enum)

How often the workspace receives traffic digest emails (none, weekly, monthly)

Allowed values
DIGEST_FREQUENCY_UNSPECIFIED

Not specified; defaults to monthly

DIGEST_FREQUENCY_NONE

No digest emails

DIGEST_FREQUENCY_WEEKLY

Weekly digest every Monday

DIGEST_FREQUENCY_MONTHLY

Monthly digest on the 1st of each month

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

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

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_SPONSORED_PRO

Workspace is on the sponsored pro plan with full pro features

SUBSCRIPTION_TYPE_PRO_PLAN

Workspace has an active Pro plan subscription

SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

Workspace is managed under an Enterprise contract

SUBSCRIPTION_TYPE_LIGHT_PLAN

Workspace has an active Light plan subscription

tags

string

Comma-separated tags for the workspace

timezone

string

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

trialEndsAt

string (date-time)

When the free trial period ends (null if not on trial)

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

object
Required

Wrapped error response.

POST
/v1/workspace/origin-inquiry
Requires 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

object
Required

Wrapped error response.

POST
/v1/workspace/origin-purpose
Requires auth

#Update workspace origin purpose

Persist what the workspace wants to build with Linkbreakers for AI assistance without exposing the value to other workspace APIs.

#Parameters

This endpoint does not accept any parameters.

#Request body

originPurpose

string

Free-form text describing what the workspace wants to build with 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

object
Required

Wrapped error response.

POST
/v1/workspace/request-enrollment
Requires 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

object
Required

Wrapped error response.

PUT
/v1/workspace
Requires 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

digestFrequency

string (enum)

How often the workspace receives traffic digest emails

Allowed values
DIGEST_FREQUENCY_UNSPECIFIED

Not specified; defaults to monthly

DIGEST_FREQUENCY_NONE

No digest emails

DIGEST_FREQUENCY_WEEKLY

Weekly digest every Monday

DIGEST_FREQUENCY_MONTHLY

Monthly digest on the 1st of each month

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

digestFrequency

string (enum)

How often the workspace receives traffic digest emails (none, weekly, monthly)

Allowed values
DIGEST_FREQUENCY_UNSPECIFIED

Not specified; defaults to monthly

DIGEST_FREQUENCY_NONE

No digest emails

DIGEST_FREQUENCY_WEEKLY

Weekly digest every Monday

DIGEST_FREQUENCY_MONTHLY

Monthly digest on the 1st of each month

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

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

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_SPONSORED_PRO

Workspace is on the sponsored pro plan with full pro features

SUBSCRIPTION_TYPE_PRO_PLAN

Workspace has an active Pro plan subscription

SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

Workspace is managed under an Enterprise contract

SUBSCRIPTION_TYPE_LIGHT_PLAN

Workspace has an active Light plan subscription

tags

string

Comma-separated tags for the workspace

timezone

string

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

trialEndsAt

string (date-time)

When the free trial period ends (null if not on trial)

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

object
Required

Wrapped error response.

DELETE
/v1/workspace
Requires auth

#Delete workspace

Soft-delete the workspace associated with the authenticated member's session. This operation can be reversed by contacting support.

#Parameters

This endpoint does not accept any parameters.

#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

object
Required

Wrapped error response.