Represents a group or an event.
Main fields
These are always returned.
Unique (within the server) identifier for this group.
The name of this group or event.
For restricted groups, their restriction status. If this is set, none of the optional fields will be returned.
banned– The group is suspended.deleted– The group was deleted by its creator.hidden– The server staff made this group only visible to authenticated users.
Globally unique ActivityPub identifier for this group. Use this to match groups across servers.
Determines how new members can join this group and what is visible to non-members.
closed– Anyone can see the group’s profile, and new members are manually approved by the group managers or invited by existing members. Only members can see the content. For groups only.open– This is an open group or event, anyone can join.private– Only members can see this group or event. Only managers can invite new members, and the only way to join is by invitation.
The type of this community.
Possible values:
group,
event.
Optional fields
Unless otherwise noted, request these by passing them in fields to any method that returns group objects.
For a group from a remote server, the domain of its home server.
The profile URL a.k.a. the username. If the community doesn’t have one set, defaults to clubXXX for groups and eventXXX for events.
The status string, the one that’s displayed under the group’s name on the web.
The URL of this group’s profile page on the web. For remote groups, this points to its home server.
Whether the current user can manage this group.
The privilege level of the current user, if is_admin is true.
Possible values:
moderator,
admin,
owner.
Whether the current user is a member of this group.
URL of a square 50x50 version of the profile picture.
URL of a square 100x100 version of the profile picture.
URL of a square 200x200 version of the profile picture.
URL of a square 400x400 version of the profile picture.
URL of a rectangular 200px wide version of the profile picture.
URL of a rectangular 400px wide version of the profile picture.
If this group has a “profile pictures” system photo album, ID of the photo used for the current profile picture in that album.
Whether the current user can create new discussion board topics in this group.
Whether the current user can create new posts on this group’s wall.
Information about users who manage this group. Only returned when a single group is requested.
User identifier.
Description to be shown alongside the name.
Information about how many of each of the types of content there are in this group. Only returned when a single group is requested.
How many photos there are in the group.
How many photo albums there are in the group.
How many topics there are in the group’s discussion board.
The description text of this group, as HTML.
Whether this group has a profile picture.
Whether this group is in the current user’s bookmarks. Requires the likes:read permission.
Information from the “Links” block in this group. Only returned when a single group is requested.
Identifier of this link.
The URL of this link.
The title of this link.
The description of this link.
50x50 preview image URL.
100x100 preview image URL.
200x200 preview image URL.
If this link points to an object, the type of that object.
Possible values:
user,
group,
post,
photo,
photo_album,
topic.
If this link points to an object, the identifier of that object.
The membership status of the current user in this group.
invited– A friend invited this user to this group.member– This user is a member of this group.none– This user is not a member of this group.requested– This user has requested to join this group, but the request hasn’t yet been reviewed by the management.tentative– This user is not sure that they will attend this event.
The name of the place and/or address where this event will take place.
The website URL from the group’s profile.
The unixtime when the event starts.
The unixtime when the event ends.