List enterprise users


Returns a list of all users for the Enterprise along with their user_id, public_name, and login.

The application and the authenticated user need to have the permission to look up users in the entire enterprise.



Query Parameters

stringin queryoptional

Limits the results to app users with the given external_app_user_id value.

When creating an app user, an external_app_user_id value can be set. This value can then be used in this endpoint to find any users that match that external_app_user_id value.

string arrayin queryoptional

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

stringin queryoptional

Limits the results to only users who's name or login start with the search term.

For externally managed users, the search term needs to completely match the in order to find the user, and it will only return one user at a time.

integer / int64in queryoptional

The maximum number of items to return per page.

stringin queryoptional

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

integer / int64in queryoptional

The offset of the item at which to begin the response.

booleanin queryoptional

Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time.

By setting this value to true, the API will return a marker field that can be passed as a parameter to this endpoint to get the next page of the response.

stringin queryoptional

Limits the results to the kind of user specified.

  • all returns every kind of user for whom the login or name partially matches the filter_term. It will only return an external user if the login matches the filter_term completely, and in that case it will only return that user.
  • managed returns all managed and app users for whom the login or name partially matches the filter_term.
  • external returns all external users for whom the login matches the filter_term exactly.

Value is one of all,managed,external



Returns all of the users in the enterprise.

application/jsonClient error

An unexpected client error.

List enterprise users
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

curl -i -X GET "" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
BoxCollection<BoxUser> users = await client.UsersManager.GetEnterpriseUsersAsync();
Iterable<BoxUser.Info> users = BoxUser.getAllEnterpriseUsers(api, true, null);

// Get marker
String marker = ((BoxResourceIterable<BoxUser.Info>) users).getNextMarker();
users = client.users(user_type='all')
for user in users:
    print('{0} (User ID: {1})'.format(,
client.enterprise.getUsers({usemarker: true, marker: 'JFUirotE56hfyr56FH123'})
	.then(users => {
		/* users -> {
			total_count: 1,
			[ { type: 'user',
				id: '33333',
				name: 'Example User',
				login: '',
				created_at: '2012-05-03T21:39:11-07:00',
				modified_at: '2012-08-23T14:57:48-07:00',
				language: 'en',
				space_amount: 5368709120,
				space_used: 52947,
				max_upload_size: 104857600,
				status: 'active',
				job_title: '',
				phone: '5555551374',
				address: '10 Cloud Way Los Altos CA',
				avatar_url: '' } ] }
client.users.listForEnterprise() {
    switch results {
    case let .success(iterator):
        for i in 1 ... 10 {
   { result in
                switch result {
                case let .success(user):
                    print("\( (ID: \(")
                case let .failure(error):
    case let .failure(error):

Response Example

  "entries": [
      "id": 11446498,
      "type": "user",
      "name": "Aaron Levie",
      "login": "",
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "language": "en",
      "timezone": "Africa/Bujumbura",
      "space_amount": 11345156112,
      "space_used": 1237009912,
      "max_upload_size": 2147483648,
      "status": "active",
      "job_title": "CEO",
      "phone": 6509241374,
      "address": "900 Jefferson Ave, Redwood City, CA 94063",
      "avatar_url": "",
      "notification_email": {
        "email": "",
        "is_confirmed": true
  "limit": 1000,
  "offset": 2000,
  "order": [
      "by": "type",
      "direction": "ASC"
  "total_count": 5000