# app.tempomusic.actor.searchActorsTypeahead

> Published by [lexicons.tempomusic.fan](https://lexicon.garden/identity/did:plc:pxsuqmultto34oks44m2lgxm)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:pxsuqmultto34oks44m2lgxm/app.tempomusic.actor.searchActorsTypeahead)
- [Documentation](https://lexicon.garden/lexicon/did:plc:pxsuqmultto34oks44m2lgxm/app.tempomusic.actor.searchActorsTypeahead/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:pxsuqmultto34oks44m2lgxm/app.tempomusic.actor.searchActorsTypeahead/examples)

## Definitions

### `app.tempomusic.actor.searchActorsTypeahead`

**Type**: `query`

Accounts whose display name or handle starts with `q`, case-insensitively, for the mention picker. At most `limit` results, ordered: exact handle match first, then display-name prefix matches, then handle prefix matches, each group by display name then DID. Filtered for the viewer: accounts in a block relation with the viewer in either direction, sanctioned accounts (suspended or banned), soft-deleted or moderation-held profiles and the viewer's own account are never returned. The viewer DID is read from the service-auth JWT (`iss` claim) — no `?viewer=` query parameter. An empty `q` (after trimming and removing a leading `@`) returns an empty list.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of accounts to return. |
| `q` | `string` | Yes | Prefix to match against display names and handles. A leading `@` is tolerated and removed; `%`, `_` and `\` match themselves. |

#### Output

**Encoding**: `application/json`

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

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Accounts whose display name or handle starts with `q`, case-insensitively, for the mention picker. At most `limit` results, ordered: exact handle match first, then display-name prefix matches, then handle prefix matches, each group by display name then DID. Filtered for the viewer: accounts in a block relation with the viewer in either direction, sanctioned accounts (suspended or banned), soft-deleted or moderation-held profiles and the viewer's own account are never returned. The viewer DID is read from the service-auth JWT (`iss` claim) — no `?viewer=` query parameter. An empty `q` (after trimming and removing a leading `@`) returns an empty list.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "actors": {
              "items": {
                "ref": "app.tempomusic.actor.defs#profileViewBasic",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "actors"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "limit": {
            "default": 10,
            "description": "Maximum number of accounts to return.",
            "maximum": 10,
            "minimum": 1,
            "type": "integer"
          },
          "q": {
            "description": "Prefix to match against display names and handles. A leading `@` is tolerated and removed; `%`, `_` and `\\` match themselves.",
            "maxLength": 64,
            "type": "string"
          }
        },
        "required": [
          "q"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "app.tempomusic.actor.searchActorsTypeahead",
  "lexicon": 1
}
```