Workspace

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/linkbreakers-com/json-schema/linkbreakers-com-workspace-schema.json",
  "title": "Workspace",
  "description": "Serves as the tenant boundary in Linkbreakers, grouping links, members, settings, billing state,\nand analytics under a single organization's environment.",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/linkbreakers-com-openapi.json#/components/schemas/Workspace",
  "properties": {
    "country": {
      "title": "ISO 3166-1 alpha-2 country code inferred from the owner signup or link activity",
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "title": "Timestamp when the workspace record was created",
      "type": "string"
    },
    "description": {
      "title": "Optional description providing additional context about the workspace",
      "type": "string"
    },
    "digestFrequency": {
      "description": "- DIGEST_FREQUENCY_UNSPECIFIED: Not specified; defaults to monthly\n - DIGEST_FREQUENCY_NONE: No digest emails\n - DIGEST_FREQUENCY_WEEKLY: Weekly digest every Monday\n - DIGEST_FREQUENCY_MONTHLY: Monthly digest on the 1st of each month",
      "enum": [
        "DIGEST_FREQUENCY_UNSPECIFIED",
        "DIGEST_FREQUENCY_NONE",
        "DIGEST_FREQUENCY_WEEKLY",
        "DIGEST_FREQUENCY_MONTHLY"
      ],
      "title": "How often the workspace receives traffic digest emails (none, weekly, monthly)"
    },
    "enforceMfa": {
      "title": "Whether members must complete multi-factor authentication at sign in",
      "type": "boolean"
    },
    "enrollRequestedAt": {
      "format": "date-time",
      "title": "Timestamp when enrollment was requested for this workspace",
      "type": "string"
    },
    "faq": {
      "description": "Frequently Asked Questions about this workspace stored as JSON",
      "title": "FAQ data stored as JSON",
      "type": "string"
    },
    "id": {
      "title": "Unique identifier for the workspace (UUID)",
      "type": "string"
    },
    "inactiveSince": {
      "format": "date-time",
      "title": "When the workspace was flagged as inactive due to lack of activity (cleared on next sign-in/scan)",
      "type": "string"
    },
    "linkSettingId": {
      "title": "Link setting configuration that governs visitor data collection (UUID)",
      "type": "string"
    },
    "name": {
      "title": "Human-readable display name chosen during signup",
      "type": "string"
    },
    "publishedAt": {
      "format": "date-time",
      "title": "Timestamp when the workspace was published/made public",
      "type": "string"
    },
    "shortDescription": {
      "title": "Short description for the workspace",
      "type": "string"
    },
    "slug": {
      "title": "Unique slug for the workspace (URL-friendly identifier)",
      "type": "string"
    },
    "subscriptionType": {
      "description": "- SUBSCRIPTION_TYPE_UNSPECIFIED: Subscription plan not yet assigned\n - SUBSCRIPTION_TYPE_FREE_TRIAL: Workspace is currently in the free trial period\n - SUBSCRIPTION_TYPE_SPONSORED_PRO: Workspace is on the sponsored pro plan with full pro features\n - SUBSCRIPTION_TYPE_PRO_PLAN: Workspace has an active Pro plan subscription\n - SUBSCRIPTION_TYPE_ENTERPRISE_PLAN: Workspace is managed under an Enterprise contract\n - SUBSCRIPTION_TYPE_LIGHT_PLAN: Workspace has an active Light plan subscription",
      "enum": [
        "SUBSCRIPTION_TYPE_UNSPECIFIED",
        "SUBSCRIPTION_TYPE_FREE_TRIAL",
        "SUBSCRIPTION_TYPE_SPONSORED_PRO",
        "SUBSCRIPTION_TYPE_PRO_PLAN",
        "SUBSCRIPTION_TYPE_ENTERPRISE_PLAN",
        "SUBSCRIPTION_TYPE_LIGHT_PLAN"
      ],
      "title": "Billing plan currently applied to the workspace"
    },
    "tags": {
      "title": "Comma-separated tags for the workspace",
      "type": "string"
    },
    "timezone": {
      "title": "Default timezone used to render analytics and schedules (IANA name)",
      "type": "string"
    },
    "trialEndsAt": {
      "format": "date-time",
      "title": "When the free trial period ends (null if not on trial)",
      "type": "string"
    },
    "unverifiedPauseAt": {
      "description": "When the workspace is paused for not having a verified email address.\nWhile it is in the future, the workspace works normally and a member has\nuntil then to verify their email. Once it has passed, every API call\nother than signing in, reading the member and workspace, switching\nworkspace and requesting a verification email answers\nWORKSPACE_UNVERIFIED, until a member verifies their email. QR codes and\nlinks keep working for visitors throughout. Empty when the workspace is\nverified or paying.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "updatedAt": {
      "format": "date-time",
      "title": "Timestamp of the last workspace-level update",
      "type": "string"
    },
    "verifiedAt": {
      "format": "date-time",
      "title": "Timestamp when the workspace passed verification (e.g., owner email confirmed)",
      "type": "string"
    },
    "website": {
      "title": "Website URL for the workspace",
      "type": "string"
    }
  },
  "type": "object"
}