# pub.chive.admin.searchUsers

> Published by [chive.pub](https://lexicon.garden/identity/did:plc:7natp5xae72bddaqlkef2t4e)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.admin.searchUsers)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.admin.searchUsers/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.admin.searchUsers/examples)

## Definitions

### `pub.chive.admin.searchUsers`

**Type**: `query`

Search users by handle or DID

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of results |
| `query` | `string` | Yes | Search term (handle or DID prefix) |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `users` | `array` | Yes | Matching users |

#### Errors

- **AuthenticationRequired**
- **AdminRequired**

### `pub.chive.admin.searchUsers#userDetail`

**Type**: `object`

User detail with stats and roles

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes | User DID |
| `roles` | `array` | Yes | Assigned role identifiers |
| `handle` | `string` | No | User handle |
| `createdAt` | `string` (datetime) | No | Account indexed timestamp |
| `displayName` | `string` | No | Display name |
| `eprintCount` | `integer` | Yes | Number of eprints submitted |
| `reviewCount` | `integer` | Yes | Number of reviews written |
| `endorsementCount` | `integer` | Yes | Number of endorsements given |

## Raw Schema

```json
{
  "id": "pub.chive.admin.searchUsers",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "AdminRequired"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "users"
          ],
          "properties": {
            "users": {
              "type": "array",
              "items": {
                "ref": "#userDetail",
                "type": "ref"
              },
              "description": "Matching users"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "query"
        ],
        "properties": {
          "limit": {
            "type": "integer",
            "default": 20,
            "maximum": 100,
            "minimum": 1,
            "description": "Maximum number of results"
          },
          "query": {
            "type": "string",
            "description": "Search term (handle or DID prefix)"
          }
        }
      },
      "description": "Search users by handle or DID"
    },
    "userDetail": {
      "type": "object",
      "required": [
        "did",
        "eprintCount",
        "reviewCount",
        "endorsementCount",
        "roles"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "User DID"
        },
        "roles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Assigned role identifiers"
        },
        "handle": {
          "type": "string",
          "description": "User handle"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime",
          "description": "Account indexed timestamp"
        },
        "displayName": {
          "type": "string",
          "description": "Display name"
        },
        "eprintCount": {
          "type": "integer",
          "description": "Number of eprints submitted"
        },
        "reviewCount": {
          "type": "integer",
          "description": "Number of reviews written"
        },
        "endorsementCount": {
          "type": "integer",
          "description": "Number of endorsements given"
        }
      },
      "description": "User detail with stats and roles"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```