Workspace

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/firma-dev/main/json-schema/firma-dev-workspace-schema.json",
  "title": "Workspace",
  "x-generated": "2026-09-25",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/firma-dev-workspaces-api-openapi.yml#/components/schemas/Workspace",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the workspace"
    },
    "name": {
      "type": "string",
      "description": "Workspace name",
      "maxLength": 255
    },
    "protected": {
      "type": "boolean",
      "description": "Protected workspaces cannot be deleted"
    },
    "api_key": {
      "type": [
        "string",
        "null"
      ],
      "description": "Live-mode API key for this workspace. Used for authenticating API requests scoped to this workspace."
    },
    "test_api_key": {
      "type": [
        "string",
        "null"
      ],
      "description": "Test-mode API key for this workspace. Requests authenticated with this key do not consume credits and produce test-flagged, watermarked signing requests."
    },
    "created_date": {
      "type": "string",
      "format": "date-time",
      "description": "Workspace creation timestamp"
    },
    "updated_date": {
      "type": "string",
      "format": "date-time",
      "description": "Workspace last update timestamp"
    },
    "webhook_enabled": {
      "type": "boolean",
      "description": "Whether workspace-level webhooks are enabled"
    },
    "webhook_secret": {
      "type": [
        "string",
        "null"
      ],
      "description": "Webhook signing secret for this workspace"
    },
    "webhook_secret_rotated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Timestamp of the last webhook secret rotation"
    },
    "webhook_secret_created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Timestamp when the webhook secret was first created"
    },
    "ignore_company_webhooks": {
      "type": "boolean",
      "description": "When true, company-level webhooks do not fire for events in this workspace"
    },
    "icon_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Publicly accessible URL to the workspace logo image. Returns the workspace-specific logo, or null if not set (company logo is NOT included as fallback in this field)."
    }
  },
  "required": [
    "id",
    "name",
    "created_date"
  ]
}