Lexicon Garden

fyi.opensocial.listMembers

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.

Repository @lexicons.opensocial.fyi did:plc:2gqnilpksz2e7faj3bwvo6qc namespace authority
Details · query
Kindquery
Authorityopensocial.fyi
Indexed
Compare Edit in builder → Fork →
cid bafyreiabnvj5fctsqgy53sbvnbc5lnakngzurona7scg6xio5dersf776m

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.cursorNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "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.",
      "errors": [
        {
          "name": "GroupNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "Present while there are more.",
              "type": "string"
            },
            "members": {
              "items": {
                "ref": "fyi.opensocial.defs#memberView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "members"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "maxLength": 2048,
            "type": "string"
          },
          "group": {
            "description": "The group DID.",
            "format": "did",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "q": {
            "description": "Part of a member's handle or DID, in any case.",
            "maxLength": 256,
            "type": "string"
          }
        },
        "required": [
          "group"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.listMembers",
  "lexicon": 1
}