diff options
| author | Yatish Mehta <yatish.mehta@coupa.com> | 2016-10-26 00:08:53 +0300 |
|---|---|---|
| committer | Yatish Mehta <yatish.mehta@coupa.com> | 2016-11-08 23:04:05 +0300 |
| commit | a0aaf93fe591215a7fc29a52ff6cbd38604c8dcb (patch) | |
| tree | 8742a213a18bdae2f7de15b4851c60ed2c898394 /doc/api/users.md | |
| parent | c6d010986724faf10b46453d66eaca38a948fabf (diff) | |
Add query param to filter users on 'external' & 'blocked' type on API
Diffstat (limited to 'doc/api/users.md')
| -rw-r--r-- | doc/api/users.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index a50ba5432fe..041df07c051 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -33,6 +33,18 @@ GET /users ] ``` +In addition, you can filter users based on states eg. `blocked`, `active` +This works only to filter users who are `blocked` or `active`. +It does not support `active=false` or `blocked=false`. + +``` +GET /users?active=true +``` + +``` +GET /users?blocked=true +``` + ### For admins ``` @@ -120,6 +132,8 @@ For example: GET /users?username=jack_smith ``` +You can search for users who are external with: `/users?external=true` + ## Single user Get a single user. |