Groups

Groups are a way to organize users and notes into communities. They can be used for any purpose, such as forums, blogs, image galleries, video sharing, audio sharing, and messaging. They are similar to Discord's channels or Matrix's rooms.

Refer to Note's group property for how notes can be associated with groups.

Entity Definition

  • Name
    name
    Type
    ContentFormat
    Description

    Group name/title.

    Text only (text/plain, text/html, etc).

  • Name
    description
    Type
    ContentFormat
    Description

    Short description of the group's contents and purpose.

    Text only (text/plain, text/html, etc).

  • Name
    members
    Required
    Required
    Type
    URI
    Description

    URI of the group's members list. Collection of Users.

  • Name
    notes
    Type
    URI
    Description

    URI of the group's associated notes. Collection of Notes.

Example Group

{
    "type": "Group",
    "id": "ed480922-b095-4f09-9da5-c995be8f5960",
    "uri": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
    "name": {
        "text/html": {
            "content": "The <strong>Woozy</strong> fan club"
        }
    },
    "description": {
        "text/plain": {
            "content": "A group for fans of the Woozy emoji."
        }
    },
    "members": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960/members",
}