GET
/usersList 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.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
filter_termstringoptional
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_typestringoptional
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.
external_app_user_idstringoptional
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.
fieldsarray<string>optional
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.
offsetintegeroptional
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.
limitintegeroptional
The maximum number of items to return per page.
usemarkerbooleanoptional
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.
markerstringoptional
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`.
200Returns all of the users in the enterprise.
limitintegeroptional
The limit that was used for these entries. This will be the same as the
`limit` query parameter unless that value exceeded the maximum value
allowed. The maximum value varies by API.
next_markerstringoptional
The marker for the start of the next page of results.
prev_markerstringoptional
The marker for the start of the previous page of results.
total_countintegeroptional
One greater than the offset of the last entry in the entire collection.
The total number of entries in the collection may be less than
`total_count`.
This field is only returned for calls that use offset-based pagination.
For marker-based paginated APIs, this field will be omitted.
offsetintegeroptional
The 0-based offset of the first entry in this set. This will be the same
as the `offset` query parameter.
This field is only returned for calls that use offset-based pagination.
For marker-based paginated APIs, this field will be omitted.
orderarray<object>optional
The order by which items are returned.
This field is only returned for calls that use offset-based pagination.
For marker-based paginated APIs, this field will be omitted.
entriesarray<UserFull>optional
A list of users.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context
about the error. The possible fields are defined on
a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used
when contacting Box support.
Error handling
Any other status is an error: An unexpected client error.