Lexicon Garden

at.happyproto.admin.listInvites

Every customer invite, newest first: the address it went to, whether it is pending, expired or redeemed, and by which account. Staff only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityadmin.happyproto.at
Indexed
Compare Edit in builder → Fork →
cid bafyreid7234vnsxvewbzfbistjcftkfwesway47p37qfnzm73z7tvecwbq

Checks

Valid
  • unlimited-string defs.invite.properties.emailNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.invite.properties.idNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.invite.properties.statusNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$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
}