List enterprise users
GET https://{{api.box.com}}/2.0/users
Returns a list of all users for the Enterprise along with their user_id,
https://developer.box.com/reference/get-users
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter_term | string | 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. |
| user_type | string | | Limits the results to the kind of user specified.
allreturns every kind of user for whom theloginornamepartially matches thefilter_term. It will only return an external user if the login matches thefilter_termcompletely, and in that case it will only return that user.managedreturns all managed and app users for whom theloginornamepartially matches thefilter_term.externalreturns all external users for whom theloginmatches thefilter_termexactly. | |external_app_user_id| string | | Limits the results to app users with the givenexternal_app_user_idvalue.
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. |
| fields | string | | 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. |
| offset | number | | The offset of the item at which to begin the response.
Queries with offset parameter value
exceeding 10000 will be rejected
with a 400 response. |
| limit | number | | The maximum number of items to return per page. |
| usemarker | boolean | | 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. |
| marker | string | | 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. |
RESPONSES
status: OK
{"total_count":5000,"limit":1000,"offset":2000,"order":[{"by":"type","direction":"ASC"}],"entries":[{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com","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":"https://www.box.com/api/avatar/large/181216415","notification_email":{"email":"notifications@example.com","is_confirmed":true},"role":"admin","tracking_codes":[{"type":"tracking_code","name":"department","value":"Sales"}],"can_see_managed_users":true,"is_sync_enabled":true,"is_external_collab_restricted":true,"is_exempt_from_device_limits":true,"is_exempt_from_login_verification":true,"enterprise":{"id":"11446498","type":"enterprise","name":"Acme Inc."},"my_tags":["important"],"hostname":"https://example.app.box.com/","is_platform_access_only":true,"external_app_user_id":"my-user-1234"}]}