Commit upload session - Box Dev Docs

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

digest

string

required

The RFC3230 message digest of the whole file.

Only SHA1 is supported. The SHA1 digest must be Base64 encoded. The format of this header is as sha=BASE64_ENCODED_DIGEST.

if-match

string

Ensures this item hasn't recently changed before making changes.

Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.

if-none-match

string

Ensures an item is only returned if it has changed.

Pass in the item's last observed etag value into this header and the endpoint will fail with a 304 Not Modified if the item has not changed since.

Path Parameters

upload_session_id

string

required

The ID of the upload session.

Body

application/json

parts

Upload part · object[]

required

The list details for the uploaded parts.

Show child attributes

parts.part_id

string

The unique ID of the chunk.

Example:

"6F2D3486"

parts.offset

integer<int64>

The offset of the chunk within the file in bytes. The lower bound of the position of the chunk within the file.

Example:

16777216

parts.size

integer<int64>

The size of the chunk in bytes.

Example:

3222784

parts.sha1

string

The SHA1 hash of the chunk.

Example:

"134b65991ed521fcfe4724b7d814ab8ded5185dc"

Response

Returns the file object in a list.

A list of files.

total_count

integer<int64>

The number of files.

Example:

1

entries

File (Full) · object[]

A list of files.

Show child attributes

entries.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.

Example:

"12345"

entries.type

enum<string>

required

The value will always be file.

Available options:

file

Example:

"file"

entries.etag

string | null

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.

Example:

"1"

entries.sequence_id

string | null

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.

Example:

"3"

entries.name

string

The name of the file.

Example:

"Contract.pdf"

entries.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.

Example:

"85136C79CBF9FE36BB9D05D0639C70C265C18D37"

entries.file_version

File version (Mini) · object

The information about the current version of the file.

Show child attributes

entries.file_version.id

string

required

The unique identifier that represent a file version.

Example:

"12345"

entries.file_version.type

enum<string>

required

The value will always be file_version.

Available options:

file_version

Example:

"file_version"

entries.file_version.sha1

string

The SHA1 hash of this version of the file.

Example:

"134b65991ed521fcfe4724b7d814ab8ded5185dc"

entries.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.

Maximum string length: 255

Example:

"Contract for Q1 renewal"

entries.size

integer

The file size in bytes. Be careful parsing this integer as it can get very large and cause an integer overflow.

Example:

629644

entries.path_collection

Path collection · object

The tree of folders that this file is contained in, starting at the root.

Show child attributes

entries.path_collection.total_count

integer<int64>

required

The number of folders in this list.

Example:

1

entries.path_collection.entries

Folder (Mini) · object[]

required

The parent folders for this item.

Show child attributes

entries.path_collection.entries.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.

Example:

"12345"

entries.path_collection.entries.type

enum<string>

required

The value will always be folder.

Available options:

folder

Example:

"folder"

entries.path_collection.entries.etag

string | null

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.

Example:

"1"

entries.path_collection.entries.sequence_id

string | null

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.

Example:

"3"

entries.path_collection.entries.name

string

The name of the folder.

Example:

"Contracts"

entries.created_at

string<date-time>

The date and time when the file was created on Box.

Example:

"2012-12-12T10:53:43-08:00"

entries.modified_at

string<date-time>

The date and time when the file was last updated on Box.

Example:

"2012-12-12T10:53:43-08:00"

entries.trashed_at

string<date-time> | null

The time at which this file was put in the trash.

Example:

"2012-12-12T10:53:43-08:00"

entries.purged_at

string<date-time> | null

The time at which this file is expected to be purged from the trash.

Example:

"2012-12-12T10:53:43-08:00"

entries.content_created_at

string<date-time> | null

The date and time at which this file was originally created, which might be before it was uploaded to Box.

Example:

"2012-12-12T10:53:43-08:00"

entries.content_modified_at

string<date-time> | null

The date and time at which this file was last updated, which might be before it was uploaded to Box.

Example:

"2012-12-12T10:53:43-08:00"

entries.created_by

User (Mini) · object

The user who created this file.

