at.happyproto.admin.listCustomers Documentation (EN)

main query

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

Output

Encodingapplication/json

customers array Required

No description available.

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.

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": "The members of the customers space: everyone the customer endpoints admit. Staff only.",
  "errors": [
    {
      "description": "This endpoint requires an authenticated caller.",
      "name": "AuthRequired"
    },
    {
      "description": "The caller is not HappyProto staff.",
      "name": "Forbidden"
    },
    {
      "description": "The customers space is not configured or cannot be read.",
      "name": "Upstream"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "customers": {
          "items": {
            "ref": "#customer",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "customers"
      ],
      "type": "object"
    }
  },
  "type": "query"
}

customer object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

handle string handle Optional

Present when the membership record carries one.

View raw schema

{
  "properties": {
    "did": {
      "format": "did",
      "type": "string"
    },
    "handle": {
      "description": "Present when the membership record carries one.",
      "format": "handle",
      "type": "string"
    }
  },
  "required": [
    "did"
  ],
  "type": "object"
}