Skip to content

List Users

Endpoint

http
GET /unified/file-storage/users
Integrations supported
  • Box
  • Dropbox

Query parameters

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
name
string
The name of the user
Supported in
  • Box
email
Supported in
  • Box
status
string
The status of the user. If set to inactive, it will get both active and inactive users.
All possible enum values:
  • active
  • inactive
Supported in
  • Dropbox

Response Body

result
object[]
List of Users
id
string
REQUIRED · The unique identifier for a user
Supported in
  • Box
  • Dropbox
first_name
string
The first name of the user
Supported in
  • Dropbox
last_name
string
The last name of the user
Supported in
  • Dropbox
name
string
The name of the user
Supported in
  • Box
  • Dropbox
emails
object[]
The emails of the user
Supported in
  • Box
  • Dropbox
email
string
The email address
type
string
The type of email address
is_primary
boolean
Whether the email address is primary
roles
object[]
The roles of the user
Supported in
  • Dropbox
id
string
The unique identifier for a role
name
string
The name of the role
created_at
string
The date and time the user was created
Supported in
  • Box
  • Dropbox
updated_at
string
The date and time the user was last updated
Supported in
  • Box
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.