org.atsui.List Documentation (EN)

main procedure

Scrollable vertical list with paginated data source.

Input

Encodingapplication/json

did stringdid Required

DID of the service that implements the query.

input unknown Optional

Parameters to pass to the query.

query stringnsid Required

XRPC query to call for pages of items.

Output

Encodingapplication/json

Schemaat.inlay.defs#response

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://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "query",
        "did"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "DID of the service that implements the query."
        },
        "input": {
          "type": "unknown",
          "description": "Parameters to pass to the query."
        },
        "query": {
          "type": "string",
          "format": "nsid",
          "description": "XRPC query to call for pages of items."
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "ref": "at.inlay.defs#response",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "description": "Scrollable vertical list with paginated data source."
}

page object

Response shape from a List data source query.

Properties

cursor string Optional

Opaque pagination token. Absent means no more items.

maxLength: 512 bytes

items array of refat.inlay.defs#element Required

Elements to render as list rows.

View raw schema

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "at.inlay.defs#element",
        "type": "ref"
      },
      "description": "Elements to render as list rows."
    },
    "cursor": {
      "type": "string",
      "maxLength": 512,
      "description": "Opaque pagination token. Absent means no more items."
    }
  },
  "description": "Response shape from a List data source query."
}