MenuMethods

Query · GET

group.opensocial.listJoinRequests

The pending-requests queue.

The pending-requests queue. Requires admit.

Requires
admit

Parameters

groupstring · didrequired

The group DID. Every method is served by the group's host and authorized against that group's roles.

limitinteger
max 100default 50
cursorstring

Output

cursorstring
requestsarray of group.opensocial.defs#joinRequestViewrequired

Schema

Lexicon JSON
{
  "lexicon": 1,
  "id": "group.opensocial.listJoinRequests",
  "defs": {
    "main": {
      "type": "query",
      "description": "The pending-requests queue. Requires admit.",
      "parameters": {
        "type": "params",
        "required": [
          "group"
        ],
        "properties": {
          "group": {
            "type": "string",
            "format": "did",
            "description": "The group DID. Every method is served by the group's host and authorized against that group's roles."
          },
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100
          },
          "cursor": {
            "type": "string"
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "requests"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "requests": {
              "type": "array",
              "items": {
                "type": "ref",
                "ref": "group.opensocial.defs#joinRequestView"
              }
            }
          }
        }
      }
    }
  }
}

← All methods