diff options
| author | kaniini <nenolod@gmail.com> | 2019-03-06 22:27:42 +0000 |
|---|---|---|
| committer | kaniini <nenolod@gmail.com> | 2019-03-06 22:27:42 +0000 |
| commit | 0fe715f3ba0f787154ab8e86c8745d7f09affdcb (patch) | |
| tree | 3560d668fe7feec0dcce59858ee4e7a6fdd54e18 /docs/Admin-API.md | |
| parent | 39b766cc43c39dbff84cb498c4b4c764abdec9a0 (diff) | |
| parent | 76160122f6d7bf52aee929328acb4d216e4c3504 (diff) | |
| download | pleroma-0fe715f3ba0f787154ab8e86c8745d7f09affdcb.tar.gz | |
Merge branch 'chore/merge-search-into-list-users' into 'develop'
Merge search endpoint into /users
See merge request pleroma/pleroma!898
Diffstat (limited to 'docs/Admin-API.md')
| -rw-r--r-- | docs/Admin-API.md | 35 |
1 files changed, 5 insertions, 30 deletions
diff --git a/docs/Admin-API.md b/docs/Admin-API.md index 407647645..2edb31f3c 100644 --- a/docs/Admin-API.md +++ b/docs/Admin-API.md @@ -7,36 +7,11 @@ Authentication is required and the user must be an admin. ### 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 Params: + - `query`: **string** *optional* search term + - `local_only`: **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 |