# social.coves.community.search

> Published by [coves.social](https://lexicon.garden/identity/did:web:coves.social)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:web:coves.social/social.coves.community.search)
- [Documentation](https://lexicon.garden/lexicon/did:web:coves.social/social.coves.community.search/docs)
- [Examples](https://lexicon.garden/lexicon/did:web:coves.social/social.coves.community.search/examples)

## Definitions

### `social.coves.community.search`

**Type**: `query`

Search for communities by name or description

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `q` | `string` | Yes | Search query |
| `limit` | `integer` | No |  |
| `cursor` | `string` | No |  |
| `category` | `string` | No | Filter by category |
| `language` | `string` (language) | No | Filter by language |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `communities` | `array` | Yes |  |

## Raw Schema

```json
{
  "id": "social.coves.community.search",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "communities"
          ],
          "properties": {
            "cursor": {
              "type": "string",
              "maxLength": 500
            },
            "communities": {
              "type": "array",
              "items": {
                "ref": "social.coves.community.defs#communityView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "q"
        ],
        "properties": {
          "q": {
            "type": "string",
            "maxLength": 500,
            "description": "Search query"
          },
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1
          },
          "cursor": {
            "type": "string",
            "maxLength": 500
          },
          "category": {
            "type": "string",
            "maxLength": 50,
            "description": "Filter by category"
          },
          "language": {
            "type": "string",
            "format": "language",
            "description": "Filter by language"
          }
        }
      },
      "description": "Search for communities by name or description"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```