at.happyproto.admin.listInvites

happyproto.at

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "invite": {
      "properties": {
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "createdBy": {
          "format": "did",
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "expiresAt": {
          "format": "datetime",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "redeemedAt": {
          "format": "datetime",
          "type": "string"
        },
        "redeemedDid": {
          "format": "did",
          "type": "string"
        },
        "status": {
          "knownValues": [
            "pending",
            "expired",
            "redeemed"
          ],
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "status",
        "createdBy",
        "createdAt",
        "expiresAt"
      ],
      "type": "object"
    },
    "main": {
      "description": "Every customer invite, newest first: the address it went to, whether it is pending, expired or redeemed, and by which account. Staff only.",
      "errors": [
        {
          "description": "This endpoint requires an authenticated caller.",
          "name": "AuthRequired"
        },
        {
          "description": "The caller is not HappyProto staff.",
          "name": "Forbidden"
        },
        {
          "description": "The provisioner could not be reached, or refused.",
          "name": "Upstream"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "invites": {
              "items": {
                "ref": "#invite",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "invites"
          ],
          "type": "object"
        }
      },
      "type": "query"
    }
  },
  "id": "at.happyproto.admin.listInvites",
  "lexicon": 1
}

Validate Record

Validate a record against at.happyproto.admin.listInvites

Validation Options
Treat any remaining unresolved references as valid

Metadata

DID
did:plc:mo7vq4jbioxwafy5zkcc3eux
CID
bafyreid7234vnsxvewbzfbistjcftkfwesway47p37qfnzm73z7tvecwbq
Indexed At
2026-10-27 22:08 UTC
AT-URI
at://did:plc:mo7vq4jbioxwafy5zkcc3eux/com.atproto.lexicon.schema/at.happyproto.admin.listInvites

Similar Lexicons

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

  • Invite customers: mint one single-use customers-space invite per address, each expiring after expiresInDays, and record which address each went to, so a redeemed invite pairs the address with the account. Redeemed with …

  • Redeem an invite from admin.createInvites: the caller joins the customers space with read access, and the address the invite went to is paired with the caller's account. Redeeming as an account that is already a custome…

  • 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 …

  • The members of the customers space: everyone the customer endpoints admit. Staff only.

  • List collaboration invites, filtered by invitee, inviter, and/or subject. Typically used to populate an invitee's inbox.

Lexicon Garden

@