Show child attributes

entries.created_by.id

string

required

The unique identifier for this user.

Example:

"11446498"

entries.created_by.type

enum<string>

required

The value will always be user.

Available options:

user

Example:

"user"

entries.created_by.name

string

The display name of this user.

Maximum string length: 50

Example:

"Aaron Levie"

The primary email address of this user.

Example:

"ceo@example.com"

entries.modified_by

User (Mini) · object

The user who last modified this file.

Show child attributes

entries.modified_by.id

string

required

The unique identifier for this user.

Example:

"11446498"

entries.modified_by.type

enum<string>

required

The value will always be user.

Available options:

user

Example:

"user"

entries.modified_by.name

string

The display name of this user.

Maximum string length: 50

Example:

"Aaron Levie"

The primary email address of this user.

Example:

"ceo@example.com"

entries.owned_by

User (Mini) · object

The user who owns this file.

Show child attributes

entries.owned_by.id

string

required

The unique identifier for this user.

Example:

"11446498"

entries.owned_by.type

enum<string>

required

The value will always be user.

Available options:

user

Example:

"user"

entries.owned_by.name

string

The display name of this user.

Maximum string length: 50

Example:

"Aaron Levie"

The primary email address of this user.

Example:

"ceo@example.com"

entries.shared_link

Shared link · object

The shared link for this file. This value will be null if no shared link has been created for this file.

Show child attributes

entries.shared_link.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.

Example:

"https://www.box.com/s/vspke7y05sb214wjokpk"

entries.shared_link.effective_access

enum<string>

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.

Available options:

open,

company,

collaborators

Example:

"company"

entries.shared_link.effective_permission

enum<string>

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.

Available options:

can_edit,

can_download,

can_preview,

no_access

Example:

"can_download"

entries.shared_link.is_password_enabled

boolean

required

Defines if the shared link requires a password to access the item.

Example:

true

entries.shared_link.download_count

integer

required

The number of times this item has been downloaded.

Example:

3

entries.shared_link.preview_count

integer

required

The number of times this item has been previewed.

Example:

3

entries.shared_link.download_url

string<url> | null

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"

entries.shared_link.vanity_url

string<url> | null

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/"

entries.shared_link.vanity_name

string | null

The custom name of a shared link, as used in the vanity_url field.

Example:

"my_url"

entries.shared_link.access

enum<string>

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.

Available options:

open,

company,

collaborators

Example:

"open"

entries.shared_link.unshared_at

string<date-time> | null

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"

entries.shared_link.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.

Show child attributes

entries.shared_link.permissions.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.

Example:

true

entries.shared_link.permissions.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.

Example:

true

entries.shared_link.permissions.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.

Example:

false

entries.parent

Folder (Mini) · object

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.

Show child attributes

entries.parent.id

string

required

The unique identifier that represent a folder.

Example:

"12345"

entries.parent.type

enum<string>

required

The value will always be folder.

Available options:

folder

Example:

"folder"

entries.parent.etag

string | null

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.

Example:

"1"

entries.parent.sequence_id

string | null

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.

Example:

"3"

entries.parent.name

string

The name of the folder.

Example:

"Contracts"

entries.item_status

enum<string>

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.

Available options:

active,

trashed,

deleted

Example:

"active"

entries.version_number

string

The version number of this file.

Example:

"1"

entries.comment_count

integer

The number of comments on this file.

Example:

10

entries.permissions

object

Describes the permissions that the current user has for this file.

Show child attributes

entries.permissions.can_delete

boolean

required

Specifies if the current user can delete this item.

Example:

true

entries.permissions.can_download

boolean

required

Specifies if the current user can download this item.

Example:

true

entries.permissions.can_invite_collaborator

boolean

required

Specifies if the current user can invite new users to collaborate on this item, and if the user can update the role of a user already collaborated on this item.

Example:

true

entries.permissions.can_rename

boolean

required

Specifies if the user can rename this item.

Example:

true

Specifies if the user can change the access level of an existing shared link on this item.

Example:

true

Specifies if the user can create a shared link for this item.

Example:

true

