Archbee · Schema

Member

API DocumentationDocumentation PlatformKnowledge BaseTechnical WritingDeveloper Docs

Properties

Name Type Description
id string User identifier
email string Member email address
name string Member display name
role string Member role in the space
View JSON Schema on GitHub

JSON Schema

archbee-api-member-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "User identifier",
      "example": "usr_abc123"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Member email address",
      "example": "[email protected]"
    },
    "name": {
      "type": "string",
      "description": "Member display name",
      "example": "Alice Smith"
    },
    "role": {
      "type": "string",
      "description": "Member role in the space",
      "enum": [
        "owner",
        "admin",
        "editor",
        "viewer",
        "commenter"
      ],
      "example": "editor"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/archbee/refs/heads/main/json-schema/archbee-api-member-schema.json",
  "title": "Member"
}