fyi.opensocial.getGroup

Get a detailed view of a group: its profile and rules, and — for a viewer who may read the members space — how many are in it (listMembers names them), its roles, spaces and their read gates, plus the join queue for a viewer holding `admit`. Without auth, only the group's did and handle; with it, the viewer's standing and what their roles let them read. Every gate is the decision a space credential is minted on.

Details · query
Kindquery
Authorityopensocial.fyi
Indexed

Query

query · GET

Parameters

query string

group

requiredstring · did

The group DID.

Output

application/json
itemsref

Pending requests, newest first. Present only for a viewer holding `admit`.

itemsref

roles

array
itemsref

spaces

array
itemsref

Errors

GroupNotFound

No description in schema.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • The caller's own pending request to join, if they have one. Requires no action: listJoinRequests is the moderator's queue and needs `admit`, which leaves a requester unable to see the request they themselves made. Returns nothing once a request has been decided, so a denial is not disclosed.

  • Contents of an access record.

  • A group's members, each with their roles, a page at a time in the order of their DIDs, for a caller who may read its members space. With `q`, only those whose handle or DID holds it.

  • social.grain.unspecced.getGroup

    query not from the namespace authority

    A group: a group DID that has declared itself and shows up in Grain as an author whose pool is other people's galleries.

  • Host-level: the groups hosted here, with their profiles. v1 discovery; a real index would come from declarations on the public network.