support.supper.actor.getPage

Documentation

Get a creator/supporter's cross-account Supper page: the indexed support.supper.actor.profile marker plus the actor.about section and all actor.project showcase entries for the account, regardless of which compatible app wrote them. Public Supper AppView read; responses contain only public record bodies and never private metadata or processor identifiers.

main query

Parameters

actor string at-identifier Required

DID or handle of the account whose Supper page to fetch.

Output

Encodingapplication/json

about ref#aboutView Optional

The account's support.supper.actor.about section, when one is indexed.

did stringdid Required

Resolved DID of the requested account.

profile ref#profileView Optional

The account's support.supper.actor.profile marker when it holds the canonical first-writer-wins page slug. A non-canonical collision claim is omitted.

projects array Required

All indexed support.supper.actor.project entries for the account, newest first.

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)

Parameters

actor * DID or handle of the account whose Supper page to fetch.

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "did",
        "projects"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "Resolved DID of the requested account."
        },
        "about": {
          "ref": "#aboutView",
          "type": "ref",
          "description": "The account's support.supper.actor.about section, when one is indexed."
        },
        "profile": {
          "ref": "#profileView",
          "type": "ref",
          "description": "The account's support.supper.actor.profile marker when it holds the canonical first-writer-wins page slug. A non-canonical collision claim is omitted."
        },
        "projects": {
          "type": "array",
          "items": {
            "ref": "#projectView",
            "type": "ref"
          },
          "maxLength": 200,
          "description": "All indexed support.supper.actor.project entries for the account, newest first."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "actor"
    ],
    "properties": {
      "actor": {
        "type": "string",
        "format": "at-identifier",
        "description": "DID or handle of the account whose Supper page to fetch."
      }
    }
  },
  "description": "Get a creator/supporter's cross-account Supper page: the indexed support.supper.actor.profile marker plus the actor.about section and all actor.project showcase entries for the account, regardless of which compatible app wrote them. Public Supper AppView read; responses contain only public record bodies and never private metadata or processor identifiers."
}

aboutView object

No description available.

Properties

cid string cid Required

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

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

did string did Required

A decentralized identifier (DID).

indexedAt string datetime Required

When the AppView indexed this record.

text string Required

Public about section text from the record body.

maxLength: 20000 bytesmaxGraphemes: 2000 graphemes

uri string at-uri Required

AT URI of the indexed support.supper.actor.about record.

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "did",
    "text",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the exact about record generation returned in this view."
    },
    "did": {
      "type": "string",
      "format": "did"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the indexed support.supper.actor.about record."
    },
    "text": {
      "type": "string",
      "maxLength": 20000,
      "description": "Public about section text from the record body.",
      "maxGraphemes": 2000
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the AppView indexed this record."
    }
  }
}

profileView object

No description available.

Properties

cid string cid Required

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

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

did string did Required

Author/owner DID of the profile record.

indexedAt string datetime Required

When the AppView indexed this record.

pageMode string Optional

No description available.

maxLength: 32 bytes

Known values: support, shop, both

pageType string Required

No description available.

maxLength: 32 bytes

Known values: creator, project, supporter

slug string Required

The canonical supper.support page slug bound to this DID (first-writer-wins).

maxLength: 253 bytes

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string at-uri Required

AT URI of the indexed support.supper.actor.profile record.

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "did",
    "pageType",
    "slug",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the exact profile record generation returned in this view."
    },
    "did": {
      "type": "string",
      "format": "did",
      "description": "Author/owner DID of the profile record."
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the indexed support.supper.actor.profile record."
    },
    "slug": {
      "type": "string",
      "maxLength": 253,
      "description": "The canonical supper.support page slug bound to this DID (first-writer-wins)."
    },
    "pageMode": {
      "type": "string",
      "maxLength": 32,
      "knownValues": [
        "support",
        "shop",
        "both"
      ]
    },
    "pageType": {
      "type": "string",
      "maxLength": 32,
      "knownValues": [
        "creator",
        "project",
        "supporter"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the AppView indexed this record."
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}

projectView object

No description available.

Properties

atHandle string handle Optional

An AT Protocol handle (e.g., alice.bsky.social).

cid string cid Required

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

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 5000 bytesmaxGraphemes: 500 graphemes

did string did Required

A decentralized identifier (DID).

indexedAt string datetime Required

When the AppView indexed this record.

title string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

uri string at-uri Required

AT URI of the indexed support.supper.actor.project record.

url string uri Optional

A valid URI.

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "did",
    "title",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the exact project record generation returned in this view."
    },
    "did": {
      "type": "string",
      "format": "did"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the indexed support.supper.actor.project record."
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string",
      "maxLength": 1000,
      "maxGraphemes": 100
    },
    "atHandle": {
      "type": "string",
      "format": "handle"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the AppView indexed this record."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "maxGraphemes": 500
    }
  }
}