com.atproto.server.getAccountInviteCodes Documentation (EN)

main query

Get all invite codes for the current account. Requires auth.

Parameters

createAvailable boolean Optional

Controls whether any new 'earned' but not 'created' invites should be created.

includeUsed boolean Optional

No description available.

Output

Encodingapplication/json

codes array Required

No description available.

Errors

DuplicateCreate

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

{
  "description": "Get all invite codes for the current account. Requires auth.",
  "errors": [
    {
      "name": "DuplicateCreate"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "codes": {
          "items": {
            "ref": "com.atproto.server.defs#inviteCode",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "codes"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "createAvailable": {
        "default": true,
        "description": "Controls whether any new 'earned' but not 'created' invites should be created.",
        "type": "boolean"
      },
      "includeUsed": {
        "default": true,
        "type": "boolean"
      }
    },
    "type": "params"
  },
  "type": "query"
}