pub.chive.admin.searchUsers

chive.pub

Documentation

Search users by handle or DID

main query

Search users by handle or DID

Parameters

limit integer Optional

Maximum number of results

query string Required

Search term (handle or DID prefix)

Output

Encodingapplication/json
users array Required

Matching users

Errors

AuthenticationRequired
AdminRequired
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Maximum number of results
Search term (handle or DID prefix)
View raw schema
{
  "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 object

User detail with stats and roles

Properties

createdAt string datetime Optional

Account indexed timestamp

did string did Required

User DID

displayName string Optional

Display name

endorsementCount integer Required

Number of endorsements given

eprintCount integer Required

Number of eprints submitted

handle string Optional

User handle

reviewCount integer Required

Number of reviews written

roles array of string Required

Assigned role identifiers

View raw schema
{
  "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"
}

Lexicon Garden

@