Lexicon Garden

at.happyproto.admin.listCustomers

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

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

Query

query · GET

Output

application/json

customers

requiredarray
itemsref
Reference

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not HappyProto staff.

Upstream

The customers space is not configured or cannot be read.

#customer

object

Properties

did

requiredstring · did

handle

string · handle

Present when the membership record carries one.

Similar lexicons

semantic match

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

  • at.happyproto.admin.addCustomer

    procedure

    Make an account a customer: add it to the customers space with read access. Adding an existing member succeeds and changes nothing. Staff only.

  • at.happyproto.admin.removeCustomer

    procedure

    Stop an account being a customer: remove it from the customers space. Removing a non-member succeeds. Staff only.

  • at.happyproto.admin.listInvites

    query

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