com.atiproto.payment.item.get Documentation (EN)

main query

Get a specific item sent by the authenticated user. Looks up by item record uri, subject (recipient) DID, or record uri. These are mutually exclusive and resolved in that order.

Parameters

recordUri string at-uri Optional

AT-URI of the record being tipped. Ignored if uri or subject is provided.

subject string did Optional

DID of the item recipient. Takes precedence over recordUri.

uri string at-uri Optional

AT-URI of the item record. Takes precedence over subject and recordUri.

Output

Encodingapplication/json

item refcom.atiproto.item#view Required

The item record data

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

recordUri AT-URI of the record being tipped. Ignored if uri or subject is provided.

subject DID of the item recipient. Takes precedence over recordUri.

uri AT-URI of the item record. Takes precedence over subject and recordUri.

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "item"
      ],
      "properties": {
        "item": {
          "ref": "com.atiproto.item#view",
          "type": "ref",
          "description": "The item record data"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "uri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the item record. Takes precedence over subject and recordUri."
      },
      "subject": {
        "type": "string",
        "format": "did",
        "description": "DID of the item recipient. Takes precedence over recordUri."
      },
      "recordUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the record being tipped. Ignored if uri or subject is provided."
      }
    }
  },
  "description": "Get a specific item sent by the authenticated user. Looks up by item record uri, subject (recipient) DID, or record uri. These are mutually exclusive and resolved in that order."
}