# cards.sunshine.listScans

> Published by [sunshine.cards](https://lexicon.garden/identity/did:web:sunshine.cards)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:web:sunshine.cards/cards.sunshine.listScans)
- [Documentation](https://lexicon.garden/lexicon/did:web:sunshine.cards/cards.sunshine.listScans/docs)
- [Examples](https://lexicon.garden/lexicon/did:web:sunshine.cards/cards.sunshine.listScans/examples)

## Definitions

### `cards.sunshine.listScans`

**Type**: `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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `did` | `string` (did) | Yes | The card's creator. |
| `limit` | `integer` | No |  |
| `uid` | `string` | Yes | The tag's serial number, in hex. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Present when there may be more scans: pass it to list them. |
| `scans` | `array` | Yes |  |

### `cards.sunshine.listScans#scan`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `counter` | `integer` | Yes | The tag's read counter for this scan. |
| `createdAt` | `string` (datetime) | Yes |  |
| `scanner` | `string` (did) | Yes |  |
| `uri` | `string` (at-uri) | Yes | The cards.sunshine.scan record in the scanner's repo. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "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": {
      "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"
    }
  },
  "id": "cards.sunshine.listScans",
  "lexicon": 1
}
```