# fm.teal.actor.searchActors

> Published by [teal.fm](https://lexicon.garden/identity/did:plc:iwhuynr6mm6xxuh25o4do2tx)

✓ This is the authoritative definition for this NSID.

## Description

This lexicon is in a not officially released state. It is subject to change. | Searches for actors based on profile contents.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:iwhuynr6mm6xxuh25o4do2tx/fm.teal.actor.searchActors)
- [Documentation](https://lexicon.garden/lexicon/did:plc:iwhuynr6mm6xxuh25o4do2tx/fm.teal.actor.searchActors/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:iwhuynr6mm6xxuh25o4do2tx/fm.teal.actor.searchActors/examples)

## Definitions

### `fm.teal.actor.searchActors`

**Type**: `query`

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `q` | `string` | Yes | The search query |
| `limit` | `integer` | No | The maximum number of actors to return |
| `cursor` | `string` | No | Cursor for pagination |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actors` | `array` | Yes |  |
| `cursor` | `string` | No | Cursor for pagination |

## Raw Schema

```json
{
  "id": "fm.teal.actor.searchActors",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "actors"
          ],
          "properties": {
            "actors": {
              "type": "array",
              "items": {
                "ref": "fm.teal.actor.defs#miniProfileView",
                "type": "ref"
              }
            },
            "cursor": {
              "type": "string",
              "description": "Cursor for pagination"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "q"
        ],
        "properties": {
          "q": {
            "type": "string",
            "maxLength": 640,
            "description": "The search query",
            "maxGraphemes": 128
          },
          "limit": {
            "type": "integer",
            "maximum": 25,
            "minimum": 1,
            "description": "The maximum number of actors to return"
          },
          "cursor": {
            "type": "string",
            "description": "Cursor for pagination"
          }
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "This lexicon is in a not officially released state. It is subject to change. | Searches for actors based on profile contents."
}
```