summaryrefslogtreecommitdiff
path: root/docs/Admin-API.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Admin-API.md')
-rw-r--r--docs/Admin-API.md35
1 files changed, 5 insertions, 30 deletions
diff --git a/docs/Admin-API.md b/docs/Admin-API.md
index 407647645..7f60b768a 100644
--- a/docs/Admin-API.md
+++ b/docs/Admin-API.md
@@ -2,41 +2,16 @@
Authentication is required and the user must be an admin.
-## `/api/pleroma/admin/users`
+## `/api/pleroma/admin/users?query={query}&local={local}&page={page}&page_size={page_size}`
### List users
- Method `GET`
- Params:
- - `page`: **integer** page number
- - `page_size`: **integer** number of users per page (default is `50`)
-- Response:
-
-```JSON
-{
- "page_size": integer,
- "count": integer,
- "users": [
- {
- "deactivated": bool,
- "id": integer,
- "nickname": string
- },
- ...
- ]
-}
-```
-
-## `/api/pleroma/admin/users/search?query={query}&local={local}&page={page}&page_size={page_size}`
-
-### Search users by name or nickname
-
-- Method `GET`
-- Params:
- - `query`: **string** search term
- - `local`: **bool** whether to return only local users
- - `page`: **integer** page number
- - `page_size`: **integer** number of users per page (default is `50`)
+ - `query`: **string** *optional* search term
+ - `local`: **bool** *optional* whether to return only local users
+ - `page`: **integer** *optional* page number
+ - `page_size`: **integer** *optional* number of users per page (default is `50`)
- Response:
```JSON