app.tempomusic.staff.listInviteCodes

lexicons.tempomusic.fan

Documentation

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 is returned.

main query

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 is returned.

Parameters

createdBy string did Optional

Optional DID filter. When set, only codes generated by that staff account are returned.

Output

Encodingapplication/json
codes array Required

No description available.

Errors

Forbidden The caller is not a super-admin.
PdsUnavailable The PDS returned a transient failure — the query never lands locally, retry.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Optional DID filter. When set, only codes generated by that staff account are returned.
View raw schema
{
  "type": "query",
  "errors": [
    {
      "name": "Forbidden",
      "description": "The caller is not a super-admin."
    },
    {
      "name": "PdsUnavailable",
      "description": "The PDS returned a transient failure — the query never lands locally, retry."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "codes"
      ],
      "properties": {
        "codes": {
          "type": "array",
          "items": {
            "ref": "app.tempomusic.staff.defs#inviteCodeView",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "createdBy": {
        "type": "string",
        "format": "did",
        "description": "Optional DID filter. When set, only codes generated by that staff account are returned."
      }
    }
  },
  "description": "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 is returned."
}

Lexicon Garden

@