Skip to content

Commit 0707d0a

Browse files
author
andrewbrazzatti
committed
Updated api documentation to fix error in list users endpoint. Currently users page and page size
1 parent 3b2b206 commit 0707d0a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

views/default/default/apidocsapib.ejs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -528,11 +528,11 @@ The ReDBox Portal API provides authorized access to manage functions.
528528

529529
## User Management Actions [/<%= branding %>/<%= portal %>/api/users]
530530

531-
### List users in the system [GET /<%= branding %>/<%= portal %>/api/users{?searchBy,query,start,rows}]
531+
### List users in the system [GET /<%= branding %>/<%= portal %>/api/users{?searchBy,query,page,pageSize}]
532532
+ Parameters
533-
+ start: `0` (number, optional) - The index number for the first value to return from the result set.
534-
+ Default: 0
535-
+ rows: `10` (number,optional) - The number of records to return in the request
533+
+ page: `1` (number, optional) - The page index of the result set to show.
534+
+ Default: 1
535+
+ pageSize: `10` (number,optional) - The number of records to return in a page
536536
+ Default: 10
537537
+ searchBy: `type` (string, optional) - The attribute to search by. e.g. email
538538
+ query: `local` (string, optional) - The value to query. Only exact matches.

0 commit comments

Comments
 (0)