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

Query

query · GET

Output

application/json

invites

requiredarray
itemsref
Reference

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not HappyProto staff.

Upstream

The provisioner could not be reached, or refused.

#invite

object

Properties

createdAt

requiredstring · datetime

createdBy

requiredstring · did

email

requiredstring

expiresAt

requiredstring · datetime

id

requiredstring

redeemedAt

string · datetime

redeemedDid

string · did

status

requiredstring
  • knownValues: pending | expired | redeemed

Similar lexicons

semantic match

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 actor.acceptInvite. Staff only.

  • 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 customer succeeds and spends nothing. Any signed-in account may call this; the token is the authority.

  • 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

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