com.atproto.admin.getInviteCodes

Get an admin view of invite codes.

Details · query
Kindquery
Authorityadmin.atproto.com
Indexed

Query

query · GET

Parameters

query string

cursor

string

limit

integer
  • minimum: 1
  • maximum: 500
  • default: 100

sort

string
  • default: "recent"
  • knownValues: recent | usage

Output

application/json

codes

requiredarray

cursor

string

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

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

  • List PDS invite codes on-demand via the PDS (`com.atproto.admin.getInviteCodes`). No local mirror — the source of truth is the PDS. Requires the caller to have the `superAdmin` role. Codes are returned as suffix-only strings (the env prefix stored under `APPVIEW_PDS_INVITE_CODE_PREFIX` has been stripped). Optional `createdBy` filter narrows the listing to codes emitted by a specific staff DID (applied server-side by the AppView — the admin endpoint has no such parameter); when omitted every code

  • Lists a community's invitation codes.