This resource has a few variations that can be encountered when
using the API.The fields that are part of the full variant can be returned
by API endpoints that support the
fields parameter. For example,
by defining the fields request parameter as
id,type when requesting a file by ID, only those fields will
be returned in the API response.example:
12345The unique identifier that represent a folder.The ID for any folder can be determined
by visiting a folder in the web application
and copying the ID from the URL. For example,
for the URL https://*.app.box.com/folders/123
the folder_id is 123.example:
folderThe value will always be folder.Value is always folderexample:
["editor"]A list of the types of roles that user can be invited at
when sharing this folder.example:
["open"]A list of access levels that are available
for this folder.For some folders, like the root folder, this will always
be an empty list as sharing is not allowed at that level.example:
trueSpecifies if users who are not the owner
of the folder can invite new collaborators to the folder.example:
trueSpecifies if collaborators who are not owners
of this folder are restricted from viewing other
collaborations on this folder.It also restricts non-owners from inviting new
collaborators.Details about the classification applied to this folder.
example:
2012-12-12T10:53:43-08:00The date and time at which this folder was originally
created.example:
2012-12-12T10:53:43-08:00The date and time at which this folder was last updated.example:
2012-12-12T10:53:43-08:00The date and time when the folder was created. This value may
be null for some folders such as the root folder or the trash
folder.The user who created this folder.
example:
Legal contracts for the new ACME dealThe optional description of this folder.example:
1The HTTP etag of this folder. This can be used within some API
endpoints in the If-Match and If-None-Match headers to only
perform changes on the folder if (no) changes have happened.The
folder_upload_email parameter is not null if one of the following options is true:- The Allow uploads to this folder via email and the Only allow email uploads from collaborators in this folder are enabled for a folder in the Admin Console, and the user has at least Upload permissions granted.
- The Allow uploads to this folder via email setting is enabled for a folder in the Admin Console, and the Only allow email uploads from collaborators in this folder setting is deactivated (unchecked).
folder_upload_email: null.example:
trueSpecifies if this folder has any other collaborators.example:
trueSpecifies if the folder can be accessed
with the direct shared link or a shared link
to a parent folder.example:
trueThis field will return true if the folder or any ancestor of the
folder is associated with at least one app item. Note that this will
return true even if the context user does not have access to the
app item(s) associated with the folder.example:
trueSpecifies if new invites to this folder are restricted to users
within the enterprise. This does not affect existing
collaborations.example:
trueSpecifies if this folder is owned by a user outside of the
authenticated enterprise.A page of the items that are in the folder.This field can only be requested when querying a folder’s
information, not when querying a folder’s items.
example:
activeDefines if this item has been deleted or not.activewhen the item has is not in the trashtrashedwhen the item has been moved to the trash but not deleteddeletedwhen the item has been permanently deleted.
active,trashed,deletedAn object containing the metadata instances that have been
attached to this folder.Each metadata instance is uniquely identified by its
scope and
templateKey. There can only be one instance of any metadata
template attached to each folder. Each metadata instance is nested
within an object with the templateKey as the key, which again
itself is nested in an object with the scope as the key.example:
2012-12-12T10:53:43-08:00The date and time when the folder was last updated. This value may
be null for some folders such as the root folder or the trash
folder.The user who last modified this folder.
example:
ContractsThe name of the folder.The user who owns this folder.
The optional folder that this folder is located within.This value may be
null for some folders such as the
root folder or the trash folder.The tree of folders that this folder is contained in,
starting at the root.
Describes the permissions that the current user has
for this folder.
example:
2012-12-12T10:53:43-08:00The time at which this folder is expected to be purged
from the trash.example:
3A numeric identifier that represents the most recent user event
that has been applied to this item.This can be used in combination with the GET /events-endpoint
to filter out user events that would have occurred before this
identifier was read.An example would be where a Box Drive-like application
would fetch an item via the API, and then listen to incoming
user events for changes to the item. The application would
ignore any user events where the sequence_id in the event
is smaller than or equal to the sequence_id in the originally
fetched resource.The shared link for this folder. This will be
null if no shared link has been created for this
folder.example:
629644The folder size in bytes.Be careful parsing this integer as its
value can get very large.example:
syncedSpecifies whether a folder should be synced to a
user’s device or not. This is used by Box Sync
(discontinued) and is not used by Box Drive.Value is one of synced,not_synced,partially_syncedexample:
["approved"]The tags for this item. These tags are shown in
the Box web app and mobile apps next to an item.To add or remove a tag, retrieve the item’s current tags,
modify them, and then update this field.There is a limit of 100 tags per item, and 10,000
unique tags per enterprise.example:
2012-12-12T10:53:43-08:00The time at which this folder was put in the trash.Details about the watermark applied to this folder.