openapi: 3.1.0 info: title: Box Web Links API description: Needs a description. paths: /web_links: post: operationId: post_web_links summary: Box Create web link tags: - Web Links x-box-tag: web_links description: Creates a web link object within a folder. requestBody: content: application/json: schema: type: object required: - parent - url properties: url: type: string example: https://box.com description: |- The URL that this web link links to. Must start with `"http://"` or `"https://"`. parent: type: object description: The parent folder to create the web link within. required: - id properties: id: type: string description: The ID of parent folder example: '0' name: type: string example: Box Website description: Name of the web link. Defaults to the URL if not set. description: type: string example: Cloud Content Management description: Description of the web link. responses: '200': description: Returns the newly created web link object. content: application/json: schema: $ref: '#/components/schemas/WebLink' default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' /web_links/{web_link_id}: get: operationId: get_web_links_id summary: Box Get web link tags: - Web Links x-box-tag: web_links description: Retrieve information about a web link. parameters: - name: web_link_id description: The ID of the web link. example: '12345' in: path required: true schema: type: string - name: boxapi description: >- The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly shared with a user. Use the format `shared_link=[link]` or if a password is required then use `shared_link=[link]&shared_link_password=[password]`. This header can be used on the file or folder shared, as well as on any files or folders nested within the item. example: shared_link=[link]&shared_link_password=[password] in: header required: false schema: type: string responses: '200': description: Returns the web link object. content: application/json: schema: $ref: '#/components/schemas/WebLink' default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' post: operationId: post_web_links_id summary: Box Restore web link tags: - Web Links x-box-tag: trashed_web_links description: >- Restores a web link that has been moved to the trash. An optional new parent ID can be provided to restore the web link to in case the original folder has been deleted. parameters: - name: web_link_id description: The ID of the web link. example: '12345' in: path required: true schema: type: string - name: fields description: |- 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. in: query example: - id - type - name required: false explode: false schema: type: array items: type: string requestBody: content: application/json: schema: type: object properties: name: description: An optional new name for the web link. example: Restored.docx type: string parent: allOf: - type: object description: The parent for this item properties: id: type: string description: The ID of parent item example: '123' - description: >- Specifies an optional ID of a folder to restore the web link to when the original folder no longer exists. Please be aware that this ID will only be used if the original folder no longer exists. Use this ID to provide a fallback location to restore the web link to if the original location has been deleted. responses: '201': description: Returns a web link object when it has been restored. content: application/json: schema: $ref: '#/components/schemas/TrashWebLinkRestored' '403': description: >- Returns an error if the user does not have access to the folder the web link is being restored to, or the user does not have permission to restore web link from the trash. content: application/json: schema: $ref: '#/components/schemas/ClientError' '404': description: Returns an error if the web link is not in the trash. content: application/json: schema: $ref: '#/components/schemas/ClientError' '409': description: |- Returns an error if there is an web link with the same name in the folder the web link is being restored to. content: application/json: schema: $ref: '#/components/schemas/ClientError' default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' put: operationId: put_web_links_id summary: Box Update web link tags: - Web Links x-box-tag: web_links description: Updates a web link object. parameters: - name: web_link_id description: The ID of the web link. example: '12345' in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: url: type: string example: https://box.com description: |- The new URL that the web link links to. Must start with `"http://"` or `"https://"`. parent: allOf: - type: object description: The parent for this item properties: id: type: string description: The ID of parent item example: '123' - description: |- The new parent folder to put the web link in. Use this to move the web link to a different folder. name: type: string example: Box Website description: A new name for the web link. Defaults to the URL if not set. description: type: string example: Cloud Content Management description: A new description of the web link. shared_link: description: The settings for the shared link to update. type: object properties: access: type: string description: >- The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the folder (`collaborators`). If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`. The `company` access level is only available to paid accounts. enum: - open - company - collaborators example: open password: type: string description: >- The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`. example: do-not-use-this-password vanity_name: type: string description: >- Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links. minLength: 12 example: my-shared-link unshared_at: type: string format: date-time example: '2012-12-12T10:53:43-08:00' description: >- The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time. responses: '200': description: Returns the updated web link object. content: application/json: schema: $ref: '#/components/schemas/WebLink' default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' delete: operationId: delete_web_links_id summary: Box Remove web link tags: - Web Links x-box-tag: web_links description: Deletes a web link. parameters: - name: web_link_id description: The ID of the web link. example: '12345' in: path required: true schema: type: string responses: '204': description: |- An empty response will be returned when the web link was successfully deleted. default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' /web_links/{web_link_id}/trash: get: operationId: get_web_links_id_trash summary: Box Get trashed web link tags: - Web Links x-box-tag: trashed_web_links description: Retrieves a web link that has been moved to the trash. parameters: - name: web_link_id description: The ID of the web link. example: '12345' in: path required: true schema: type: string - name: fields description: |- 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. in: query example: - id - type - name required: false explode: false schema: type: array items: type: string responses: '200': description: |- Returns the web link that was trashed, including information about when the it was moved to the trash. content: application/json: schema: $ref: '#/components/schemas/TrashWebLink' '404': description: Returns an error if the web link is not in the trash. content: application/json: schema: $ref: '#/components/schemas/ClientError' default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' delete: operationId: delete_web_links_id_trash summary: Box Permanently remove web link tags: - Web Links x-box-tag: trashed_web_links description: |- Permanently deletes a web link that is in the trash. This action cannot be undone. parameters: - name: web_link_id description: The ID of the web link. example: '12345' in: path required: true schema: type: string responses: '204': description: |- Returns an empty response when the web link was permanently deleted. '404': description: Returns an error if the web link is not in the trash. content: application/json: schema: $ref: '#/components/schemas/ClientError' default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' /web_links/{web_link_id}#get_shared_link: get: operationId: get_web_links_id#get_shared_link summary: Box Get shared link for web link tags: - Web Links x-box-tag: shared_links_web_links x-box-enable-explorer: true x-box-sanitized: true description: Gets the information for a shared link on a web link. parameters: - name: web_link_id description: The ID of the web link. example: '12345' in: path required: true schema: type: string - name: fields description: |- Explicitly request the `shared_link` fields to be returned for this item. example: shared_link in: query required: true schema: type: string responses: '200': description: |- Returns the base representation of a web link with the additional shared link information. content: application/json: schema: $ref: '#/components/schemas/WebLink' examples: default: value: id: '12345' type: web_link etag: '1' shared_link: url: https://app.box.com/s/kwio6b4ovt1264rnfbyqo1 download_url: >- https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf vanity_url: vanity_name: effective_access: open effective_permission: can_download is_password_enabled: false unshared_at: '2020-09-21T10:34:41-07:00' download_count: 0 preview_count: 0 access: open permissions: can_preview: true can_download: true can_edit: false '401': description: >- Returned when the access token provided in the `Authorization` header is not recognized or not provided. content: application/json: schema: $ref: '#/components/schemas/ClientError' '404': description: |- Returned if the file is not found, or the user does not have access to the file. content: application/json: schema: $ref: '#/components/schemas/ClientError' '405': description: Returned if the `file_id` is not in a recognized format. content: application/json: schema: $ref: '#/components/schemas/ClientError' default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' /web_links/{web_link_id}#add_shared_link: put: operationId: put_web_links_id#add_shared_link summary: Box Add shared link to web link tags: - Web Links x-box-tag: shared_links_web_links x-box-enable-explorer: true x-box-sanitized: true description: Adds a shared link to a web link. parameters: - name: web_link_id description: The ID of the web link. example: '12345' in: path required: true schema: type: string - name: fields description: |- Explicitly request the `shared_link` fields to be returned for this item. example: shared_link in: query required: true schema: type: string requestBody: content: application/json: schema: type: object properties: shared_link: description: >- The settings for the shared link to create on the web link. Use an empty object (`{}`) to use the default settings for shared links. type: object properties: access: type: string description: >- The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the file (`collaborators`). If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`. The `company` access level is only available to paid accounts. enum: - open - company - collaborators example: open password: type: string description: >- The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`. example: do-n8t-use-this-Password vanity_name: type: string description: >- Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links. minLength: 12 example: my-shared-link unshared_at: type: string format: date-time example: '2012-12-12T10:53:43-08:00' description: >- The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time. permissions: type: object properties: can_download: type: boolean example: true description: |- If the shared link allows for downloading of files. This can only be set when `access` is set to `open` or `company`. can_preview: type: boolean example: true description: >- If the shared link allows for previewing of files. This value is always `true`. For shared links on folders this also applies to any items in the folder. can_edit: type: boolean example: false description: This value can only be `true` is `type` is `file`. responses: '200': description: |- Returns the base representation of a web link with a new shared link attached. content: application/json: schema: $ref: '#/components/schemas/WebLink' examples: default: value: id: '12345' type: web_link etag: '1' shared_link: url: https://app.box.com/s/kwio6b4ovt1264rnfbyqo1 download_url: >- https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf vanity_url: vanity_name: effective_access: open effective_permission: can_download is_password_enabled: false unshared_at: '2020-09-21T10:34:41-07:00' download_count: 0 preview_count: 0 access: open permissions: can_preview: true can_download: true can_edit: false '400': description: Returned when there is an incorrect permission combination content: application/json: schema: $ref: '#/components/schemas/ClientError' '401': description: >- Returned when the access token provided in the `Authorization` header is not recognized or not provided. content: application/json: schema: $ref: '#/components/schemas/ClientError' '403': description: >- Returned if the user does not have all the permissions to complete the update. content: application/json: schema: $ref: '#/components/schemas/ClientError' '404': description: |- Returned if the file is not found, or the user does not have access to the file. content: application/json: schema: $ref: '#/components/schemas/ClientError' '405': description: Returned if the `file_id` is not in a recognized format. content: application/json: schema: $ref: '#/components/schemas/ClientError' '412': description: |- Returns an error when the `If-Match` header does not match the current `etag` value of the file. This indicates that the file has changed since it was last requested. content: application/json: schema: $ref: '#/components/schemas/ClientError' default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' /web_links/{web_link_id}#update_shared_link: put: operationId: put_web_links_id#update_shared_link summary: Box Update shared link on web link tags: - Web Links x-box-tag: shared_links_web_links x-box-enable-explorer: true x-box-sanitized: true description: Updates a shared link on a web link. parameters: - name: web_link_id description: The ID of the web link. example: '12345' in: path required: true schema: type: string - name: fields description: |- Explicitly request the `shared_link` fields to be returned for this item. example: shared_link in: query required: true schema: type: string requestBody: content: application/json: schema: type: object properties: shared_link: description: The settings for the shared link to update. type: object properties: access: type: string description: >- The level of access for the shared link. This can be restricted to anyone with the link (`open`), only people within the company (`company`) and only those who have been invited to the folder (`collaborators`). If not set, this field defaults to the access level specified by the enterprise admin. To create a shared link with this default setting pass the `shared_link` object with no `access` field, for example `{ "shared_link": {} }`. The `company` access level is only available to paid accounts. enum: - open - company - collaborators example: open password: type: string description: >- The password required to access the shared link. Set the password to `null` to remove it. Passwords must now be at least eight characters long and include a number, upper case letter, or a non-numeric or non-alphabetic character. A password can only be set when `access` is set to `open`. example: do-n8t-use-this-Password vanity_name: type: string description: >- Defines a custom vanity name to use in the shared link URL, for example `https://app.box.com/v/my-shared-link`. Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links. minLength: 12 example: my-shared-link unshared_at: type: string format: date-time example: '2012-12-12T10:53:43-08:00' description: >- The timestamp at which this shared link will expire. This field can only be set by users with paid accounts. The value must be greater than the current date and time. permissions: type: object properties: can_download: type: boolean example: true description: |- If the shared link allows for downloading of files. This can only be set when `access` is set to `open` or `company`. can_preview: type: boolean example: true description: >- If the shared link allows for previewing of files. This value is always `true`. For shared links on folders this also applies to any items in the folder. can_edit: type: boolean example: true description: This value can only be `true` is `type` is `file`. responses: '200': description: >- Returns a basic representation of the web link, with the updated shared link attached. content: application/json: schema: $ref: '#/components/schemas/WebLink' examples: default: value: id: '12345' type: web_link etag: '1' shared_link: url: https://app.box.com/s/kwio6b4ovt1264rnfbyqo1 download_url: >- https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf vanity_url: vanity_name: effective_access: open effective_permission: can_download is_password_enabled: false unshared_at: '2020-09-21T10:34:41-07:00' download_count: 0 preview_count: 0 access: open permissions: can_preview: true can_download: true can_edit: false '400': description: Returned when there is an incorrect permission combination content: application/json: schema: $ref: '#/components/schemas/ClientError' '401': description: >- Returned when the access token provided in the `Authorization` header is not recognized or not provided. content: application/json: schema: $ref: '#/components/schemas/ClientError' '403': description: >- Returned if the user does not have all the permissions to complete the update. content: application/json: schema: $ref: '#/components/schemas/ClientError' '404': description: |- Returned if the file is not found, or the user does not have access to the file. content: application/json: schema: $ref: '#/components/schemas/ClientError' '405': description: Returned if the `file_id` is not in a recognized format. content: application/json: schema: $ref: '#/components/schemas/ClientError' '412': description: |- Returns an error when the `If-Match` header does not match the current `etag` value of the file. This indicates that the file has changed since it was last requested. content: application/json: schema: $ref: '#/components/schemas/ClientError' default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' /web_links/{web_link_id}#remove_shared_link: put: operationId: put_web_links_id#remove_shared_link summary: Box Remove shared link from web link tags: - Web Links x-box-tag: shared_links_web_links x-box-enable-explorer: true x-box-sanitized: true description: Removes a shared link from a web link. parameters: - name: web_link_id description: The ID of the web link. example: '12345' in: path required: true schema: type: string - name: fields description: |- Explicitly request the `shared_link` fields to be returned for this item. example: shared_link in: query required: true schema: type: string requestBody: content: application/json: schema: type: object properties: shared_link: description: |- By setting this value to `null`, the shared link is removed from the web link. type: object example: nullable: true responses: '200': description: |- Returns a basic representation of a web link, with the shared link removed. content: application/json: schema: $ref: '#/components/schemas/WebLink' examples: default: value: id: '12345' type: web_link etag: '1' shared_link: '401': description: >- Returned when the access token provided in the `Authorization` header is not recognized or not provided. content: application/json: schema: $ref: '#/components/schemas/ClientError' '403': description: >- Returned if the user does not have all the permissions to complete the update. content: application/json: schema: $ref: '#/components/schemas/ClientError' '404': description: |- Returned if the file is not found, or the user does not have access to the file. content: application/json: schema: $ref: '#/components/schemas/ClientError' '405': description: Returned if the `file_id` is not in a recognized format. content: application/json: schema: $ref: '#/components/schemas/ClientError' '412': description: |- Returns an error when the `If-Match` header does not match the current `etag` value of the file. This indicates that the file has changed since it was last requested. content: application/json: schema: $ref: '#/components/schemas/ClientError' default: description: An unexpected client error. content: application/json: schema: $ref: '#/components/schemas/ClientError' components: schemas: WebLink: title: Web link type: object x-box-resource-id: web_link x-box-variant: standard description: |- Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files. allOf: - $ref: '#/components/schemas/WebLink--Mini' - properties: parent: allOf: - $ref: '#/components/schemas/Folder--Mini' - description: The parent object the web link belongs to description: type: string example: Example page description: |- The description accompanying the web link. This is visible within the Box web application. path_collection: allOf: - title: Path collection description: A list of parent folders for an item. type: object required: - total_count - entries properties: total_count: description: The number of folders in this list. example: 1 type: integer format: int64 nullable: false entries: type: array description: The parent folders for this item nullable: false items: $ref: '#/components/schemas/Folder--Mini' - description: |- The tree of folders that this web link is contained in, starting at the root. - nullable: false created_at: type: string format: date-time description: When this file was created on Box’s servers. example: '2012-12-12T10:53:43-08:00' modified_at: type: string format: date-time description: |- When this file was last updated on the Box servers. example: '2012-12-12T10:53:43-08:00' trashed_at: type: string format: date-time nullable: true description: When this file was moved to the trash. example: '2012-12-12T10:53:43-08:00' purged_at: type: string format: date-time nullable: true description: When this file will be permanently deleted. example: '2012-12-12T10:53:43-08:00' created_by: allOf: - $ref: '#/components/schemas/User--Mini' - description: The user who created this web link modified_by: allOf: - $ref: '#/components/schemas/User--Mini' - description: The user who last modified this web link owned_by: allOf: - $ref: '#/components/schemas/User--Mini' - description: The user who owns this web link shared_link: allOf: - title: Shared link description: >- Shared links provide direct, read-only access to files or folder on Box. Shared links with open access level allow anyone with the URL to access the item, while shared links with company or collaborators access levels can only be accessed by appropriately authenticated Box users. type: object required: - url - accessed - effective_access - effective_permission - is_password_enabled - download_count - preview_count properties: url: type: string format: url description: >- 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. example: https://www.box.com/s/vspke7y05sb214wjokpk nullable: false download_url: type: string format: url x-box-premium-feature: true description: >- 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. example: >- https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg nullable: true vanity_url: type: string format: url description: >- 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. example: https://acme.app.box.com/v/my_url/ nullable: true vanity_name: type: string description: >- The custom name of a shared link, as used in the `vanity_url` field. example: my_url nullable: true access: type: string description: >- 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. enum: - open - company - collaborators example: open nullable: false effective_access: type: string description: >- 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. enum: - open - company - collaborators example: company nullable: false effective_permission: type: string description: |- 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. enum: - can_edit - can_download - can_preview - no_access example: can_download nullable: false unshared_at: type: string format: date-time description: >- The date and time when this link will be unshared. This field can only be set by users with paid accounts. example: '2018-04-13T13:53:23-07:00' nullable: true is_password_enabled: type: boolean description: >- Defines if the shared link requires a password to access the item. example: true nullable: false permissions: type: object description: >- 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. required: - can_download - can_preview - can_edit properties: can_download: type: boolean example: true nullable: false description: >- 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: type: boolean example: true nullable: false description: >- 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: type: boolean example: false nullable: false description: >- 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: type: integer example: 3 description: The number of times this item has been downloaded. nullable: false preview_count: type: integer example: 3 description: The number of times this item has been previewed. nullable: false - description: |- The shared link object for this item. Will be `null` if no shared link has been created. - nullable: true item_status: type: string example: active enum: - active - trashed - deleted description: >- Whether this item is deleted or not. Values include `active`, `trashed` if the file has been moved to the trash, and `deleted` if the file has been permanently deleted ClientError: title: Client error type: object x-box-resource-id: client_error description: A generic error properties: type: description: error example: error type: string enum: - error nullable: false status: description: The HTTP status of the response. example: 400 type: integer format: int32 nullable: false code: description: A Box-specific error code example: item_name_invalid type: string enum: - created - accepted - no_content - redirect - not_modified - bad_request - unauthorized - forbidden - not_found - method_not_allowed - conflict - precondition_failed - too_many_requests - internal_server_error - unavailable - item_name_invalid - insufficient_scope message: description: A short message describing the error. example: Method Not Allowed type: string nullable: false context_info: description: |- 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. type: object nullable: true properties: message: type: string description: More details on the error. example: Something went wrong. help_url: description: A URL that links to more information about why this error occurred. example: >- https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/ type: string nullable: false request_id: description: |- A unique identifier for this response, which can be used when contacting Box support. type: string example: abcdef123456 nullable: false TrashWebLink: title: Trashed Web Link type: object x-box-resource-id: trash_web_link x-box-tag: trashed_web_links description: Represents a trashed web link. properties: type: type: string description: '`web_link`' example: web_link enum: - web_link id: type: string description: The unique identifier for this web link example: '11446498' sequence_id: allOf: - type: string example: '3' nullable: true description: |- 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. - nullable: false etag: type: string example: '1' description: |- The entity tag of this web link. Used with `If-Match` headers. name: type: string description: The name of the web link example: My Bookmark url: type: string example: https://www.example.com/example/1234 description: The URL this web link points to parent: allOf: - $ref: '#/components/schemas/Folder--Mini' - description: The parent object the web link belongs to description: type: string example: Example page description: |- The description accompanying the web link. This is visible within the Box web application. path_collection: allOf: - title: Path collection (Trash) description: A list of parent folders for an item in the trash. type: object required: - total_count - entries properties: total_count: description: The number of folders in this list. example: 1 type: integer format: int64 nullable: false entries: description: Array of folders for this item's path collection type: array items: type: object description: The parent folder for this item properties: type: type: string description: '`folder`' enum: - folder example: folder id: type: string description: The unique identifier that represent a folder. example: '123456789' sequence_id: type: string nullable: true example: description: This field is null for the Trash folder etag: type: string nullable: true example: description: This field is null for the Trash folder name: type: string description: The name of the Trash folder. example: Trash nullable: false - description: |- The tree of folders that this web link is contained in, starting at the root. - nullable: false created_at: type: string format: date-time description: When this file was created on Box’s servers. example: '2012-12-12T10:53:43-08:00' modified_at: type: string format: date-time description: |- When this file was last updated on the Box servers. example: '2012-12-12T10:53:43-08:00' trashed_at: type: string format: date-time nullable: true description: When this file was last moved to the trash. example: '2012-12-12T10:53:43-08:00' purged_at: type: string format: date-time nullable: true description: When this file will be permanently deleted. example: '2012-12-12T10:53:43-08:00' created_by: allOf: - $ref: '#/components/schemas/User--Mini' - description: The user who created this web link modified_by: allOf: - $ref: '#/components/schemas/User--Mini' - description: The user who last modified this web link owned_by: allOf: - $ref: '#/components/schemas/User--Mini' - description: The user who owns this web link shared_link: type: string description: >- The shared link for this bookmark. This will be `null` if a bookmark has been trashed, since the link will no longer be active. example: nullable: true item_status: type: string example: trashed enum: - active - trashed - deleted description: |- Whether this item is deleted or not. Values include `active`, `trashed` if the file has been moved to the trash, and `deleted` if the file has been permanently deleted tags: - name: Web Links