cards.sunshine.listScans

sunshine.cards

Documentation

Lists the scans of a Sunshine Card that this instance has signed, most recent (highest counter) first. A scan its scanner has since deleted is still listed.

main query

Lists the scans of a Sunshine Card that this instance has signed, most recent (highest counter) first. A scan its scanner has since deleted is still listed.

Parameters

cursor string Optional

No description available.

did string did Required

The card's creator.

limit integer Optional

No description available.

uid string Required

The tag's serial number, in hex.

Output

Encodingapplication/json
cursor string Optional

Present when there may be more scans: pass it to list them.

scans 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
The card's creator.
The tag's serial number, in hex.
View raw schema
{
  "description": "Lists the scans of a Sunshine Card that this instance has signed, most recent (highest counter) first. A scan its scanner has since deleted is still listed.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "Present when there may be more scans: pass it to list them.",
          "type": "string"
        },
        "scans": {
          "items": {
            "ref": "#scan",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "scans"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "type": "string"
      },
      "did": {
        "description": "The card's creator.",
        "format": "did",
        "type": "string"
      },
      "limit": {
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "uid": {
        "description": "The tag's serial number, in hex.",
        "maxLength": 14,
        "minLength": 14,
        "type": "string"
      }
    },
    "required": [
      "did",
      "uid"
    ],
    "type": "params"
  },
  "type": "query"
}
scan object

No description available.

Properties

counter integer Required

The tag's read counter for this scan.

minimum: 1maximum: 16777215
createdAt string datetime Required

An RFC 3339 formatted timestamp.

scanner string did Required

A decentralized identifier (DID).

uri string at-uri Required

The cards.sunshine.scan record in the scanner's repo.

View raw schema
{
  "properties": {
    "counter": {
      "description": "The tag's read counter for this scan.",
      "maximum": 16777215,
      "minimum": 1,
      "type": "integer"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "scanner": {
      "format": "did",
      "type": "string"
    },
    "uri": {
      "description": "The cards.sunshine.scan record in the scanner's repo.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "scanner",
    "counter",
    "createdAt"
  ],
  "type": "object"
}

Lexicon Garden

@