Lexicon Garden

com.atproto.admin.getInviteCodes

Get an admin view of invite codes.

Repository @atproto-lexicons.bsky.social did:plc:6msi3pj7krzih5qxqtryxlzw namespace authority
Details · query
Kindquery
Authorityadmin.atproto.com
Indexed
Compare Edit in builder → Fork →
cid bafyreiec5v6odvpqm3qfcxmuq5nihskij7xmb5nij32vve426z6s7tii24

Checks

Valid
  • unlimited-string defs.main.parameters.properties.cursorNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.parameters.properties.sortNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.cursorNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get an admin view of invite codes.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "codes": {
              "items": {
                "ref": "com.atproto.server.defs#inviteCode",
                "type": "ref"
              },
              "type": "array"
            },
            "cursor": {
              "type": "string"
            }
          },
          "required": [
            "codes"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 100,
            "maximum": 500,
            "minimum": 1,
            "type": "integer"
          },
          "sort": {
            "default": "recent",
            "knownValues": [
              "recent",
              "usage"
            ],
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "com.atproto.admin.getInviteCodes",
  "lexicon": 1
}