aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Admin-API.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/Admin-API.md b/docs/Admin-API.md
index ed19bc875..4403620bf 100644
--- a/docs/Admin-API.md
+++ b/docs/Admin-API.md
@@ -20,13 +20,14 @@ Authentication is required and the user must be an admin.
]
```
-## `/api/pleroma/admin/users/search?query={query}`
+## `/api/pleroma/admin/users/search?query={query}&local={local}`
-### Search users
+### Search users by name or nickname
- Method `GET`
- Params:
- - `query`
+ - `query`: **string** search term
+ - `local`: **bool** whether to return only local users
- Response:
```JSON