support.supper.entitlements.listEntitlements

supper.support

Documentation

List creator-owned support.supper.entitlement anchors, optionally filtered by kind. The creator convenience field is derived from the author repo; legacy records whose copied creator field names a different DID are excluded. Public outputs carry only anchor fields plus opaque listing strongRefs. The Supper-local productId/commissionId are app identifiers, never payment processor identifiers; no processor ids, buyer PII, or fulfillment data appear here.

main query

List creator-owned support.supper.entitlement anchors, optionally filtered by kind. The creator convenience field is derived from the author repo; legacy records whose copied creator field names a different DID are excluded. Public outputs carry only anchor fields plus opaque listing strongRefs. The Supper-local productId/commissionId are app identifiers, never payment processor identifiers; no processor ids, buyer PII, or fulfillment data appear here.

Parameters

creator string did Required

DID of the creator whose entitlement anchors to list.

cursor string Optional

Opaque cursor from a previous response.

kind string Optional

Optional filter restricting results to a single entitlement kind.

limit integer Optional

No description available.

Output

Encodingapplication/json
cursor string Optional

No description available.

entitlements array Required

No description available.

Try It

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

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
DID of the creator whose entitlement anchors to list.
Opaque cursor from a previous response.
Optional filter restricting results to a single entitlement kind.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "entitlements"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "maxLength": 4096
        },
        "entitlements": {
          "type": "array",
          "items": {
            "ref": "#entitlementView",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "creator"
    ],
    "properties": {
      "kind": {
        "type": "string",
        "maxLength": 32,
        "description": "Optional filter restricting results to a single entitlement kind.",
        "knownValues": [
          "support",
          "digital",
          "physical",
          "commission",
          "membership",
          "other"
        ]
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string",
        "maxLength": 4096,
        "description": "Opaque cursor from a previous response."
      },
      "creator": {
        "type": "string",
        "format": "did",
        "description": "DID of the creator whose entitlement anchors to list."
      }
    }
  },
  "description": "List creator-owned support.supper.entitlement anchors, optionally filtered by kind. The creator convenience field is derived from the author repo; legacy records whose copied creator field names a different DID are excluded. Public outputs carry only anchor fields plus opaque listing strongRefs. The Supper-local productId/commissionId are app identifiers, never payment processor identifiers; no processor ids, buyer PII, or fulfillment data appear here."
}
entitlementView object

No description available.

Properties

cid string cid Required

CID of the exact entitlement record generation returned in this view.

commissionId string Optional

Supper-local commission identifier. Not a payment processor identifier.

maxLength: 256 bytes
createdAt string datetime Optional

An RFC 3339 formatted timestamp.

creator string did Required

Author repo DID, derived by the AppView.

indexedAt string datetime Required

When the AppView indexed this record.

kind string Required

No description available.

maxLength: 32 bytes
Known values: support, digital, physical, commission, membership, other
productId string Optional

Supper-local product identifier. Not a payment processor identifier.

maxLength: 256 bytes
uri string at-uri Required

AT URI of the indexed support.supper.entitlement record.

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "creator",
    "kind",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the exact entitlement record generation returned in this view."
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the indexed support.supper.entitlement record."
    },
    "kind": {
      "type": "string",
      "maxLength": 32,
      "knownValues": [
        "support",
        "digital",
        "physical",
        "commission",
        "membership",
        "other"
      ]
    },
    "creator": {
      "type": "string",
      "format": "did",
      "description": "Author repo DID, derived by the AppView."
    },
    "listing": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the AppView indexed this record."
    },
    "productId": {
      "type": "string",
      "maxLength": 256,
      "description": "Supper-local product identifier. Not a payment processor identifier."
    },
    "commissionId": {
      "type": "string",
      "maxLength": 256,
      "description": "Supper-local commission identifier. Not a payment processor identifier."
    }
  }
}

Lexicon Garden

@