Search users by handle or DID
Parameters
Output
Encoding
application/jsonusers
array
Required
Matching users
Errors
AuthenticationRequired
AdminRequired
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Search users by handle or DID",
"errors": [
{
"name": "AuthenticationRequired"
},
{
"name": "AdminRequired"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"users": {
"description": "Matching users",
"items": {
"ref": "#userDetail",
"type": "ref"
},
"type": "array"
}
},
"required": [
"users"
],
"type": "object"
}
},
"parameters": {
"properties": {
"limit": {
"default": 20,
"description": "Maximum number of results",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"query": {
"description": "Search term (handle or DID prefix)",
"type": "string"
}
},
"required": [
"query"
],
"type": "params"
},
"type": "query"
}