diff --git a/users/README.md b/users/README.md index 85fe8e6..24f3b95 100644 --- a/users/README.md +++ b/users/README.md @@ -53,7 +53,8 @@ Returns all users in the system. - **Query** Optional: `size=[integer]` (`size` is number of users requested per page, value ranges in between 1-100, and default value is 100)
Optional: `page=[integer]` - (`page` can either be 0 or positive-number, and default value is 0)
`search=[string]` (`search` is a string value for username prefix)
Optional: `next=[string]` (`next` is id of the DB document to get next batch/page of results after that document.)
Optional: `prev=[string]` (`prev` is id of the DB document to get previous batch/page of results before that document.) + (`page` can either be 0 or positive-number, and default value is 0)
`search=[string]` (`search` is a string value for username prefix)
Optional: `next=[string]` (`next` is id of the DB document to get next batch/page of results after that document.)
Optional: `prev=[string]` (`prev` is id of the DB document to get previous batch/page of results before that document.)
+ Optional: `role=[string]`(`role` will filter out the users with the role that is provided in the query params, e.g, if we give `?role=member` then it will return all the users with the role `member`) - **Body** None - **Headers**