# ink.resenha.parlor.getReviews

> Requires the caller's service token.

- Kind: query
- Authority: parlor.resenha.ink
- Lexicon: 1
- Published by [resenha.ink](https://lexicon.garden/identity/did:plc:v7itjf4h3sb5zuegiiskctqb), not the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.parlor.getReviews)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.parlor.getReviews/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.parlor.getReviews/analytics)

## Query (`ink.resenha.parlor.getReviews`)

Type: query · GET

### Parameters (query string)

- `cursor` (string): Where the previous page ended.
- `full` (boolean): Whether each review comes whole, in text, rather than as an excerpt.
  - Constraints: default: false
- `limit` (integer)
  - Constraints: minimum: 1, maximum: 100, default: 50

### Output (application/json)

- `cursor` (string): Where the previous page ended.
- `profiles` (array)
  - `items` (ref)
    - Reference: `ink.resenha.defs#profileView`
- `reviews` (array, required)
  - `items` (ref)
    - Reference: `ink.resenha.defs#reviewView`

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Requires the caller's service token.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "Where the previous page ended.",
              "type": "string"
            },
            "profiles": {
              "items": {
                "ref": "ink.resenha.defs#profileView",
                "type": "ref"
              },
              "type": "array"
            },
            "reviews": {
              "items": {
                "ref": "ink.resenha.defs#reviewView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "reviews"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "Where the previous page ended.",
            "type": "string"
          },
          "full": {
            "default": false,
            "description": "Whether each review comes whole, in text, rather than as an excerpt.",
            "type": "boolean"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "description": "The reviews of the readers the caller follows, newest first: dated by when they were published from Resenha, else by when the book was finished or added.",
  "id": "ink.resenha.parlor.getReviews",
  "lexicon": 1
}
```
