# at.happyproto.registry.searchProjects

> Published by [happyproto.at](https://lexicon.garden/identity/did:plc:mo7vq4jbioxwafy5zkcc3eux)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.registry.searchProjects)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.registry.searchProjects/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.registry.searchProjects/examples)

## Definitions

### `at.happyproto.registry.searchProjects`

**Type**: `query`

Find plugins. Retired projects are left out unless includeRetired is set.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `includeRetired` | `boolean` | No |  |
| `limit` | `integer` | No |  |
| `pluginType` | `string` | No | Only projects of this type. |
| `q` | `string` | No | Text to match against the project's name, display name and keywords. Omit to list every project. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Absent on the last page. |
| `projects` | `array` | Yes |  |

#### Errors

- **NotConfigured**: The registry has no identity configured, so it cannot read its own state. An operator problem, not a caller's.

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Find plugins. Retired projects are left out unless includeRetired is set.",
      "errors": [
        {
          "description": "The registry has no identity configured, so it cannot read its own state. An operator problem, not a caller's.",
          "name": "NotConfigured"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "Absent on the last page.",
              "type": "string"
            },
            "projects": {
              "items": {
                "ref": "at.happyproto.registry.defs#projectView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "projects"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "includeRetired": {
            "default": false,
            "type": "boolean"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "pluginType": {
            "description": "Only projects of this type.",
            "knownValues": [
              "auth",
              "library",
              "interpreter"
            ],
            "type": "string"
          },
          "q": {
            "description": "Text to match against the project's name, display name and keywords. Omit to list every project.",
            "maxLength": 256,
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "at.happyproto.registry.searchProjects",
  "lexicon": 1
}
```