app.bsky.graph.getList

bsky-lexicons.bsky.social

Documentation

Gets a 'view' (with additional context) of a specified list.

main query

Gets a 'view' (with additional context) of a specified list.

Parameters

cursor string Optional

No description available.

limit integer Optional

No description available.

list string at-uri Required

Reference (AT-URI) of the list record to hydrate.

Output

Encodingapplication/json
cursor string Optional

No description available.

items 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
Reference (AT-URI) of the list record to hydrate.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "list",
        "items"
      ],
      "properties": {
        "list": {
          "ref": "app.bsky.graph.defs#listView",
          "type": "ref"
        },
        "items": {
          "type": "array",
          "items": {
            "ref": "app.bsky.graph.defs#listItemView",
            "type": "ref"
          }
        },
        "cursor": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "list"
    ],
    "properties": {
      "list": {
        "type": "string",
        "format": "at-uri",
        "description": "Reference (AT-URI) of the list record to hydrate."
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      }
    }
  },
  "description": "Gets a 'view' (with additional context) of a specified list."
}

Lexicon Garden

@