--- title: "List user and enterprise events" method: GET path: "/events" tags: ["Events"] --- # List user and enterprise events `GET /events` Returns up to a year of past events for a given user or for the entire enterprise. By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the `stream_type` to `admin_logs_streaming` for live monitoring of new events, or `admin_logs` for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked. ## Query parameters - `stream_type` 'all' | 'changes' | 'sync' | 'admin_logs' | 'admin_logs_streaming' - `stream_position` string - `limit` integer - `event_type` string[] - `created_after` string, date-time - `created_before` string, date-time ## Response `200` Returns a list of event objects. Events objects are returned in pages, with each page (chunk) including a list of event objects. The response includes a `chunk_size` parameter indicating how many events were returned in this chunk, as well as the next `stream_position` that can be queried. - Events — A list of event objects. - `chunk_size` integer — The number of events returned in this response. - `next_stream_position` union — The stream position of the start of the next page (chunk) of events. - string - integer - `entries` Event[] — A list of events. - `type` string — The value will always be `event`. - `created_at` string, date-time — When the event object was created. - `recorded_at` string, date-time — When the event object was recorded in database. - `event_id` string — The ID of the event object. You can use this to detect duplicate events. - `created_by` object — The user that performed the action represented by the event. Some events may be performed by users not logged into Box. In that case, not all attributes of the object are populated and the event is attributed to a unknown user (`user_id = 2`). - `id` string, required — The unique identifier for this user. - `type` 'user', required — The value will always be `user`. - `name` string — The display name of this user. - `login` string, email — The primary email address of this user. - `event_type` 'ACCESS_GRANTED' | 'ACCESS_REVOKED' | 'ADD_DEVICE_ASSOCIATION' | 'ADD_LOGIN_ACTIVITY_DEVICE' | 'ADMIN_LOGIN' | 'ADVANCED_FOLDER_SETTINGS_UPDATE' | 'AI_SECURITY_DETECTION' | 'ANNOTATIONV2_CREATE' | 'ANNOTATIONV2_DELETE' | 'ANNOTATIONV2_EDIT' | 'APPLICATION_CREATED' | 'APPLICATION_PUBLIC_KEY_ADDED' | 'APPLICATION_PUBLIC_KEY_DELETED' | 'BOX_AI_USER_FAILED_REQUEST' | 'BOX_AI_USER_REQUEST' | 'CHANGE_ADMIN_ROLE' | 'CHANGE_FOLDER_PERMISSION' | 'COLLABORATION_ACCEPT' | 'COLLABORATION_EXPIRATION' | 'COLLABORATION_INVITE' | 'COLLABORATION_REMOVE' | 'COLLABORATION_ROLE_CHANGE' | 'COLLAB_ADD_COLLABORATOR' | 'COLLAB_INVITE_COLLABORATOR' | 'COLLAB_REMOVE_COLLABORATOR' | 'COLLAB_ROLE_CHANGE' | 'COLLECTION_CREATE' | 'COLLECTION_DELETE' | 'COLLECTION_ITEM_CREATE' | 'COLLECTION_ITEM_DELETE' | 'COLLECTION_ITEM_UPDATE' | 'COLLECTION_UPDATE' | 'COMMENT_CREATE' | 'COMMENT_DELETE' | 'COMMENT_EDIT' | 'CONTENT_ACCESS' | 'CONTENT_RECOVERY_REPORT_CREATE' | 'CONTENT_RECOVERY_REPORT_DELETE' | 'CONTENT_RECOVERY_REPORT_INITIATE' | 'CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY' | 'CONTENT_WORKFLOW_AUTOMATION_ADD' | 'CONTENT_WORKFLOW_AUTOMATION_DELETE' | 'CONTENT_WORKFLOW_POLICY_ADD' | 'CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION' | 'CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION' | 'COPY' | 'DATA_RETENTION_CREATE_RETENTION' | 'DATA_RETENTION_REMOVE_RETENTION' | 'DELETE' | 'DELETE_USER' | 'DEVICE_TRUST_CHECK_FAILED' | 'DISABLE_MULTI_FACTOR_AUTH' | 'DOWNLOAD' | 'EDIT' | 'EDIT_USER' | 'EDR_CROWDSTRIKE_ACCESS_ALLOWED_NO_CROWDSTRIKE_DEVICE' | 'EDR_CROWDSTRIKE_ACCESS_REVOKED' | 'EDR_CROWDSTRIKE_BOX_TOOLS_OUTDATED' | 'EDR_CROWDSTRIKE_DEVICE_DETECTED' | 'EDR_CROWDSTRIKE_DRIVE_OUTDATED' | 'EDR_CROWDSTRIKE_NO_BOX_TOOLS' | 'EMAIL_ALIAS_CONFIRM' | 'EMAIL_ALIAS_PRIMARY' | 'EMAIL_ALIAS_REMOVE' | 'EMAIL_UPLOAD_DISABLED' | 'EMAIL_UPLOAD_ENABLED' | 'ENABLE_MULTI_FACTOR_AUTH' | 'ENABLE_TWO_FACTOR_AUTH' | 'ENTERPRISE_APP_AUTHORIZATION_UPDATE' | 'EXTERNAL_COLLAB_SECURITY_SETTINGS' | 'FAILED_LOGIN' | 'FAVORITE' | 'FILE_MARKED_MALICIOUS' | 'FILE_REQUEST_CREATE' | 'FILE_REQUEST_DELETE' | 'FILE_REQUEST_UPDATE' | 'FILE_VERSION_RESTORE' | 'FILE_WATERMARKED_DOWNLOAD' | 'GROUP_ADD_ITEM' | 'GROUP_ADD_USER' | 'GROUP_ADMIN_CREATED' | 'GROUP_ADMIN_DELETED' | 'GROUP_ADMIN_PERMISSIONS_UPDATED' | 'GROUP_CREATION' | 'GROUP_DELETION' | 'GROUP_EDITED' | 'GROUP_REMOVE_ITEM' | 'GROUP_REMOVE_USER' | 'ILLEGAL_ITEM_OWNERSHIP_TRANSFER_BY_USER' | 'ITEM_ASSOCIATION_CREATED' | 'ITEM_ASSOCIATION_DELETED' | 'ITEM_ASSOCIATION_UPDATED' | 'ITEM_COPY' | 'ITEM_CREATE' | 'ITEM_DOWNLOAD' | 'ITEM_EMAIL_SEND' | 'ITEM_MAKE_CURRENT_VERSION' | 'ITEM_MODIFY' | 'ITEM_MOVE' | 'ITEM_OPEN' | 'ITEM_PREVIEW' | 'ITEM_RENAME' | 'ITEM_SHARED' | 'ITEM_SHARED_CREATE' | 'ITEM_SHARED_UNSHARE' | 'ITEM_SHARED_UPDATE' | 'ITEM_SYNC' | 'ITEM_TRASH' | 'ITEM_UNDELETE_VIA_TRASH' | 'ITEM_UNSYNC' | 'ITEM_UPLOAD' | 'LEGAL_HOLD_ASSIGNMENT_CREATE' | 'LEGAL_HOLD_ASSIGNMENT_DELETE' | 'LEGAL_HOLD_POLICY_CREATE' | 'LEGAL_HOLD_POLICY_DELETE' | 'LEGAL_HOLD_POLICY_UPDATE' | 'LOCK' | 'LOCK_CREATE' | 'LOCK_DESTROY' | 'LOGIN' | 'MASTER_INVITE_ACCEPT' | 'MASTER_INVITE_REJECT' | 'METADATA_CASCADE_POLICY_APPLY' | 'METADATA_CASCADE_POLICY_CREATE' | 'METADATA_INSTANCE_COPY' | 'METADATA_INSTANCE_CREATE' | 'METADATA_INSTANCE_DELETE' | 'METADATA_INSTANCE_UPDATE' | 'METADATA_TEMPLATE_CREATE' | 'METADATA_TEMPLATE_DELETE' | 'METADATA_TEMPLATE_UPDATE' | 'MOVE' | 'NEW_USER' | 'OAUTH2_ACCESS_TOKEN_REVOKE' | 'OAUTH2_REFRESH_TOKEN_REVOKE' | 'PREVIEW' | 'REMOVE_DEVICE_ASSOCIATION' | 'REMOVE_LOGIN_ACTIVITY_DEVICE' | 'RENAME' | 'RETENTION_POLICY_ASSIGNMENT_ADD' | 'SHARE' | 'SHARED_LINK_REDIRECT_OUT_OF_SHARED_CONTEXT' | 'SHARED_LINK_SEND' | 'SHARE_EXPIRATION' | 'SHIELD_ACCESS_POLICY_CREATED' | 'SHIELD_ACCESS_POLICY_DELETED' | 'SHIELD_ACCESS_POLICY_UPDATED' | 'SHIELD_ALERT' | 'SHIELD_DOWNLOAD_BLOCKED' | 'SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED' | 'SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION' | 'SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED' | 'SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION' | 'SHIELD_EXTERNAL_COLLAB_INVITE_JUSTIFIED' | 'SHIELD_INFORMATION_BARRIER_COLLAB_BLOCKED' | 'SHIELD_INFORMATION_BARRIER_DISABLED' | 'SHIELD_INFORMATION_BARRIER_ENABLED' | 'SHIELD_INFORMATION_BARRIER_GROUP_ADD_USER_BLOCKED' | 'SHIELD_INFORMATION_BARRIER_ITEM_COPY_BLOCKED' | 'SHIELD_INFORMATION_BARRIER_ITEM_MOVE_BLOCKED' | 'SHIELD_INFORMATION_BARRIER_ITEM_OWNER_TRANSFER_BLOCKED' | 'SHIELD_INFORMATION_BARRIER_PENDING' | 'SHIELD_INFORMATION_BARRIER_SHARED_ITEM_ACCESS_BLOCKED' | 'SHIELD_JUSTIFICATION_APPROVAL' | 'SHIELD_SHARED_LINK_ACCESS_BLOCKED' | 'SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_CREATE' | 'SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_UPDATE' | 'SIGN_DOCUMENT_ASSIGNED' | 'SIGN_DOCUMENT_CANCELLED' | 'SIGN_DOCUMENT_COMPLETED' | 'SIGN_DOCUMENT_CONVERTED' | 'SIGN_DOCUMENT_CREATED' | 'SIGN_DOCUMENT_DECLINED' | 'SIGN_DOCUMENT_EXPIRED' | 'SIGN_DOCUMENT_SIGNED' | 'SIGN_DOCUMENT_VIEWED_BY_SIGNED' | 'SIGN_DOCUMENT_VIEWED_BY_SIGNER' | 'SIGNER_DOWNLOADED' | 'SIGNER_FORWARDED' | 'STORAGE_EXPIRATION' | 'TAG_ITEM_CREATE' | 'TASK_ASSIGNMENT_CREATE' | 'TASK_ASSIGNMENT_DELETE' | 'TASK_ASSIGNMENT_UPDATE' | 'TASK_CREATE' | 'TASK_UPDATE' | 'TERMS_OF_SERVICE_ACCEPT' | 'TERMS_OF_SERVICE_REJECT' | 'UNDELETE' | 'UNFAVORITE' | 'UNLOCK' | 'UNSHARE' | 'UPDATE_COLLABORATION_EXPIRATION' | 'UPDATE_SHARE_EXPIRATION' | 'UPLOAD' | 'USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE' | 'WATERMARK_LABEL_CREATE' | 'WATERMARK_LABEL_DELETE' | 'WORKFLOW_AUTOMATION_CREATE' | 'WORKFLOW_AUTOMATION_DELETE' | 'WORKFLOW_AUTOMATION_UPDATE' — The event type that triggered this event. - `session_id` string — The session of the user that performed the action. Not all events will populate this attribute. - `source` union - object — A mini representation of a user, used when nested within another resource. - `id` string, required — The unique identifier for this user. - `type` 'user', required — The value will always be `user`. - `name` string — The display name of this user. - `login` string, email — The primary email address of this user. - `created_at` string, date-time — When the user object was created. - `modified_at` string, date-time — When the user object was last modified. - `language` string — The language of the user, formatted in modified version of the [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format. - `timezone` string, timezone — The user's timezone. - `space_amount` integer — The user’s total available space amount in bytes. - `space_used` integer — The amount of space in use by the user. - `max_upload_size` integer — The maximum individual file size in bytes the user can have. - `status` 'active' | 'inactive' | 'cannot_delete_edit' | 'cannot_delete_edit_upload' — The user's account status. - `job_title` string — The user’s job title. - `phone` string — The user’s phone number. - `address` string — The user’s address. - `avatar_url` string — URL of the user’s avatar image. - `notification_email` object, nullable — An alternate notification email address to which email notifications are sent. When it's confirmed, this will be the email address to which notifications are sent instead of to the primary email address. - `email` string — The email address to send the notifications to. - `is_confirmed` boolean — Specifies if this email address has been confirmed. - object — The resource that triggered this event. For more information, check out the guide on event triggers. - `item_type` 'file' | 'folder', required — The type of the item that the event represents. Can be `file` or `folder`. - `item_id` string, required — The unique identifier that represents the item. - `item_name` string, required — The name of the item. - `classification` object — The object containing classification information for the item that triggered the event. This field will not appear if the item does not have a classification set. - `name` string — The classification's name. - `parent` object, nullable — 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. - `id` string, required — The 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`. - `etag` string, nullable — The 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. - `type` 'folder', required — The value will always be `folder`. - `sequence_id` string — A 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. - `name` string — The name of the folder. - `owned_by` object — The user who owns this item. - `id` string, required — The unique identifier for this user. - `type` 'user', required — The value will always be `user`. - `name` string — The display name of this user. - `login` string, email — The primary email address of this user. - object, nullable — The bare basic representation of a file, the minimal amount of fields returned when using the `fields` query parameter. - `id` string, required — The unique identifier that represent a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. - `etag` string, nullable — The HTTP `etag` of this file. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the file if (no) changes have happened. - `type` 'file', required — The value will always be `file`. - `sequence_id` string — A 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. - `name` string — The name of the file. - `sha1` string, digest — The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file. - `file_version` object — The information about the current version of the file. - `id` string, required — The unique identifier that represent a file version. - `type` 'file_version', required — The value will always be `file_version`. - `sha1` string — The SHA1 hash of this version of the file. - `description` string — The optional description of this file. If the description exceeds 255 characters, the first 255 characters are set as a file description and the rest of it is ignored. - `size` integer — The file size in bytes. Be careful parsing this integer as it can get very large and cause an integer overflow. - `path_collection` object — The tree of folders that this file is contained in, starting at the root. - `total_count` integer, required — The number of folders in this list. - `entries` FolderMini[], required — The parent folders for this item. - `id` string, required — The 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`. - `etag` string, nullable — The 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. - `type` 'folder', required — The value will always be `folder`. - `sequence_id` string — A 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. - `name` string — The name of the folder. - `created_at` string, date-time — The date and time when the file was created on Box. - `modified_at` string, date-time — The date and time when the file was last updated on Box. - `trashed_at` string, date-time, nullable — The time at which this file was put in the trash. - `purged_at` string, date-time, nullable — The time at which this file is expected to be purged from the trash. - `content_created_at` string, date-time, nullable — The date and time at which this file was originally created, which might be before it was uploaded to Box. - `content_modified_at` string, date-time, nullable — The date and time at which this file was last updated, which might be before it was uploaded to Box. - `created_by` object — The user who created this file. - `id` string, required — The unique identifier for this user. - `type` 'user', required — The value will always be `user`. - `name` string — The display name of this user. - `login` string, email — The primary email address of this user. - `modified_by` object — The user who last modified this file. - `id` string, required — The unique identifier for this user. - `type` 'user', required — The value will always be `user`. - `name` string — The display name of this user. - `login` string, email — The primary email address of this user. - `owned_by` object — The user who owns this file. - `id` string, required — The unique identifier for this user. - `type` 'user', required — The value will always be `user`. - `name` string — The display name of this user. - `login` string, email — The primary email address of this user. - `shared_link` object, nullable — The shared link for this file. This value will be `null` if no shared link has been created for this file. - `url` string, url, required — The URL that can be used to access the item on Box. This URL will display the item in Box's preview UI where the file can be downloaded if allowed. This URL will continue to work even when a custom `vanity_url` has been set for this shared link. - `download_url` string, url, nullable — A URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type. This property will be `null` for folders. - `vanity_url` string, url, nullable — The "Custom URL" that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application. - `vanity_name` string, nullable — The custom name of a shared link, as used in the `vanity_url` field. - `access` 'open' | 'company' | 'collaborators' — The access level for this shared link. * `open` - provides access to this item to anyone with this link * `company` - only provides access to this item to people the same company * `collaborators` - only provides access to this item to people who are collaborators on this item If this field is omitted when creating the shared link, the access level will be set to the default access level specified by the enterprise admin. - `effective_access` 'open' | 'company' | 'collaborators', required — The effective access level for the shared link. This can be a more restrictive access level than the value in the `access` field when the enterprise settings restrict the allowed access levels. - `effective_permission` 'can_edit' | 'can_download' | 'can_preview' | 'no_access', required — The effective permissions for this shared link. These result in the more restrictive combination of the share link permissions and the item permissions set by the administrator, the owner, and any ancestor item such as a folder. - `unshared_at` string, date-time, nullable — The date and time when this link will be unshared. This field can only be set by users with paid accounts. - `is_password_enabled` boolean, required — Defines if the shared link requires a password to access the item. - `permissions` object — Defines if this link allows a user to preview, edit, and download an item. These permissions refer to the shared link only and do not supersede permissions applied to the item itself. - `can_download` boolean, required — Defines if the shared link allows for the item to be downloaded. For shared links on folders, this also applies to any items in the folder. This value can be set to `true` when the effective access level is set to `open` or `company`, not `collaborators`. - `can_preview` boolean, required — Defines if the shared link allows for the item to be previewed. This value is always `true`. For shared links on folders this also applies to any items in the folder. - `can_edit` boolean, required — Defines if the shared link allows for the item to be edited. This value can only be `true` if `can_download` is also `true` and if the item has a type of `file`. - `download_count` integer, required — The number of times this item has been downloaded. - `preview_count` integer, required — The number of times this item has been previewed. - `parent` object, nullable — The folder that this file is located within. This value may be `null` for some folders such as the root folder or the trash folder. - `id` string, required — The 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`. - `etag` string, nullable — The 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. - `type` 'folder', required — The value will always be `folder`. - `sequence_id` string — A 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. - `name` string — The name of the folder. - `item_status` 'active' | 'trashed' | 'deleted' — Defines if this item has been deleted or not. * `active` when the item has is not in the trash * `trashed` when the item has been moved to the trash but not deleted * `deleted` when the item has been permanently deleted. - object — The bare basic representation of a folder, the minimal amount of fields returned when using the `fields` query parameter. - `id` string, required — The 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`. - `etag` string, nullable — The 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. - `type` 'folder', required — The value will always be `folder`. - `sequence_id` string — A 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. - `name` string — The name of the folder. - `created_at` string, date-time, nullable — The 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. - `modified_at` string, date-time, nullable — The 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. - `description` string — The optional description of this folder. - `size` integer — The folder size in bytes. Be careful parsing this integer as its value can get very large. - `path_collection` object — The tree of folders that this folder is contained in, starting at the root. - `total_count` integer, required — The number of folders in this list. - `entries` FolderMini[], required — The parent folders for this item. - `id` string, required — The 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`. - `etag` string, nullable — The 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. - `type` 'folder', required — The value will always be `folder`. - `sequence_id` string — A 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. - `name` string — The name of the folder. - `created_by` object — The user who created this folder. - `id` string, required — The unique identifier for this user. - `type` 'user', required — The value will always be `user`. - `name` string — The display name of this user. - `login` string, email — The primary email address of this user. - `modified_by` object — The user who last modified this folder. - `id` string, required — The unique identifier for this user. - `type` 'user', required — The value will always be `user`. - `name` string — The display name of this user. - `login` string, email — The primary email address of this user. - `trashed_at` string, date-time, nullable — The time at which this folder was put in the trash. - `purged_at` string, date-time, nullable — The time at which this folder is expected to be purged from the trash. - `content_created_at` string, date-time, nullable — The date and time at which this folder was originally created. - `content_modified_at` string, date-time, nullable — The date and time at which this folder was last updated. - `owned_by` object — The user who owns this folder. - `id` string, required — The unique identifier for this user. - `type` 'user', required — The value will always be `user`. - `name` string — The display name of this user. - `login` string, email — The primary email address of this user. - `shared_link` object, nullable — The shared link for this folder. This will be `null` if no shared link has been created for this folder. - `url` string, url, required — The URL that can be used to access the item on Box. This URL will display the item in Box's preview UI where the file can be downloaded if allowed. This URL will continue to work even when a custom `vanity_url` has been set for this shared link. - `download_url` string, url, nullable — A URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type. This property will be `null` for folders. - `vanity_url` string, url, nullable — The "Custom URL" that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application. - `vanity_name` string, nullable — The custom name of a shared link, as used in the `vanity_url` field. - `access` 'open' | 'company' | 'collaborators' — The access level for this shared link. * `open` - provides access to this item to anyone with this link * `company` - only provides access to this item to people the same company * `collaborators` - only provides access to this item to people who are collaborators on this item If this field is omitted when creating the shared link, the access level will be set to the default access level specified by the enterprise admin. - `effective_access` 'open' | 'company' | 'collaborators', required — The effective access level for the shared link. This can be a more restrictive access level than the value in the `access` field when the enterprise settings restrict the allowed access levels. - `effective_permission` 'can_edit' | 'can_download' | 'can_preview' | 'no_access', required — The effective permissions for this shared link. These result in the more restrictive combination of the share link permissions and the item permissions set by the administrator, the owner, and any ancestor item such as a folder. - `unshared_at` string, date-time, nullable — The date and time when this link will be unshared. This field can only be set by users with paid accounts. - `is_password_enabled` boolean, required — Defines if the shared link requires a password to access the item. - `permissions` object — Defines if this link allows a user to preview, edit, and download an item. These permissions refer to the shared link only and do not supersede permissions applied to the item itself. - `can_download` boolean, required — Defines if the shared link allows for the item to be downloaded. For shared links on folders, this also applies to any items in the folder. This value can be set to `true` when the effective access level is set to `open` or `company`, not `collaborators`. - `can_preview` boolean, required — Defines if the shared link allows for the item to be previewed. This value is always `true`. For shared links on folders this also applies to any items in the folder. - `can_edit` boolean, required — Defines if the shared link allows for the item to be edited. This value can only be `true` if `can_download` is also `true` and if the item has a type of `file`. - `download_count` integer, required — The number of times this item has been downloaded. - `preview_count` integer, required — The number of times this item has been previewed. - `folder_upload_email` object, nullable — 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](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), 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). If the conditions are not met, the parameter will have the following value: `folder_upload_email: null`. - `access` 'open' | 'collaborators' — When this parameter has been set, users can email files to the email address that has been automatically created for this folder. To create an email address, set this property either when creating or updating the folder. When set to `collaborators`, only emails from registered email addresses for collaborators will be accepted. This includes any email aliases a user might have registered. When set to `open` it will accept emails from any email address. - `email` string, email — The optional upload email address for this folder. - `parent` object, nullable — 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. - `id` string, required — The 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`. - `etag` string, nullable — The 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. - `type` 'folder', required — The value will always be `folder`. - `sequence_id` string — A 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. - `name` string — The name of the folder. - `item_status` 'active' | 'trashed' | 'deleted' — Defines if this item has been deleted or not. * `active` when the item has is not in the trash * `trashed` when the item has been moved to the trash but not deleted * `deleted` when the item has been permanently deleted. - `item_collection` object — 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. - `limit` integer — 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_marker` string, nullable — The marker for the start of the next page of results. - `prev_marker` string, nullable — The marker for the start of the previous page of results. - `total_count` integer — 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. - `offset` integer — 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. - `order` object[] — 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. - `by` string — The field to order by. - `direction` 'ASC' | 'DESC' — The direction to order by, either ascending or descending. - `entries` Item[] — The items in this collection. - union — An item represents a file, folder, or web link. - … - object — The resource that triggered this event. For more information, check out the guide on event triggers. - object — The resource that triggered this event. For more information, check out the guide on event triggers. - `id` string, required — The id of the `AppItem`. - `type` 'app_item', required — The type of the source that this event represents. Can only be `app_item`. - `app_item_type` string, required — The type of the `AppItem`. - `user` object — The user that triggered the event. - `id` string, required — The unique identifier for this user. - `type` 'user', required — The value will always be `user`. - `name` string — The display name of this user. - `login` string, email — The primary email address of this user. - `group` object — The group that triggered the event. - `id` string, required — The unique identifier for this object. - `type` 'group', required — The value will always be `group`. - `name` string — The name of the group. - `group_type` 'managed_group' | 'all_users_group' — The type of the group. - `additional_details` object — This object provides additional information about the event if available. This can include how a user performed an event as well as additional information to correlate an event to external KeySafe logs. Not all events have an `additional_details` object. This object is only available in the Enterprise Events. ## Other responses - `default` — An unexpected client error. --- [API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)