entries.permissions.can_annotate

boolean

required

Specifies if the user can place annotations on this file.

Example:

true

entries.permissions.can_comment

boolean

required

Specifies if the user can place comments on this file.

Example:

true

entries.permissions.can_preview

boolean

required

Specifies if the user can preview this file.

Example:

true

entries.permissions.can_upload

boolean

required

Specifies if the user can upload a new version of this file.

Example:

true

entries.permissions.can_view_annotations_all

boolean

required

Specifies if the user view all annotations placed on this file.

Example:

true

entries.permissions.can_view_annotations_self

boolean

required

Specifies if the user view annotations placed by themselves on this file.

Example:

true

entries.tags

string[]

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.

Required array length: 1 - 100 elements

Example:

["approved"]

entries.lock

Lock · object

The lock held on this file. If there is no lock, this can either be null or have a timestamp in the past.

Show child attributes

entries.lock.id

string

The unique identifier for this lock.

Example:

"11446498"

entries.lock.type

enum<string>

The value will always be lock.

Available options:

lock

Example:

"lock"

entries.lock.created_by

User (Mini) · object

The user who created the lock.

Show child attributes

entries.lock.created_by.id

string

required

The unique identifier for this user.

Example:

"11446498"

entries.lock.created_by.type

enum<string>

required

The value will always be user.

Available options:

user

Example:

"user"

entries.lock.created_by.name

string

The display name of this user.

Maximum string length: 50

Example:

"Aaron Levie"

The primary email address of this user.

Example:

"ceo@example.com"

entries.lock.created_at

string<date-time>

The time this lock was created at.

Example:

"2012-12-12T10:53:43-08:00"

entries.lock.expired_at

string<date-time>

The time this lock is to expire at, which might be in the past.

Example:

"2012-12-12T10:53:43-08:00"

entries.lock.is_download_prevented

boolean

Whether or not the file can be downloaded while locked.

Example:

true

entries.lock.app_type

enum<string> | null

If the lock is managed by an application rather than a user, this field identifies the type of the application that holds the lock. This is an open enum and may be extended with additional values in the future.

Available options:

gsuite,

office_wopi,

office_wopiplus,

other

Example:

"office_wopiplus"

entries.extension

string

Indicates the (optional) file extension for this file. By default, this is set to an empty string.

Example:

"pdf"

entries.is_package

boolean

Indicates if the file is a package. Packages are commonly used by Mac Applications and can include iWork files.

Example:

true

entries.expiring_embed_link

Expiring embed link · object

Requesting this field creates an expiring Box Embed URL for an embedded preview session in an iframe.

This URL will expire after 60 seconds and the session will expire after 60 minutes.

Not all file types are supported for these embed URLs. Box Embed is not optimized for mobile browsers and should not be used in web experiences designed for mobile devices. Many UI elements, like the download and print options might not show in mobile browsers.

Show child attributes

entries.expiring_embed_link.access_token

string<token>

The requested access token.

Example:

"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

entries.expiring_embed_link.expires_in

integer<int64>

The time in seconds by which this token will expire.

Example:

3600

entries.expiring_embed_link.token_type

enum<string>

The type of access token returned.

Available options:

bearer

Example:

"bearer"

entries.expiring_embed_link.restricted_to

Resource scope · object[]

The permissions that this access token permits, providing a list of resources (files, folders, etc) and the scopes permitted for each of those resources.

Show child attributes

entries.expiring_embed_link.restricted_to.scope

enum<string>

The scopes for the resource access.

Available options:

annotation_edit,

annotation_view_all,

annotation_view_self,

base_explorer,

base_picker,

base_preview,

base_upload,

item_delete,

item_download,

item_preview,

item_rename,

item_share,

item_upload,

item_read

Example:

"item_download"

entries.expiring_embed_link.restricted_to.object

Resource · object

The file or folder resource. A mini representation of a file version, used when nested under another resource. The bare basic representation of a folder, the minimal amount of fields returned when using the fields query parameter.

Resource
Resource

Show child attributes

entries.expiring_embed_link.restricted_to.object.id

string

