net.atpix.gallery.listAlbumItems Documentation (EN)

main query

List ordered albumItem records for an album.

Parameters

albumUri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

cursor string Optional

No description available.

limit integer Optional

No description available.

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.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

albumUri * An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

cursor

limit

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "items"
      ],
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "uri",
              "albumUri",
              "photoUri",
              "createdAt"
            ],
            "properties": {
              "uri": {
                "type": "string",
                "format": "at-uri"
              },
              "photo": {
                "ref": "net.atpix.gallery.defs#photoView",
                "type": "ref"
              },
              "addedBy": {
                "type": "string",
                "format": "did"
              },
              "albumUri": {
                "type": "string",
                "format": "at-uri"
              },
              "photoUri": {
                "type": "string",
                "format": "at-uri"
              },
              "position": {
                "type": "integer",
                "minimum": 0
              },
              "createdAt": {
                "type": "string",
                "format": "datetime"
              }
            }
          }
        },
        "cursor": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "albumUri"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      },
      "albumUri": {
        "type": "string",
        "format": "at-uri"
      }
    }
  },
  "description": "List ordered albumItem records for an album."
}