# support.supper.entitlements.listEntitlements

> Published by [supper.support](https://lexicon.garden/identity/did:plc:mcsqdltevtjpu26xthzzmm2l)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mcsqdltevtjpu26xthzzmm2l/support.supper.entitlements.listEntitlements)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mcsqdltevtjpu26xthzzmm2l/support.supper.entitlements.listEntitlements/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mcsqdltevtjpu26xthzzmm2l/support.supper.entitlements.listEntitlements/examples)

## Definitions

### `support.supper.entitlements.listEntitlements`

**Type**: `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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `kind` | `string` | No | Optional filter restricting results to a single entitlement kind. |
| `limit` | `integer` | No |  |
| `cursor` | `string` | No | Opaque cursor from a previous response. |
| `creator` | `string` (did) | Yes | DID of the creator whose entitlement anchors to list. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `entitlements` | `array` | Yes |  |

### `support.supper.entitlements.listEntitlements#entitlementView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes | CID of the exact entitlement record generation returned in this view. |
| `uri` | `string` (at-uri) | Yes | AT URI of the indexed support.supper.entitlement record. |
| `kind` | `string` | Yes |  |
| `creator` | `string` (did) | Yes | Author repo DID, derived by the AppView. |
| `listing` | `ref` → `com.atproto.repo.strongRef` | No |  |
| `createdAt` | `string` (datetime) | No |  |
| `indexedAt` | `string` (datetime) | Yes | When the AppView indexed this record. |
| `productId` | `string` | No | Supper-local product identifier. Not a payment processor identifier. |
| `commissionId` | `string` | No | Supper-local commission identifier. Not a payment processor identifier. |

## Raw Schema

```json
{
  "id": "support.supper.entitlements.listEntitlements",
  "defs": {
    "main": {
      "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": {
      "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."
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```