# us.off-the-clock.getFeed

> 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.getFeed)
- [Documentation](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.getFeed/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.getFeed/examples)

## Definitions

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

**Type**: `query`

A feed by record key: its generator's skeleton, hydrated by collection. Needs the viewer's service-auth token for the feed generator in x-atproto-feed-authorization.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `feed` | `string` (record-key) | No | The feed's record key; general by default. |
| `limit` | `integer` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `feed` | `array` | Yes |  |
| `generator` | `ref` → `us.off-the-clock.defs#feedInfo` | Yes |  |

#### Errors

- **UnknownFeed**
- **FeedAuthRequired**
- **FeedUnavailable**
- **NotSpaceMember**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "A feed by record key: its generator's skeleton, hydrated by collection. Needs the viewer's service-auth token for the feed generator in x-atproto-feed-authorization.",
      "errors": [
        {
          "name": "UnknownFeed"
        },
        {
          "name": "FeedAuthRequired"
        },
        {
          "name": "FeedUnavailable"
        },
        {
          "name": "NotSpaceMember"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "feed": {
              "items": {
                "refs": [
                  "us.off-the-clock.defs#postView",
                  "us.off-the-clock.defs#eventView",
                  "us.off-the-clock.defs#rsvpView",
                  "us.off-the-clock.defs#profileView",
                  "us.off-the-clock.defs#recordView",
                  "us.off-the-clock.defs#bookmarkView",
                  "us.off-the-clock.polls.pollView"
                ],
                "type": "union"
              },
              "type": "array"
            },
            "generator": {
              "ref": "us.off-the-clock.defs#feedInfo",
              "type": "ref"
            }
          },
          "required": [
            "generator",
            "feed"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "feed": {
            "description": "The feed's record key; general by default.",
            "format": "record-key",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "us.off-the-clock.getFeed",
  "lexicon": 1
}
```