---
title: "Workspaces API Reference | Linkbreakers"
description: "Your workspace: read and update its settings, see how much of its plan it has used, or delete it."
canonical: "https://linkbreakers.com/help/api/workspaces"
---

# Workspaces

Your workspace: read and update its settings, see how much of its plan it has used, or delete it.

6 entries on this page

## The workspace object

The tenant boundary: the organization that owns links, members, settings, billing and analytics.

`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` enum

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

Allowed values

* `DIGEST_FREQUENCY_NONE` No digest emails
* `DIGEST_FREQUENCY_WEEKLY` Weekly digest every Monday
* `DIGEST_FREQUENCY_MONTHLY` Monthly digest on the 1st of each month
* `DIGEST_FREQUENCY_UNSPECIFIED` Not specified; defaults to monthly

`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

FAQ data stored as JSON.

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` enum

Billing plan currently applied to the workspace.

Allowed values

* `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
* `SUBSCRIPTION_TYPE_REVIEW_REWARD` Workspace has the Pro plan for free for a while, in exchange for a review
* `SUBSCRIPTION_TYPE_UNSPECIFIED` Subscription plan not yet assigned

`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) 

Read-only

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. To lift it, ask the owner to verify their email: POST /v1/members/email-verification sends the verification email again. QR codes and links keep working for visitors throughout. Empty when the workspace is verified or paying.

`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

Example workspace

```json
{
  "country": "FR",
  "createdAt": "2026-03-14T09:30:00Z",
  "description": "Boutique hotel in Lyon with a restaurant and a rooftop bar. Our QR codes sit on restaurant tables, flyers and posters.",
  "digestFrequency": "DIGEST_FREQUENCY_WEEKLY",
  "enforceMfa": true,
  "enrollRequestedAt": "2026-03-15T10:20:00Z",
  "faq": "[{\"id\": \"1\", \"question\": \"Is breakfast included?\", \"answer\": \"Yes, breakfast is served from 7:00 to 10:30.\", \"order\": 0}]",
  "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0",
  "inactiveSince": "2026-09-01T00:00:00Z",
  "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
  "name": "Hotel Lumiere",
  "publishedAt": "2026-03-16T11:00:00Z",
  "shortDescription": "Boutique hotel and restaurant in Lyon",
  "slug": "hotel-lumiere",
  "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN",
  "tags": "hotel,restaurant,lyon",
  "timezone": "Europe/Paris",
  "trialEndsAt": "2026-03-28T09:30:00Z",
  "unverifiedPauseAt": "2026-03-21T09:30:00Z",
  "updatedAt": "2026-03-18T16:05:00Z",
  "verifiedAt": "2026-03-14T09:42:00Z",
  "website": "https://example.com"
}
```

### Parameters

`slug` string 

path

Required

Workspace slug to retrieve

### Response

200

`description` string

Optional description providing additional context about the workspace

`faq` string

FAQ data stored as JSON.

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

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/public/workspaces/{slug}"
```

Response 200

```json
{
  "description": "Boutique hotel in Lyon with a restaurant and a rooftop bar. Our QR codes sit on restaurant tables, flyers and posters.",
  "faq": "[{\"id\": \"1\", \"question\": \"Is breakfast included?\", \"answer\": \"Yes, breakfast is served from 7:00 to 10:30.\", \"order\": 0}]",
  "name": "Hotel Lumiere",
  "publishedAt": "2026-03-16T11:00:00Z",
  "shortDescription": "Boutique hotel and restaurant in Lyon",
  "slug": "hotel-lumiere",
  "tags": "hotel,restaurant,lyon",
  "website": "https://example.com"
}
```

### Response

200

