# cafe.dummy.lsky.searchPeople

> Published by [lsky-publisher.dummy.to](https://lexicon.garden/identity/did:plc:yuilafccwsaj7a4qkkzhttdn)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:yuilafccwsaj7a4qkkzhttdn/cafe.dummy.lsky.searchPeople)
- [Documentation](https://lexicon.garden/lexicon/did:plc:yuilafccwsaj7a4qkkzhttdn/cafe.dummy.lsky.searchPeople/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:yuilafccwsaj7a4qkkzhttdn/cafe.dummy.lsky.searchPeople/examples)

## Definitions

### `cafe.dummy.lsky.searchPeople`

**Type**: `query`

Search for people by handle or display name. Used for mention autocomplete.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No |  |
| `q` | `string` | Yes | Search query string. |

#### Output

**Encoding**: `application/json`

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

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Search for people by handle or display name. Used for mention autocomplete.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "people": {
              "items": {
                "ref": "cafe.dummy.lsky.defs#personView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "people"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "limit": {
            "default": 8,
            "maximum": 25,
            "minimum": 1,
            "type": "integer"
          },
          "q": {
            "description": "Search query string.",
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "q"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "cafe.dummy.lsky.searchPeople",
  "lexicon": 1
}
```
