====== Box users ====== ===== Example ===== image ===== Search Parameters ===== ^Parameter name ^Value ^Description ^ |search_limit |integer |max number of users to retrieve | |pg |integer |0 - default | |search_order |'ascending' \\ 'descending' |applies to search_sort_by | |offset |integer |query offset, 0 based | |search_options |array |compact form of search parameters | |search_id |string |comma separated user ids | |search_user_type |string |comma separated user types | |search_query |string |text search trough user, first, last name | |search_activated |-1%%|%%0%%|%%1%%|%%2 |-1 - soft delete \\ 0 - inactive \\ 1 - active \\ 2 - unconfirmed | |search_search_date |integer |number of days | |search_before_after |0 %%|%% 1 |0: before \\ 1: after \\ applies to search_search_date | |search_sort_by |'id' \\ 'first_name' \\ 'last_name' \\ 'email_address' \\ 'username' \\ 'activated' \\ 'user_type' \\ 'name' |sort result by criteria| **Assignments:** ^Parameter name ^Value ^Description ^ |user_list_object |object |UsersList object | |user_list |array |each item is an Users object | |user |object |if only one user in list |