Returns [the workspace object](#workspaces-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/workspace" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

### Response

200

`allowances` array of object

One entry per limit the plan sets

16 child attributes

`cheapestActionCost` integer (int32)

Platform credits only: the credits the cheapest action that spends them needs before it runs

`cycleEndAt` string (date-time)

The last second of the current cycle; the allowance refills one second later. Absent for totals that never refill and when nothing has been counted yet.

`cycleStartAt` string (date-time)

Start of the current cycle. Absent when nothing has been counted yet.

`key` enum

What the limit is on.

Allowed values

* `PLAN_LIMIT_KEY_CUSTOM_DOMAINS` Custom domains connected to the workspace
* `PLAN_LIMIT_KEY_TEAM_MEMBERS` Members of the workspace
* `PLAN_LIMIT_KEY_PLATFORM_CREDITS` Platform credits, spent by creating links and by AI features
* `PLAN_LIMIT_KEY_TRACKED_VISITS` Tracked visits (scans and clicks)
* `PLAN_LIMIT_KEY_PUBLIC_API_CALLS` Public API calls
* `PLAN_LIMIT_KEY_WEBHOOKS` Webhooks configured in the workspace
* `PLAN_LIMIT_KEY_ASSISTANT_MESSAGES_PER_MINUTE` Assistant messages per minute
* `PLAN_LIMIT_KEY_LINKS_INCLUDED` Links the monthly platform credits pay for. Links are not capped on their own: each one spends credits.
* `PLAN_LIMIT_KEY_MEDIA_STORAGE_MB` Megabytes of uploaded media (media for Open media steps, QR code logos, page theme images) the workspace may hold at once. A standing total: deleting media frees it.

`kind` enum

How the limit behaves.

Allowed values

* `PLAN_LIMIT_KIND_TOTAL` A standing total that does not refill, such as connected domains
* `PLAN_LIMIT_KIND_MONTHLY` An allowance that refills every month
* `PLAN_LIMIT_KIND_PER_MINUTE` A rate that refills every minute
* `PLAN_LIMIT_KIND_UNLIMITED` No ceiling
* `PLAN_LIMIT_KIND_METERED` No ceiling; every unit is billed

`limit` integer (int32)

The ceiling. Absent when kind is PLAN\_LIMIT\_KIND\_UNLIMITED or PLAN\_LIMIT\_KIND\_METERED.

`limitBytes` integer (int64)

Media storage only: the most media the workspace may hold, in bytes. Absent for other limits and when there is no ceiling.

`lockedCount` integer (int32)

Tracked visits only: visits recorded past the limit in the current cycle that the workspace's plan still locks. Absent for other limits.

`lockedTotalCount` integer (int32)

Tracked visits only: every visit the workspace's plan still locks, across all cycles. Upgrading to a plan with a higher limit reveals them. Absent for other limits.

`noticeDismissed` boolean

Whether the calling member dismissed the over-limit notice for this limit in the current cycle

`reached` boolean

Whether the limit is used up for the current cycle. Platform credits count as reached once neither the monthly credits nor the purchased top-up credits hold cheapestActionCost, so nothing that spends credits can run. Never reached on a plan billed per unit used.

`recordedCount` integer (int32)

Tracked visits only: every visit recorded in the current cycle, used plus lockedCount. Absent for other limits.

`remaining` integer (int32)

Units left in the current cycle. For platform credits, the monthly credits left plus the purchased top-up credits left. Absent when there is no ceiling.

`resetsOn` object

The day the allowance refills, which is the first day of the next cycle in the workspace's timezone. Absent for totals that never refill and when nothing has been counted yet.

3 child attributes

`day` integer (int32)

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

`month` integer (int32)

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

`year` integer (int32)

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

`used` integer (int32)

Units used in the current cycle. For a total such as custom domains, what the workspace holds.

`usedBytes` integer (int64)

Media storage only: the bytes the workspace's media holds, exact. used is the same figure in megabytes, rounded up. Absent for other limits.

`limits` array of object

Every limit this workspace is allowed, as enforced for its subscription, including the ones not counted per cycle such as webhooks and the Assistant rate. A trial or sponsored workspace can be allowed less than the plan it reports, and these are what it gets.

3 child attributes

`key` enum

What the limit is on.

Allowed values

* `PLAN_LIMIT_KEY_CUSTOM_DOMAINS` Custom domains connected to the workspace
* `PLAN_LIMIT_KEY_TEAM_MEMBERS` Members of the workspace
* `PLAN_LIMIT_KEY_PLATFORM_CREDITS` Platform credits, spent by creating links and by AI features
* `PLAN_LIMIT_KEY_TRACKED_VISITS` Tracked visits (scans and clicks)
* `PLAN_LIMIT_KEY_PUBLIC_API_CALLS` Public API calls
* `PLAN_LIMIT_KEY_WEBHOOKS` Webhooks configured in the workspace
* `PLAN_LIMIT_KEY_ASSISTANT_MESSAGES_PER_MINUTE` Assistant messages per minute
* `PLAN_LIMIT_KEY_LINKS_INCLUDED` Links the monthly platform credits pay for. Links are not capped on their own: each one spends credits.
* `PLAN_LIMIT_KEY_MEDIA_STORAGE_MB` Megabytes of uploaded media (media for Open media steps, QR code logos, page theme images) the workspace may hold at once. A standing total: deleting media frees it.

`kind` enum

How the limit behaves.

Allowed values

* `PLAN_LIMIT_KIND_TOTAL` A standing total that does not refill, such as connected domains
* `PLAN_LIMIT_KIND_MONTHLY` An allowance that refills every month
* `PLAN_LIMIT_KIND_PER_MINUTE` A rate that refills every minute
* `PLAN_LIMIT_KIND_UNLIMITED` No ceiling
* `PLAN_LIMIT_KIND_METERED` No ceiling; every unit is billed

`value` integer (int32)

The ceiling. Absent when kind is PLAN\_LIMIT\_KIND\_UNLIMITED or PLAN\_LIMIT\_KIND\_METERED.

`plan` enum

The plan the limits come from. A trial or sponsored workspace reports the plan it is allowed what of.

Allowed values

* `PRICING_PLAN_ID_FREE` Free plan, no payment
* `PRICING_PLAN_ID_LIGHT` Light plan
* `PRICING_PLAN_ID_PRO` Pro plan. Trials and sponsored workspaces are allowed what Pro allows unless a limit says otherwise.
* `PRICING_PLAN_ID_ENTERPRISE` Enterprise plan, billed on usage and priced on request through sales

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/workspace/usage" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "allowances": [
    {
      "cheapestActionCost": 1,
      "cycleEndAt": "2026-03-31T23:59:59Z",
      "cycleStartAt": "2026-03-01T00:00:00Z",
      "key": "PLAN_LIMIT_KEY_TRACKED_VISITS",
      "kind": "PLAN_LIMIT_KIND_MONTHLY",
      "limit": 5000,
      "limitBytes": 524288000,
      "lockedCount": 128,
      "lockedTotalCount": 128,
      "noticeDismissed": false,
      "reached": true,
      "recordedCount": 5128,
      "remaining": 0,
      "resetsOn": {
        "day": 21,
        "month": 3,
        "year": 2026
      },
      "used": 5000,
      "usedBytes": 48234496
    }
  ],
  "limits": [
    {
      "key": "PLAN_LIMIT_KEY_TRACKED_VISITS",
      "kind": "PLAN_LIMIT_KIND_MONTHLY",
      "value": 5000
    }
  ],
  "plan": "PRICING_PLAN_ID_PRO"
}
```

### Parameters

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`description` string

Optional description providing additional context about the workspace

`digestFrequency` enum

How often the workspace receives traffic digest emails.

Allowed values

* `DIGEST_FREQUENCY_NONE` No digest emails
* `DIGEST_FREQUENCY_WEEKLY` Weekly digest every Monday
* `DIGEST_FREQUENCY_MONTHLY` Monthly digest on the 1st of each month
* `DIGEST_FREQUENCY_UNSPECIFIED` Not specified; defaults to monthly

`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

Returns [the workspace object](#workspaces-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X PUT "https://api.linkbreakers.com/v1/workspace" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "description": "Boutique hotel in Lyon with a restaurant and a rooftop bar. Our QR codes sit on restaurant tables, flyers and posters.",
  "digestFrequency": "DIGEST_FREQUENCY_WEEKLY",
  "enforceMfa": true,
  "faq": "[{\"id\": \"1\", \"question\": \"Is breakfast included?\", \"answer\": \"Yes, breakfast is served from 7:00 to 10:30.\", \"order\": 0}]",
  "name": "Hotel Lumiere",
  "shortDescription": "Boutique hotel and restaurant in Lyon",
  "slug": "hotel-lumiere",
  "tags": "hotel,restaurant,lyon",
  "website": "https://example.com"
}'
```

### Response

200

An empty JSON object.

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X DELETE "https://api.linkbreakers.com/v1/workspace" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

---

Source: https://linkbreakers.com/help/api/workspaces