required

The unique identifier that represent a folder.

Example:

"12345"

entries.expiring_embed_link.restricted_to.object.type

enum<string>

required

The value will always be folder.

Available options:

folder

Example:

"folder"

entries.expiring_embed_link.restricted_to.object.etag

string | null

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.

Example:

"1"

entries.expiring_embed_link.restricted_to.object.sequence_id

string | null

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.

Example:

"3"

entries.expiring_embed_link.restricted_to.object.name

string

The name of the folder.

Example:

"Contracts"

entries.expiring_embed_link.url

string<url>

The actual expiring embed URL for this file, constructed from the file ID and access tokens specified in this object.

Example:

"https://cloud.app.box.com/preview/expiring_embed/..."

entries.watermark_info

object

Details about the watermark applied to this file.

Show child attributes

entries.watermark_info.is_watermarked

boolean

Specifies if this item has a watermark applied.

Example:

true

entries.is_accessible_via_shared_link

boolean

Specifies if the file can be accessed via the direct shared link or a shared link to a parent folder.

Example:

true

entries.allowed_invitee_roles

enum<string>[]

A list of the types of roles that user can be invited at when sharing this file.

Available options:

editor,

viewer,

previewer,

uploader,

previewer uploader,

viewer uploader,

co-owner

Example:

["editor"]

entries.is_externally_owned

boolean

Specifies if this file is owned by a user outside of the authenticated enterprise.

Example:

true

entries.has_collaborations

boolean

Specifies if this file has any other collaborators.

Example:

true

entries.metadata

Item metadata instances · object

An object containing the metadata instances that have been attached to this file.

Each metadata instance is uniquely identified by its scope and templateKey. There can only be one instance of any metadata template attached to each file. 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.

Show child attributes

entries.metadata.{key}

object

A list of metadata instances, nested within key-value pairs of their scope and templateKey.

Show child attributes

entries.metadata.{key}.{key}

Metadata instance (Full) · object

An instance of a metadata template, which has been applied to a file or folder. An instance of a metadata template, which has been applied to a file or folder. The base representation of a metadata instance.

Show child attributes

entries.metadata.{key}.{key}.$parent

string

The identifier of the item that this metadata instance has been attached to. This combines the type and the id of the parent in the form {type}_{id}.

Example:

"folder_59449484661,"

entries.metadata.{key}.{key}.$template

string

The name of the template.

Example:

"marketingCollateral"

entries.metadata.{key}.{key}.$scope

string

An ID for the scope in which this template has been applied. This will be enterprise_{enterprise_id} for templates defined for use in this enterprise, and global for general templates that are available to all enterprises using Box.

Example:

"enterprise_27335"

entries.metadata.{key}.{key}.$version

integer

The version of the metadata instance. This version starts at 0 and increases every time a user-defined property is modified.

Example:

1

entries.metadata.{key}.{key}.$canEdit

boolean

Whether the user can edit this metadata instance.

Example:

true

entries.metadata.{key}.{key}.$id

string<uuid>

A UUID to identify the metadata instance.

Maximum string length: 36

Example:

"01234500-12f1-1234-aa12-b1d234cb567e"

entries.metadata.{key}.{key}.$type

string

A unique identifier for the "type" of this instance. This is an internal system property and should not be used by a client application.

Example:

"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0"

entries.metadata.{key}.{key}.$typeVersion

integer

The last-known version of the template of the object. This is an internal system property and should not be used by a client application.

Example:

2

entries.metadata.{key}.{key}.{key}

any

A value for each of the fields that are present on the metadata template. For the global.properties template this can be a list of zero or more fields, as this template allows for any generic key-value pairs to be stored stored in the template.

Example:

"Aaron Levie"

Example:

{
  "marketingCollateral": {
    "$canEdit": true,
    "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
    "$parent": "folder_59449484661",
    "$scope": "enterprise_27335",
    "$template": "marketingCollateral",
    "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
    "$typeVersion": 2,
    "$version": 1
  }
}

Example:

