com.atiproto.recipient.payment.cart.list Documentation (EN)

main query

List carts whose items pay the authenticated user — i.e. carts targeting this user as a payment recipient. Read-only, no PDS writes.

Parameters

cursor string Optional

Pagination cursor

limit integer Optional

Results per page (1-100, default: 20)

sender string did Optional

Optional: only return carts created by this sender DID

status string Optional

Filter by cart status

Output

Encodingapplication/json

carts array Required

No description available.

cursor string Optional

Pagination cursor for next page

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 Pagination cursor

limit Results per page (1-100, default: 20)

sender Optional: only return carts created by this sender DID

status Filter by cart status

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "carts"
      ],
      "properties": {
        "carts": {
          "type": "array",
          "items": {
            "ref": "#cartResponse",
            "type": "ref"
          }
        },
        "cursor": {
          "type": "string",
          "maxLength": 512,
          "description": "Pagination cursor for next page"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1,
        "description": "Results per page (1-100, default: 20)"
      },
      "cursor": {
        "type": "string",
        "maxLength": 512,
        "description": "Pagination cursor"
      },
      "sender": {
        "type": "string",
        "format": "did",
        "description": "Optional: only return carts created by this sender DID"
      },
      "status": {
        "enum": [
          "open",
          "completed",
          "expired",
          "abandoned"
        ],
        "type": "string",
        "maxLength": 64,
        "description": "Filter by cart status"
      }
    }
  },
  "description": "List carts whose items pay the authenticated user — i.e. carts targeting this user as a payment recipient. Read-only, no PDS writes."
}

cartResponse object

No description available.

Properties

cid string cid Required

CID of the cart record

record ref com.atiproto.cart#view Required

No description available.

uri string at-uri Required

AT-URI of the cart record

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "record"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the cart record"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the cart record"
    },
    "record": {
      "ref": "com.atiproto.cart#view",
      "type": "ref"
    }
  }
}