Query · GET

fyi.opensocial.listGroups

The groups on a host, with public profiles. For signed-out pages.

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

Requires: no sign-in

Parameters

No fields.

Output

groupsarray of fyi.opensocial.defs#groupViewrequired

Schema

Lexicon JSON

{
  "lexicon": 1,
  "id": "fyi.opensocial.listGroups",
  "defs": {
    "main": {
      "type": "query",
      "description": "Host-level: the groups hosted here, with their profiles. v1 discovery; a real index would come from declarations on the public network.",
      "parameters": {
        "type": "params",
        "properties": {}
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "groups"
          ],
          "properties": {
            "groups": {
              "type": "array",
              "items": {
                "type": "ref",
                "ref": "fyi.opensocial.defs#groupView"
              }
            }
          }
        }
      }
    }
  }
}

← All host extensions