Space

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

• POSTCreate Space/api/v1/spaces
• GETGet Space/api/v1/spaces/{space}
• PATCHUpdate Space/api/v1/spaces/{space}

Referenced by these component schemas:

• ListSpacesResponse
• SpaceInvitation
• UserNotification_SpaceInvitationPayload

Shape and fields

object

Space is a collaboration boundary for placed memos.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "required": [
    "title"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The resource name of the space. Format: spaces/{space}."
    },
    "title": {
      "type": "string",
      "description": "Required. The human-readable title."
    },
    "description": {
      "type": "string",
      "description": "Optional. A description of the space."
    },
    "currentUserRole": {
      "readOnly": true,
      "enum": [
        "ROLE_UNSPECIFIED",
        "ADMIN",
        "USER"
      ],
      "type": "string",
      "description": "Output only. The authenticated user's membership role in this space.\n ROLE_UNSPECIFIED when this Space is exposed as metadata-only.",
      "format": "enum"
    },
    "memberCount": {
      "readOnly": true,
      "type": "integer",
      "description": "Output only. The number of accepted members in this space. Pending\n invitations are excluded. Zero when this Space is exposed as metadata-only.",
      "format": "int32"
    },
    "icon": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Space_Icon"
        }
      ],
      "description": "Optional. Display icon. Omit when updating with the \"icon\" mask to reset\n to the default Space mark."
    }
  },
  "description": "Space is a collaboration boundary for placed memos."
}