# pub.chive.annotation.listForPage

> Published by [chive.pub](https://lexicon.garden/identity/did:plc:7natp5xae72bddaqlkef2t4e)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.annotation.listForPage)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.annotation.listForPage/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.annotation.listForPage/examples)

## Definitions

### `pub.chive.annotation.listForPage`

**Type**: `query`

List annotations for a specific page in an eprint

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `eprintUri` | `string` (at-uri) | Yes | AT-URI of the eprint |
| `pageNumber` | `integer` | Yes | Page number to list annotations for |
| `includeEntityLinks` | `boolean` | No | Include entity link annotations in response |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `annotations` | `array` | Yes | Annotations on the specified page |
| `entityLinks` | `array` | No | Entity links on the specified page |

## Raw Schema

```json
{
  "id": "pub.chive.annotation.listForPage",
  "defs": {
    "main": {
      "type": "query",
      "errors": [],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "annotations"
          ],
          "properties": {
            "annotations": {
              "type": "array",
              "items": {
                "ref": "pub.chive.annotation.listForEprint#annotationView",
                "type": "ref"
              },
              "description": "Annotations on the specified page"
            },
            "entityLinks": {
              "type": "array",
              "items": {
                "ref": "pub.chive.annotation.listForEprint#entityLinkView",
                "type": "ref"
              },
              "description": "Entity links on the specified page"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "eprintUri",
          "pageNumber"
        ],
        "properties": {
          "eprintUri": {
            "type": "string",
            "format": "at-uri",
            "description": "AT-URI of the eprint"
          },
          "pageNumber": {
            "type": "integer",
            "minimum": 1,
            "description": "Page number to list annotations for"
          },
          "includeEntityLinks": {
            "type": "boolean",
            "default": true,
            "description": "Include entity link annotations in response"
          }
        }
      },
      "description": "List annotations for a specific page in an eprint"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```