# us.off-the-clock.listPins

> Published by [off-the-clock.us](https://lexicon.garden/identity/did:plc:tevv7zpavtjtsvqrrwwipobt)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.listPins)
- [Documentation](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.listPins/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.listPins/examples)

## Definitions

### `us.off-the-clock.listPins`

**Type**: `query`

The counting pins of one space the viewer reads, in the order they were pinned, one per subject, with subjects the viewer cannot see left out; at most ten.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `space` | `string` | Yes | A pair's TID. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `pins` | `array` | Yes |  |

#### Errors

- **InvalidRequest**
- **NotSpaceMember**

### `us.off-the-clock.listPins#pinView`

**Type**: `object`

One pin: the pin record, who wrote it and when, and its subject as it is now.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `author` | `string` (did) | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `subject` | `union` | Yes |  |
| `uri` | `string` (at-uri) | Yes | The pin record, in the pair's management space. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The counting pins of one space the viewer reads, in the order they were pinned, one per subject, with subjects the viewer cannot see left out; at most ten.",
      "errors": [
        {
          "name": "InvalidRequest"
        },
        {
          "name": "NotSpaceMember"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "pins": {
              "items": {
                "ref": "#pinView",
                "type": "ref"
              },
              "maxLength": 10,
              "type": "array"
            }
          },
          "required": [
            "pins"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "space": {
            "description": "A pair's TID.",
            "type": "string"
          }
        },
        "required": [
          "space"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "pinView": {
      "description": "One pin: the pin record, who wrote it and when, and its subject as it is now.",
      "properties": {
        "author": {
          "format": "did",
          "type": "string"
        },
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "subject": {
          "refs": [
            "us.off-the-clock.defs#postView",
            "us.off-the-clock.defs#eventView"
          ],
          "type": "union"
        },
        "uri": {
          "description": "The pin record, in the pair's management space.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "author",
        "createdAt",
        "subject"
      ],
      "type": "object"
    }
  },
  "id": "us.off-the-clock.listPins",
  "lexicon": 1
}
```