{
  "enterprise_27335": {
    "marketingCollateral": {
      "$canEdit": true,
      "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
      "$parent": "folder_59449484661",
      "$scope": "enterprise_27335",
      "$template": "marketingCollateral",
      "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
      "$typeVersion": 2,
      "$version": 1
    }
  }
}

entries.expires_at

string<date-time> | null

When the file will automatically be deleted.

Example:

"2012-12-12T10:53:43-08:00"

entries.representations

Representations · object

A list of representations for a file that can be used to display a placeholder of the file in your application. By default this returns all representations and we recommend using the x-rep-hints header to further customize the desired representations.

Show child attributes

entries.representations.entries

object[]

A list of files.

Show child attributes

entries.representations.entries.content

object

An object containing the URL that can be used to actually fetch the representation.

Show child attributes

entries.representations.entries.content.url_template

string

The download URL that can be used to fetch the representation. Make sure to make an authenticated API call to this endpoint.

This URL is a template and will require the {+asset_path} to be replaced by a path. In general, for unpaged representations it can be replaced by an empty string.

For paged representations, replace the {+asset_path} with the page to request plus the extension for the file, for example 1.pdf.

When requesting the download URL the following additional query params can be passed along.

set_content_disposition_type - Sets the Content-Disposition header in the API response with the specified disposition type of either inline or attachment. If not supplied, the Content-Disposition header is not included in the response.
set_content_disposition_filename - Allows the application to define the representation's file name used in the Content-Disposition header. If not defined, the filename is derived from the source file name in Box combined with the extension of the representation.

Example:

"https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567"

entries.representations.entries.info

object

An object containing the URL that can be used to fetch more info on this representation.

Show child attributes

entries.representations.entries.info.url

string

The API URL that can be used to get more info on this file representation. Make sure to make an authenticated API call to this endpoint.

Example:

"https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048"

entries.representations.entries.properties

object

An object containing the size and type of this presentation.

Show child attributes

entries.representations.entries.properties.dimensions

string<<width>x<height>>

The width by height size of this representation in pixels.

Example:

"2048x2048"

entries.representations.entries.properties.paged

string

Indicates if the representation is build up out of multiple pages.

Example:

"true"

entries.representations.entries.properties.thumb

string

Indicates if the representation can be used as a thumbnail of the file.

Example:

"true"

entries.representations.entries.representation

string

Indicates the file type of the returned representation.

Example:

"png"

entries.representations.entries.status

object

An object containing the status of this representation.

Show child attributes

entries.representations.entries.status.state

enum<string>

The status of the representation.

success defines the representation as ready to be viewed.
viewable defines a video to be ready for viewing.
pending defines the representation as to be generated. Retry this endpoint to re-check the status.
none defines that the representation will be created when requested. Request the URL defined in the info object to trigger this generation.

Available options:

success,

viewable,

pending,

none

Example:

"success"

entries.classification

object

Details about the classification applied to this file.

Show child attributes

entries.classification.name

string

The name of the classification.

Example:

"Top Secret"

entries.classification.definition

string

An explanation of the meaning of this classification.

Example:

"Content that should not be shared outside the company."

entries.classification.color

string

The color that is used to display the classification label in a user-interface. Colors are defined by the admin or co-admin who created the classification in the Box web app.

Example:

"#FF0000"

entries.uploader_display_name

string

The display name of the user that uploaded the file. In most cases this is the name of the user logged in at the time of the upload.

If the file was uploaded using a File Request form that requires the user to provide an email address, this field is populated with that email address. If an email address was not required in the File Request form, this field is set to return a value of File Request.

In all other anonymous cases where no email was provided this field will default to a value of Someone.

Example:

"Ellis Wiggins"

entries.disposition_at

string<date-time> | null

The retention expiration timestamp for the given file.

Example:

"2012-12-12T10:53:43-08:00"

entries.shared_link_permission_options

enum<string>[] | null

A list of the types of roles that user can be invited at when sharing this file.

Available options:

can_preview,

can_download,

can_edit

Example:

["can_preview"]

entries.is_associated_with_app_item

boolean

This field will return true if the file or any ancestor of the file 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 file.

Example:

true