support.supper.comments.listComments

Documentation

List public support.supper.comment records attached to one site.standard.document, support.supper.feed.post, fm.plyr.track, or support.supper.poll.poll across commenter repositories. This query returns portable public record data only; moderation and record deletion remain visible through the indexed protocol state.

main query

Parameters

cursor string Optional

Opaque cursor from a previous response.

limit integer Optional

No description available.

subject string at-uri Required

AT URI of the site.standard.document, support.supper.feed.post, fm.plyr.track, or support.supper.poll.poll whose comments should be listed. The service must reject subjects outside those collections.

uri string at-uri Optional

Optional exact support.supper.comment AT URI. When present, the result contains at most that one indexed comment and cursor must be omitted.

Output

Encodingapplication/json

comments array Required

No description available.

cursor string Optional

No description available.

total integer Required

Exact number of indexed comments matching this query across all pages.

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

cursor Opaque cursor from a previous response.

limit

subject * AT URI of the site.standard.document, support.supper.feed.post, fm.plyr.track, or support.supper.poll.poll whose comments should be listed. The service must reject subjects outside those collections.

uri Optional exact support.supper.comment AT URI. When present, the result contains at most that one indexed comment and cursor must be omitted.

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "comments",
        "total"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "minimum": 0,
          "description": "Exact number of indexed comments matching this query across all pages."
        },
        "cursor": {
          "type": "string",
          "maxLength": 4096
        },
        "comments": {
          "type": "array",
          "items": {
            "ref": "#commentView",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "subject"
    ],
    "properties": {
      "uri": {
        "type": "string",
        "format": "at-uri",
        "description": "Optional exact support.supper.comment AT URI. When present, the result contains at most that one indexed comment and cursor must be omitted."
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string",
        "maxLength": 4096,
        "description": "Opaque cursor from a previous response."
      },
      "subject": {
        "type": "string",
        "format": "at-uri",
        "description": "AT URI of the site.standard.document, support.supper.feed.post, fm.plyr.track, or support.supper.poll.poll whose comments should be listed. The service must reject subjects outside those collections."
      }
    }
  },
  "description": "List public support.supper.comment records attached to one site.standard.document, support.supper.feed.post, fm.plyr.track, or support.supper.poll.poll across commenter repositories. This query returns portable public record data only; moderation and record deletion remain visible through the indexed protocol state."
}

byteSlice object

No description available.

Properties

byteEnd integer Required

No description available.

minimum: 0

byteStart integer Required

No description available.

minimum: 0

View raw schema

{
  "type": "object",
  "required": [
    "byteStart",
    "byteEnd"
  ],
  "properties": {
    "byteEnd": {
      "type": "integer",
      "minimum": 0
    },
    "byteStart": {
      "type": "integer",
      "minimum": 0
    }
  }
}

commentView object

No description available.

Properties

author string did Required

DID of the repository that authored the comment.

cid string cid Required

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

createdAt string datetime Required

Timestamp authored in the source record. Clients must not use this user-controlled value for thread ordering.

facets array of ref#facet Optional

No description available.

maxLength: 100 items

indexedAt string datetime Required

AppView ingestion timestamp used as the authoritative ordering time.

plaintext string Required

No description available.

maxLength: 20000 bytesmaxGraphemes: 2000 graphemes

reply ref #replyRef Optional

No description available.

subject string at-uri Required

Exact site.standard.document, support.supper.feed.post, fm.plyr.track, or support.supper.poll.poll AT URI to which this comment is attached.

uri string at-uri Required

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

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "subject",
    "plaintext",
    "createdAt",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the exact comment record generation returned in this view."
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the indexed support.supper.comment record."
    },
    "reply": {
      "ref": "#replyRef",
      "type": "ref"
    },
    "author": {
      "type": "string",
      "format": "did",
      "description": "DID of the repository that authored the comment."
    },
    "facets": {
      "type": "array",
      "items": {
        "ref": "#facet",
        "type": "ref"
      },
      "maxLength": 100
    },
    "subject": {
      "type": "string",
      "format": "at-uri",
      "description": "Exact site.standard.document, support.supper.feed.post, fm.plyr.track, or support.supper.poll.poll AT URI to which this comment is attached."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Timestamp authored in the source record. Clients must not use this user-controlled value for thread ordering."
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime",
      "description": "AppView ingestion timestamp used as the authoritative ordering time."
    },
    "plaintext": {
      "type": "string",
      "maxLength": 20000,
      "maxGraphemes": 2000
    }
  }
}

facet object

No description available.

Properties

features array of union Required

No description available.

maxLength: 5 itemsminLength: 1 items

Known types:

#link
#mention

index ref #byteSlice Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "index",
    "features"
  ],
  "properties": {
    "index": {
      "ref": "#byteSlice",
      "type": "ref"
    },
    "features": {
      "type": "array",
      "items": {
        "refs": [
          "#link",
          "#mention"
        ],
        "type": "union",
        "closed": false
      },
      "maxLength": 5,
      "minLength": 1
    }
  }
}

link object

No description available.

Properties

uri string uri Required

HTTP(S) link annotated by this facet.

View raw schema

{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "HTTP(S) link annotated by this facet."
    }
  }
}

mention object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

View raw schema

{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    }
  }
}

replyRef object

No description available.

Properties

parent ref com.atproto.repo.strongRef Required

Strong reference to the support.supper.comment being replied to. Its subject must exactly match the comment view's subject.

root ref com.atproto.repo.strongRef Required

Strong reference to the top-level support.supper.comment. Its subject must exactly match the comment view's subject.

View raw schema

{
  "type": "object",
  "required": [
    "root",
    "parent"
  ],
  "properties": {
    "root": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref",
      "description": "Strong reference to the top-level support.supper.comment. Its subject must exactly match the comment view's subject."
    },
    "parent": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref",
      "description": "Strong reference to the support.supper.comment being replied to. Its subject must exactly match the comment view's subject."
    }
  }
}