at.happyproto.admin.listInvites

Documentation

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

main query

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

Output

Encodingapplication/json

invites array Required

No description available.

Errors

AuthRequired This endpoint requires an authenticated caller.

Forbidden The caller is not HappyProto staff.

Upstream The provisioner could not be reached, or refused.

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "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"
}

invite object

No description available.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

createdBy string did Required

A decentralized identifier (DID).

email string Required

No description available.

expiresAt string datetime Required

An RFC 3339 formatted timestamp.

id string Required

No description available.

redeemedAt string datetime Optional

An RFC 3339 formatted timestamp.

redeemedDid string did Optional

A decentralized identifier (DID).

status string Required

No description available.

Known values: pending, expired, redeemed

View raw schema

{
  "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"
}