List Users
Summary
Get a list of the users in your site. Only site administrators can use this operation to list other user accounts.
You can only retrieve users associated with your site. Attempting to retrieve a user with a name taken by another site will result in a 404 NOT FOUND error.
Endpoint
GET https://mysite.files.com/v1.2/getUsers
Replace mysite.files.com with your site address.
Request Parameters
| Name | Data Type | Description |
|---|---|---|
access_token | string | Required. The session key that identifies which user is authenticated. Either an access token returned by the authenticateUser function, or a a Files.com user API Key. |
sortBy | string | Which field the resorts should be sorted by. Valid choices are: sort_users_username, sort_users_nickname, sort_users_email or sort_users_home_folder |
sortOrder | string | What direction to sort the records in. Valid options are asc or desc. |
Sorting
Specify what order the results will be returned in by using the sortBy parameter. Valid options are sort_users_username, sort_users_nickname, sort_users_email, or sort_users_home_folder. All sorting is case-insensitive.
The sort order is ascending by default. To sort in descending order, send desc for the sortOrder parameter.