com.atproto.admin.getInviteCodes Documentation (EN)

main query

Get an admin view of invite codes.

Parameters

cursor string Optional

No description available.

limit integer Optional

No description available.

sort string Optional

No description available.

Output

Encodingapplication/json

codes array Required

No description available.

cursor string Optional

No description available.

Try It

Direct PDS XRPC methods (com.atproto.*) are disabled in Try It for security reasons.

These methods interact directly with Personal Data Servers and require careful handling. Use a dedicated client or CLI tool instead.

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "codes"
      ],
      "properties": {
        "codes": {
          "type": "array",
          "items": {
            "ref": "com.atproto.server.defs#inviteCode",
            "type": "ref"
          }
        },
        "cursor": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "sort": {
        "type": "string",
        "default": "recent",
        "knownValues": [
          "recent",
          "usage"
        ]
      },
      "limit": {
        "type": "integer",
        "default": 100,
        "maximum": 500,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      }
    }
  },
  "description": "Get an admin view of invite codes."
}