Workspaces schemas

These definitions are generated from the downloadable OpenAPI contract. Required fields, validation constraints and additional-property policies are preserved.

Workspace

Field	Type	Required	Constraints / description
id	string	Yes	format: "uuid"
name	string	Yes	—
ownerIdentityId	string	Yes	format: "uuid"
version	integer	Yes	minimum: 1
archivedAt	string or null	Yes	format: "date-time"
createdAt	string	Yes	format: "date-time"
role	Owner, Admin, Editor, Viewer	Yes	—

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "ownerIdentityId": {
      "type": "string",
      "format": "uuid"
    },
    "version": {
      "type": "integer",
      "minimum": 1
    },
    "archivedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "role": {
      "type": "string",
      "enum": [
        "Owner",
        "Admin",
        "Editor",
        "Viewer"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "ownerIdentityId",
    "version",
    "archivedAt",
    "createdAt",
    "role"
  ],
  "additionalProperties": false
}

Member

Field	Type	Required	Constraints / description
identityId	string	Yes	format: "uuid"
email	string	Yes	format: "email"
role	Owner, Admin, Editor, Viewer	Yes	—
createdAt	string	Yes	format: "date-time"

{
  "type": "object",
  "properties": {
    "identityId": {
      "type": "string",
      "format": "uuid"
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "role": {
      "type": "string",
      "enum": [
        "Owner",
        "Admin",
        "Editor",
        "Viewer"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "identityId",
    "email",
    "role",
    "createdAt"
  ],
  "additionalProperties": false
}

Invitation

Field	Type	Required	Constraints / description
id	string	Yes	format: "uuid"
workspaceId	string	Yes	format: "uuid"
workspaceName	string	Yes	—
email	string	Yes	format: "email"
role	Admin, Editor, Viewer	Yes	—
inviterId	string	Yes	format: "uuid"
recipientId	string or null	Yes	format: "uuid"
status	pending, accepted, declined, revoked, expired	Yes	—
delivery	preparing, accepted, unconfirmed	Yes	—
expiresAt	string	Yes	format: "date-time"
createdAt	string	Yes	format: "date-time"

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid"
    },
    "workspaceName": {
      "type": "string"
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "role": {
      "type": "string",
      "enum": [
        "Admin",
        "Editor",
        "Viewer"
      ]
    },
    "inviterId": {
      "type": "string",
      "format": "uuid"
    },
    "recipientId": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "accepted",
        "declined",
        "revoked",
        "expired"
      ]
    },
    "delivery": {
      "type": "string",
      "enum": [
        "preparing",
        "accepted",
        "unconfirmed"
      ]
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "workspaceId",
    "workspaceName",
    "email",
    "role",
    "inviterId",
    "recipientId",
    "status",
    "delivery",
    "expiresAt",
    "createdAt"
  ],
  "additionalProperties": false
}

Error

Field	Type	Required	Constraints / description
error	string	Yes	—
message	string	Yes	—
requestId	string	No	—

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": false
}

Success

Field	Type	Required	Constraints / description
success	boolean	Yes	—

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "additionalProperties": false
}

InvitationResponse

Field	Type	Required	Constraints / description
workspaceId	string	Yes	format: "uuid"

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "workspaceId"
  ],
  "additionalProperties": false
}

WorkspacePage

Schema reference: Workspace.

Field	Type	Required	Constraints / description
items	Array of Workspace	Yes	—
page	integer	Yes	—
pageSize	integer	Yes	—
hasMore	boolean	Yes	—

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Workspace"
      }
    },
    "page": {
      "type": "integer"
    },
    "pageSize": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}

MemberPage

Schema reference: Member.

Field	Type	Required	Constraints / description
items	Array of Member	Yes	—
page	integer	Yes	—
pageSize	integer	Yes	—
hasMore	boolean	Yes	—

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Member"
      }
    },
    "page": {
      "type": "integer"
    },
    "pageSize": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}

InvitationPage

Schema reference: Invitation.

Field	Type	Required	Constraints / description
items	Array of Invitation	Yes	—
page	integer	Yes	—
pageSize	integer	Yes	—
hasMore	boolean	Yes	—

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Invitation"
      }
    },
    "page": {
      "type": "integer"
    },
    "pageSize": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ],
  "additionalProperties": false
}