--- title: "Workspaces API Reference" description: "Endpoints for managing workspaces in Linkbreakers. These endpoints allow you to update and get workspaces." canonical: "https://linkbreakers.com/help/api/workspaces" --- # Workspaces Endpoints for managing workspaces in Linkbreakers. These endpoints allow you to update and get workspaces. ## Workspaces ## [#](#workspaces-object)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) isSandbox boolean True for a sandbox workspace: API-only, with its own caps, never billed. 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 sandboxExpiresAt string (date-time) When a sandbox workspace is deleted. Unset for a live workspace. 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) unverifiedPauseAt string (date-time) When the workspace is paused for not having a verified email address. While it is in the future, the workspace works normally and a member has until then to verify their email. Once it has passed, every API call other than signing in, reading the member and workspace, switching workspace and requesting a verification email answers WORKSPACE\_UNVERIFIED, until a member verifies their email. QR codes and links keep working for visitors throughout. Empty when the workspace is verified, paying, or a sandbox. 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 moreLearn more about workspaces in Linkbreakers.](https://linkbreakers.com/help/article/what-is-a-workspace) Example object ```json { "country": "string", "createdAt": "2026-10-25T05:40:52.981Z", "description": "string", "digestFrequency": "DIGEST_FREQUENCY_UNSPECIFIED", "enforceMfa": false, "enrollRequestedAt": "2026-10-25T05:40:52.981Z", "faq": "string", "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0", "inactiveSince": "2026-10-25T05:40:52.981Z", "isSandbox": false, "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a", "name": "string", "publishedAt": "2026-10-25T05:40:52.981Z", "sandboxExpiresAt": "2026-10-25T05:40:52.981Z", "shortDescription": "string", "slug": "string", "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN", "tags": "string", "timezone": "string", "trialEndsAt": "2026-10-25T05:40:52.981Z", "unverifiedPauseAt": "2026-10-25T05:40:52.981Z", "updatedAt": "2026-10-25T05:40:52.981Z", "verifiedAt": "2026-10-25T05:40:52.981Z", "website": "string" } ``` GET `/v1/public/workspaces/{slug}` ## [#](#get-a-public-workspace-by-slug)Get a public workspace by slug Retrieve public information about a workspace that has been published. ### [#](#get-a-public-workspace-by-slug-parameters)Parameters #### path parameters slug string Required path Workspace slug to retrieve ### [#](#get-a-public-workspace-by-slug-response)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 ### [#](#get-a-public-workspace-by-slug-error)Error response 400-599 All endpoints may return an unexpected error payload when a request cannot be processed. error object Required Wrapped error response. Example request (cURL) ```bash curl -X GET "https://api.linkbreakers.com/v1/public/workspaces/{slug}" ``` Typical response ```json { "description": "string", "faq": "string", "name": "string", "publishedAt": "2026-10-25T05:40:52.980Z", "shortDescription": "string", "slug": "string", "tags": "string", "website": "string" } ``` Base URL: `https://api.linkbreakers.com` GET `/v1/workspace` Requires auth ## [#](#get-my-workspace)Get my workspace Return the workspace associated with the authenticated member's current session. Requires the \`workspace:read\` scope. ### [#](#get-my-workspace-parameters)Parameters This endpoint does not accept any parameters. ### [#](#get-my-workspace-response)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) isSandbox boolean True for a sandbox workspace: API-only, with its own caps, never billed. 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 sandboxExpiresAt string (date-time) When a sandbox workspace is deleted. Unset for a live workspace. 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) unverifiedPauseAt string (date-time) When the workspace is paused for not having a verified email address. While it is in the future, the workspace works normally and a member has until then to verify their email. Once it has passed, every API call other than signing in, reading the member and workspace, switching workspace and requesting a verification email answers WORKSPACE\_UNVERIFIED, until a member verifies their email. QR codes and links keep working for visitors throughout. Empty when the workspace is verified, paying, or a sandbox. 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-my-workspace-error)Error response 400-599 All endpoints may return an unexpected error payload when a request cannot be processed. error object Required Wrapped error response. Example request (cURL) ```bash curl -X GET "https://api.linkbreakers.com/v1/workspace" \ -H "Authorization: Bearer YOUR_TOKEN" ``` Typical response ```json { "country": "string", "createdAt": "2026-10-25T05:40:52.981Z", "description": "string", "digestFrequency": "DIGEST_FREQUENCY_UNSPECIFIED", "enforceMfa": false, "enrollRequestedAt": "2026-10-25T05:40:52.981Z", "faq": "string", "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0", "inactiveSince": "2026-10-25T05:40:52.981Z", "isSandbox": false, "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a", "name": "string", "publishedAt": "2026-10-25T05:40:52.981Z", "sandboxExpiresAt": "2026-10-25T05:40:52.981Z", "shortDescription": "string", "slug": "string", "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN", "tags": "string", "timezone": "string", "trialEndsAt": "2026-10-25T05:40:52.981Z", "unverifiedPauseAt": "2026-10-25T05:40:52.981Z", "updatedAt": "2026-10-25T05:40:52.981Z", "verifiedAt": "2026-10-25T05:40:52.981Z", "website": "string" } ``` Base URL: `https://api.linkbreakers.com` GET `/v1/workspaces/{id}` Requires auth ## [#](#get-a-workspace-by-id)Get a workspace by ID Retrieve workspace details for the provided identifier, typically for internal tooling. Requires the \`workspace:read\` scope. ### [#](#get-a-workspace-by-id-parameters)Parameters #### path parameters id string Required path Workspace identifier (UUID) to retrieve ### [#](#get-a-workspace-by-id-response)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) isSandbox boolean True for a sandbox workspace: API-only, with its own caps, never billed. 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 sandboxExpiresAt string (date-time) When a sandbox workspace is deleted. Unset for a live workspace. 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) unverifiedPauseAt string (date-time) When the workspace is paused for not having a verified email address. While it is in the future, the workspace works normally and a member has until then to verify their email. Once it has passed, every API call other than signing in, reading the member and workspace, switching workspace and requesting a verification email answers WORKSPACE\_UNVERIFIED, until a member verifies their email. QR codes and links keep working for visitors throughout. Empty when the workspace is verified, paying, or a sandbox. 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-a-workspace-by-id-error)Error response 400-599 All endpoints may return an unexpected error payload when a request cannot be processed. error object Required Wrapped error response. Example request (cURL) ```bash curl -X GET "https://api.linkbreakers.com/v1/workspaces/{id}" \ -H "Authorization: Bearer YOUR_TOKEN" ``` Typical response ```json { "country": "string", "createdAt": "2026-10-25T05:40:52.981Z", "description": "string", "digestFrequency": "DIGEST_FREQUENCY_UNSPECIFIED", "enforceMfa": false, "enrollRequestedAt": "2026-10-25T05:40:52.981Z", "faq": "string", "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0", "inactiveSince": "2026-10-25T05:40:52.981Z", "isSandbox": false, "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a", "name": "string", "publishedAt": "2026-10-25T05:40:52.981Z", "sandboxExpiresAt": "2026-10-25T05:40:52.981Z", "shortDescription": "string", "slug": "string", "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN", "tags": "string", "timezone": "string", "trialEndsAt": "2026-10-25T05:40:52.981Z", "unverifiedPauseAt": "2026-10-25T05:40:52.981Z", "updatedAt": "2026-10-25T05:40:52.981Z", "verifiedAt": "2026-10-25T05:40:52.981Z", "website": "string" } ``` Base URL: `https://api.linkbreakers.com` POST `/v1/workspace/origin-inquiry` Requires auth ## [#](#update-workspace-origin-inquiry)Update workspace origin inquiry Persist how a workspace discovered Linkbreakers without exposing the value to other workspace APIs. Requires the \`workspace:write\` scope. ### [#](#update-workspace-origin-inquiry-parameters)Parameters #### header parameters Idempotency-Key string header Makes retrying this request safe. See components.parameters.IdempotencyKey. ### [#](#update-workspace-origin-inquiry-request)Request body originInquiry string Free-form text describing how the workspace found Linkbreakers ### [#](#update-workspace-origin-inquiry-response)Response 200 Everything worked as expected. No structured schema available for this section. ### [#](#update-workspace-origin-inquiry-error)Error response 400-599 All endpoints may return an unexpected error payload when a request cannot be processed. error object Required Wrapped error response. Example request (cURL) ```bash curl -X POST "https://api.linkbreakers.com/v1/workspace/origin-inquiry" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ --data '{"originInquiry":"string"}' ``` Sample payload (application/json) ```json { "originInquiry": "string" } ``` Typical response ```json {} ``` Base URL: `https://api.linkbreakers.com` POST `/v1/workspace/origin-purpose` Requires auth ## [#](#update-workspace-origin-purpose)Update workspace origin purpose Persist what the workspace wants to build with Linkbreakers for AI assistance without exposing the value to other workspace APIs. Requires the \`workspace:write\` scope. ### [#](#update-workspace-origin-purpose-parameters)Parameters #### header parameters Idempotency-Key string header Makes retrying this request safe. See components.parameters.IdempotencyKey. ### [#](#update-workspace-origin-purpose-request)Request body originPurpose string Free-form text describing what the workspace wants to build with Linkbreakers ### [#](#update-workspace-origin-purpose-response)Response 200 Everything worked as expected. No structured schema available for this section. ### [#](#update-workspace-origin-purpose-error)Error response 400-599 All endpoints may return an unexpected error payload when a request cannot be processed. error object Required Wrapped error response. Example request (cURL) ```bash curl -X POST "https://api.linkbreakers.com/v1/workspace/origin-purpose" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ --data '{"originPurpose":"string"}' ``` Sample payload (application/json) ```json { "originPurpose": "string" } ``` Typical response ```json {} ``` Base URL: `https://api.linkbreakers.com` POST `/v1/workspace/request-enrollment` Requires auth ## [#](#request-workspace-enrollment)Request workspace enrollment Submit a request for workspace enrollment, setting the enroll\_requested\_at timestamp. Requires the \`workspace:write\` scope. ### [#](#request-workspace-enrollment-parameters)Parameters #### header parameters Idempotency-Key string header Makes retrying this request safe. See components.parameters.IdempotencyKey. ### [#](#request-workspace-enrollment-request)Request body message string Optional message or reason for enrollment request ### [#](#request-workspace-enrollment-response)Response 200 Everything worked as expected. No structured schema available for this section. ### [#](#request-workspace-enrollment-error)Error response 400-599 All endpoints may return an unexpected error payload when a request cannot be processed. error object Required Wrapped error response. Example request (cURL) ```bash curl -X POST "https://api.linkbreakers.com/v1/workspace/request-enrollment" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ --data '{"message":"string"}' ``` Sample payload (application/json) ```json { "message": "string" } ``` Typical response ```json {} ``` Base URL: `https://api.linkbreakers.com` PUT `/v1/workspace` Requires auth ## [#](#update-a-workspace)Update a workspace Modify workspace settings such as the display name and MFA enforcement policy. Requires the \`workspace:write\` scope. ### [#](#update-a-workspace-parameters)Parameters #### header parameters Idempotency-Key string header Makes retrying this request safe. See components.parameters.IdempotencyKey. ### [#](#update-a-workspace-request)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 ### [#](#update-a-workspace-response)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) isSandbox boolean True for a sandbox workspace: API-only, with its own caps, never billed. 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 sandboxExpiresAt string (date-time) When a sandbox workspace is deleted. Unset for a live workspace. 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) unverifiedPauseAt string (date-time) When the workspace is paused for not having a verified email address. While it is in the future, the workspace works normally and a member has until then to verify their email. Once it has passed, every API call other than signing in, reading the member and workspace, switching workspace and requesting a verification email answers WORKSPACE\_UNVERIFIED, until a member verifies their email. QR codes and links keep working for visitors throughout. Empty when the workspace is verified, paying, or a sandbox. 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 ### [#](#update-a-workspace-error)Error response 400-599 All endpoints may return an unexpected error payload when a request cannot be processed. error object Required Wrapped error response. Example request (cURL) ```bash curl -X PUT "https://api.linkbreakers.com/v1/workspace" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ --data '{"description":"string","digestFrequency":"DIGEST_FREQUENCY_UNSPECIFIED","enforceMfa":false,"faq":"string","name":"string","shortDescription":"string","slug":"string","tags":"string","website":"string"}' ``` Sample payload (application/json) ```json { "description": "string", "digestFrequency": "DIGEST_FREQUENCY_UNSPECIFIED", "enforceMfa": false, "faq": "string", "name": "string", "shortDescription": "string", "slug": "string", "tags": "string", "website": "string" } ``` Typical response ```json { "country": "string", "createdAt": "2026-10-25T05:40:52.981Z", "description": "string", "digestFrequency": "DIGEST_FREQUENCY_UNSPECIFIED", "enforceMfa": false, "enrollRequestedAt": "2026-10-25T05:40:52.981Z", "faq": "string", "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0", "inactiveSince": "2026-10-25T05:40:52.981Z", "isSandbox": false, "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a", "name": "string", "publishedAt": "2026-10-25T05:40:52.981Z", "sandboxExpiresAt": "2026-10-25T05:40:52.981Z", "shortDescription": "string", "slug": "string", "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN", "tags": "string", "timezone": "string", "trialEndsAt": "2026-10-25T05:40:52.981Z", "unverifiedPauseAt": "2026-10-25T05:40:52.981Z", "updatedAt": "2026-10-25T05:40:52.981Z", "verifiedAt": "2026-10-25T05:40:52.981Z", "website": "string" } ``` Base URL: `https://api.linkbreakers.com` DELETE `/v1/workspace` Requires auth ## [#](#delete-workspace)Delete workspace Soft-delete the workspace associated with the authenticated member's session. This operation can be reversed by contacting support. Requires the \`workspace:write\` scope. ### [#](#delete-workspace-parameters)Parameters This endpoint does not accept any parameters. ### [#](#delete-workspace-response)Response 200 Everything worked as expected. No structured schema available for this section. ### [#](#delete-workspace-error)Error response 400-599 All endpoints may return an unexpected error payload when a request cannot be processed. error object Required Wrapped error response. Example request (cURL) ```bash curl -X DELETE "https://api.linkbreakers.com/v1/workspace" \ -H "Authorization: Bearer YOUR_TOKEN" ``` Typical response ```json {} ``` Base URL: `https://api.linkbreakers.com` --- Source: https://linkbreakers.com/help/api/workspaces