String message
RequestInfo requestInfo
ResponseInfo responseInfo
DataSanitizer dataSanitizer
String clientId
String clientSecret
JwtConfigAppSettingsAppAuth appAuth
String enterpriseId
String userId
JwtConfigAppSettings boxAppSettings
Object value0
JsonNode rawData
long fileSize
String fileName
EnumWrapper<E extends Enum<E> & Valuable> op
EnumWrapper<E extends Enum<E> & Valuable> fieldKey
AddClassificationRequestBodyDataField data
String key
AddClassificationRequestBodyDataStaticConfigField staticConfig
String classificationDefinition
Long colorId
Mapping between a `colorID` and a color may change without notice. Currently, the color mappings are as follows.
* `0`: Yellow. * `1`: Orange. * `2`: Watermelon red. * `3`: Purple rain. * `4`: Light blue. * `5`: Dark blue. * `6`: Light green. * `7`: Gray.
AddClassificationRequestBodyDataStaticConfigClassificationField classification
EnumWrapper<E extends Enum<E> & Valuable> scope
EnumWrapper<E extends Enum<E> & Valuable> templateKey
EnumWrapper<E extends Enum<E> & Valuable> displayName
Boolean hidden
Boolean copyInstanceOnItemCopy
List<E> fields
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> key
EnumWrapper<E extends Enum<E> & Valuable> displayName
Boolean hidden
List<E> options
String key
CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField staticConfig
String classificationDefinition
Long colorId
Mapping between a `colorID` and a color may change without notice. Currently, the color mappings are as follows.
* `0`: Yellow. * `1`: Orange. * `2`: Watermelon red. * `3`: Purple rain. * `4`: Light blue. * `5`: Dark blue. * `6`: Light green. * `7`: Gray.
CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField classification
EnumWrapper<E extends Enum<E> & Valuable> op
EnumWrapper<E extends Enum<E> & Valuable> fieldKey
String enumOptionKey
UpdateClassificationRequestBodyDataField data
String key
UpdateClassificationRequestBodyDataStaticConfigField staticConfig
String classificationDefinition
Long colorId
Mapping between a `colorID` and a color may change without notice. Currently, the color mappings are as follows.
* `0`: Yellow. * `1`: Orange. * `2`: Watermelon red. * `3`: Purple rain. * `4`: Light blue. * `5`: Dark blue. * `6`: Light green. * `7`: Gray.
UpdateClassificationRequestBodyDataStaticConfigClassificationField classification
CreateCollaborationWhitelistExemptTargetRequestBodyUserField user
String id
String message
To mention a user, use the `tagged_message` parameter instead.
String taggedMessage
The `user_id` is the target user's ID, where the `name` can be any custom phrase. In the Box UI this name will link to the user's profile.
If you are not mentioning another user, use `message` instead.
CreateCommentRequestBodyItemField item
String message
String email
Note: The domain of the email alias needs to be registered to your enterprise. See the [domain verification guide]( https://support.box.com/hc/en-us/articles/4408619650579-Domain-Verification ) for steps to add a new domain.
String boxSecurityClassificationKey
To list the available classifications in an enterprise, use the classification API to retrieve the [classification template](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema) which lists all available classification keys.
EnumWrapper<E extends Enum<E> & Valuable> op
EnumWrapper<E extends Enum<E> & Valuable> path
String value
To list the available classifications in an enterprise, use the classification API to retrieve the [classification template](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema) which lists all available classification keys.
EnumWrapper<E extends Enum<E> & Valuable> op
String path
The path must always be prefixed with a `/` to represent the root of the template. The characters `~` and `/` are reserved characters and must be escaped in the key.
MetadataInstanceValue value
String from
String name
There are some restrictions to the file name. Names containing non-printable ASCII characters, forward and backward slashes (`/`, `\`), and protected names like `.` and `..` are automatically sanitized by removing the non-allowed characters.
String version
CopyFileRequestBodyParentField parent
String id
String name
File names must be unique within their parent folder. The name check is case-insensitive, so a file named `New File` cannot be created in a parent folder that already contains a folder named `new file`.
String description
UpdateFileByIdRequestBodyParentField parent
UpdateFileByIdRequestBodySharedLinkField sharedLink
UpdateFileByIdRequestBodyLockField lock
Set this to `null` to remove the lock.
OffsetDateTime dispositionAt
UpdateFileByIdRequestBodyPermissionsField permissions
List<E> collections
To get the ID for a collection, use the [List all collections][1] endpoint.
Passing an empty array `[]` or `null` will remove the file from all collections.
[1]: https://developer.box.com/reference/get-collections
List<E> tags
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.
EnumWrapper<E extends Enum<E> & Valuable> access
OffsetDateTime expiresAt
Boolean isDownloadPrevented
EnumWrapper<E extends Enum<E> & Valuable> canDownload
This setting overrides the download permissions that are normally part of the `role` of a collaboration. When set to `company`, this essentially removes the download option for external users with `viewer` or `editor` a roles.
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String password
String vanityName
Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
OffsetDateTime unsharedAt
UpdateFileByIdRequestBodySharedLinkPermissionsField permissions
Boolean canDownload
String trashedAt
UpdateFileWatermarkRequestBodyWatermarkField watermark
EnumWrapper<E extends Enum<E> & Valuable> imprint
Currently only supports one option.
String boxSecurityClassificationKey
To list the available classifications in an enterprise, use the classification API to retrieve the [classification template](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema) which lists all available classification keys.
EnumWrapper<E extends Enum<E> & Valuable> op
EnumWrapper<E extends Enum<E> & Valuable> path
String value
To list the available classifications in an enterprise, use the classification API to retrieve the [classification template](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema) which lists all available classification keys.
CreateFolderLockRequestBodyLockedOperationsField lockedOperations
CreateFolderLockRequestBodyFolderField folder
boolean move
boolean delete
EnumWrapper<E extends Enum<E> & Valuable> op
String path
The path must always be prefixed with a `/` to represent the root of the template. The characters `~` and `/` are reserved characters and must be escaped in the key.
MetadataInstanceValue value
String from
String name
There are some restrictions to the file name. Names containing non-printable ASCII characters, forward and backward slashes (`/`, `\`), as well as names with trailing spaces are prohibited.
Additionally, the names `.` and `..` are not allowed either.
CopyFolderRequestBodyParentField parent
String id
String name
The following restrictions to folder names apply: names containing non-printable ASCII characters, forward and backward slashes (`/`, `\`), names with trailing spaces, and names `.` and `..` are not allowed.
Folder names must be unique within their parent folder. The name check is case-insensitive, so a folder named `New Folder` cannot be created in a parent folder that already contains a folder named `new folder`.
CreateFolderRequestBodyParentField parent
CreateFolderRequestBodyFolderUploadEmailField folderUploadEmail
EnumWrapper<E extends Enum<E> & Valuable> syncState
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String id
String name
The following restrictions to folder names apply: names containing non-printable ASCII characters, forward and backward slashes (`/`, `\`), names with trailing spaces, and names `.` and `..` are not allowed.
Folder names must be unique within their parent folder. The name check is case-insensitive, so a folder named `New Folder` cannot be created in a parent folder that already contains a folder named `new folder`.
String description
EnumWrapper<E extends Enum<E> & Valuable> syncState
Boolean canNonOwnersInvite
UpdateFolderByIdRequestBodyParentField parent
UpdateFolderByIdRequestBodySharedLinkField sharedLink
UpdateFolderByIdRequestBodyFolderUploadEmailField folderUploadEmail
List<E> tags
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.
Boolean isCollaborationRestrictedToEnterprise
List<E> collections
To get the ID for a collection, use the [List all collections][1] endpoint.
Passing an empty array `[]` or `null` will remove the folder from all collections.
[1]: https://developer.box.com/reference/get-collections
Boolean canNonOwnersViewCollaborators
It also restricts non-owners from inviting new collaborators.
When setting this field to `false`, it is required to also set `can_non_owners_invite_collaborators` to `false` if it has not already been set.
EnumWrapper<E extends Enum<E> & Valuable> access
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.
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String password
String vanityName
Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
OffsetDateTime unsharedAt
UpdateFolderByIdRequestBodySharedLinkPermissionsField permissions
Boolean canDownload
UpdateFolderWatermarkRequestBodyWatermarkField watermark
EnumWrapper<E extends Enum<E> & Valuable> imprint
Currently only supports one option.
String name
String provenance
Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application.
This is desirable for one-way syncing of groups.
String externalSyncIdentifier
Example values of this field could be an **Active Directory Object ID** or a **Google Group ID**.
We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.
String description
EnumWrapper<E extends Enum<E> & Valuable> invitabilityLevel
When set to `admins_only` the enterprise admin, co-admins, and the group's admin can invite the group.
When set to `admins_and_members` all the admins listed above and group members can invite the group.
When set to `all_managed_users` all managed users in the enterprise can invite the group.
EnumWrapper<E extends Enum<E> & Valuable> memberViewabilityLevel
* `admins_only` - the enterprise admin, co-admins, group's group admin. * `admins_and_members` - all admins and group members. * `all_managed_users` - all managed users in the enterprise.
String name
String provenance
Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application.
This is desirable for one-way syncing of groups.
String externalSyncIdentifier
Example values of this field could be an **Active Directory Object ID** or a **Google Group ID**.
We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.
String description
EnumWrapper<E extends Enum<E> & Valuable> invitabilityLevel
When set to `admins_only` the enterprise admin, co-admins, and the group's admin can invite the group.
When set to `admins_and_members` all the admins listed above and group members can invite the group.
When set to `all_managed_users` all managed users in the enterprise can invite the group.
EnumWrapper<E extends Enum<E> & Valuable> memberViewabilityLevel
* `admins_only` - the enterprise admin, co-admins, group's group admin. * `admins_and_members` - all admins and group members. * `all_managed_users` - all managed users in the enterprise.
IntegrationMappingBoxItemSlack boxItem
IntegrationMappingSlackOptions options
FolderReference boxItem
CreateInviteRequestBodyEnterpriseField enterprise
CreateInviteRequestBodyActionableByField actionableBy
String login
String id
String policyName
String description
OffsetDateTime filterStartedAt
When this policy is applied using a `custodian` legal hold assignments, it will only apply to file versions created or uploaded inside of the date range. Other assignment types, such as folders and files, will ignore the date filter.
Required if `is_ongoing` is set to `false`.
OffsetDateTime filterEndedAt
When this policy is applied using a `custodian` legal hold assignments, it will only apply to file versions created or uploaded inside of the date range. Other assignment types, such as folders and files, will ignore the date filter.
Required if `is_ongoing` is set to `false`.
Boolean isOngoing
When this policy is applied using a legal hold assignment, it will continue applying the policy to any new file versions even after it has been applied.
For example, if a legal hold assignment is placed on a user today, and that user uploads a file tomorrow, that file will get held. This will continue until the policy is retired.
Required if no filter dates are set.
String policyId
CreateLegalHoldPolicyAssignmentRequestBodyAssignToField assignTo
CreateGroupMembershipRequestBodyUserField user
CreateGroupMembershipRequestBodyGroupField group
EnumWrapper<E extends Enum<E> & Valuable> role
Map<K,V> configurablePermissions
Setting these permissions overwrites the default access levels of an admin.
Specifying a value of `null` for this object will disable all configurable permissions. Specifying permissions will set them accordingly, omitted permissions will be enabled by default.
String id
String id
EnumWrapper<E extends Enum<E> & Valuable> role
Map<K,V> configurablePermissions
Setting these permissions overwrites the default access levels of an admin.
Specifying a value of `null` for this object will disable all configurable permissions. Specifying permissions will set them accordingly, omitted permissions will be enabled by default.
EnumWrapper<E extends Enum<E> & Valuable> conflictResolution
* `none` will preserve the existing value on the file * `overwrite` will force-apply the templates values over any existing values.
String folderId
EnumWrapper<E extends Enum<E> & Valuable> scope
String templateKey
In many cases the template key is automatically derived of its display name, for example `Contract Template` would become `contractTemplate`. In some cases the creator of the template will have provided its own template key.
Please [list the templates for an enterprise][list], or get all instances on a [file][file] or [folder][folder] to inspect a template's key.
[list]: https://developer.box.com/reference/get-metadata-templates-enterprise [file]: https://developer.box.com/reference/get-files-id-metadata [folder]: https://developer.box.com/reference/get-folders-id-metadata
String key
String displayName
String namespace
String displayName
String displayName
String scope
This value needs to be set to `enterprise`, as `global` scopes can not be created by applications.
String templateKey
When not provided, the API will create a unique `templateKey` based on the value of the `displayName`.
String displayName
Boolean hidden
List<E> fields
Boolean copyInstanceOnItemCopy
EnumWrapper<E extends Enum<E> & Valuable> type
Additionally, metadata templates support an `enum` field for a basic list of items, and ` multiSelect` field for a similar list of items where the user can select more than one value.
Metadata taxonomies are also supported as a `taxonomy` field type with a specific set of additional properties, which describe its structure.
String key
String displayName
String description
Boolean hidden
List<E> options
String taxonomyKey
String namespace
CreateMetadataTemplateRequestBodyFieldsOptionsRulesField optionsRules
String key
EnumWrapper<E extends Enum<E> & Valuable> op
Map<K,V> data
String fieldKey
List<E> fieldKeys
String enumOptionKey
List<E> enumOptionKeys
String multiSelectOptionKey
List<E> multiSelectOptionKeys
String policyName
String description
EnumWrapper<E extends Enum<E> & Valuable> policyType
EnumWrapper<E extends Enum<E> & Valuable> dispositionAction
CreateRetentionPolicyRequestBodyRetentionLengthField retentionLength
EnumWrapper<E extends Enum<E> & Valuable> retentionType
* `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes.
* `non_modifiable`: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies.
Boolean canOwnerExtendRetention
RetentionPolicyMaxExtensionLengthRequest maxExtensionLength
Boolean areOwnersNotified
List<E> customNotificationRecipients
String policyName
String description
String dispositionAction
String retentionType
* `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes. * `non-modifiable`: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies.
When updating a retention policy, you can use `non-modifiable` type only. You can convert a `modifiable` policy to `non-modifiable`, but not the other way around.
UpdateRetentionPolicyByIdRequestBodyRetentionLengthField retentionLength
String status
If not retiring a policy, do not include this parameter or set it to `null`.
Boolean canOwnerExtendRetention
RetentionPolicyMaxExtensionLengthRequest maxExtensionLength
Boolean areOwnersNotified
List<E> customNotificationRecipients
String policyId
CreateRetentionPolicyAssignmentRequestBodyAssignToField assignTo
List<E> filterFields
String startDateField
If the `assigned_to` type is `metadata_template`, this field can be a date field's metadata attribute key id.
AddShareLinkToFileRequestBodySharedLinkField sharedLink
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String password
String vanityName
Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
OffsetDateTime unsharedAt
AddShareLinkToFileRequestBodySharedLinkPermissionsField permissions
Boolean canDownload
Boolean canPreview
Boolean canEdit
RemoveSharedLinkFromFileRequestBodySharedLinkField sharedLink
UpdateSharedLinkOnFileRequestBodySharedLinkField sharedLink
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String password
String vanityName
Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
OffsetDateTime unsharedAt
UpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField permissions
Boolean canDownload
Boolean canPreview
Boolean canEdit
AddShareLinkToFolderRequestBodySharedLinkField sharedLink
Use an empty object (`{}`) to use the default settings for shared links.
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String password
String vanityName
Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
OffsetDateTime unsharedAt
AddShareLinkToFolderRequestBodySharedLinkPermissionsField permissions
Boolean canDownload
Boolean canPreview
Boolean canEdit
RemoveSharedLinkFromFolderRequestBodySharedLinkField sharedLink
UpdateSharedLinkOnFolderRequestBodySharedLinkField sharedLink
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String password
String vanityName
Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
OffsetDateTime unsharedAt
UpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField permissions
Boolean canDownload
Boolean canPreview
Boolean canEdit
AddShareLinkToWebLinkRequestBodySharedLinkField sharedLink
Use an empty object (`{}`) to use the default settings for shared links.
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String password
String vanityName
Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
OffsetDateTime unsharedAt
AddShareLinkToWebLinkRequestBodySharedLinkPermissionsField permissions
Boolean canDownload
Boolean canPreview
Boolean canEdit
RemoveSharedLinkFromWebLinkRequestBodySharedLinkField sharedLink
UpdateSharedLinkOnWebLinkRequestBodySharedLinkField sharedLink
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String password
String vanityName
Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
OffsetDateTime unsharedAt
UpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField permissions
Boolean canDownload
Boolean canPreview
Boolean canEdit
EnterpriseBase enterprise
EnumWrapper<E extends Enum<E> & Valuable> type
ShieldInformationBarrierBase shieldInformationBarrier
CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField shieldInformationBarrierSegment
UserBase user
EnumWrapper<E extends Enum<E> & Valuable> type
ShieldInformationBarrierBase shieldInformationBarrier
CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField shieldInformationBarrierSegment
CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField restrictedSegment
ShieldInformationBarrierBase shieldInformationBarrier
String name
String description
EnumWrapper<E extends Enum<E> & Valuable> status
UpdateAllSkillCardsOnFileRequestBodyMetadataField metadata
UpdateAllSkillCardsOnFileRequestBodyFileField file
UpdateAllSkillCardsOnFileRequestBodyFileVersionField fileVersion
UpdateAllSkillCardsOnFileRequestBodyUsageField usage
Set this to the default values when setting a card to a `success` state, and leave it out in most other situations.
EnumWrapper<E extends Enum<E> & Valuable> op
String path
SkillCard value
CreateStoragePolicyAssignmentRequestBodyStoragePolicyField storagePolicy
CreateStoragePolicyAssignmentRequestBodyAssignedToField assignedTo
UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField storagePolicy
CreateTaskAssignmentRequestBodyTaskField task
CreateTaskAssignmentRequestBodyAssignToField assignTo
String message
EnumWrapper<E extends Enum<E> & Valuable> resolutionState
* For a task with an `action` value of `complete` this can be `incomplete` or `completed`. * For a task with an `action` of `review` this can be `incomplete`, `approved`, or `rejected`.
CreateTaskRequestBodyItemField item
EnumWrapper<E extends Enum<E> & Valuable> action
* `review` defines an approval task that can be approved or, rejected * `complete` defines a general task which can be completed.
String message
OffsetDateTime dueAt
EnumWrapper<E extends Enum<E> & Valuable> completionRule
* `all_assignees` (default) requires all assignees to review or approve the task in order for it to be considered completed. * `any_assignee` accepts any one assignee to review or approve the task in order for it to be considered completed.
EnumWrapper<E extends Enum<E> & Valuable> action
* `review` defines an approval task that can be approved or rejected, * `complete` defines a general task which can be completed.
String message
OffsetDateTime dueAt
EnumWrapper<E extends Enum<E> & Valuable> completionRule
* `all_assignees` (default) requires all assignees to review or approve the task in order for it to be considered completed. * `any_assignee` accepts any one assignee to review or approve the task in order for it to be considered completed.
EnumWrapper<E extends Enum<E> & Valuable> status
EnumWrapper<E extends Enum<E> & Valuable> tosType
String text
The text can be set to empty if the `status` is set to `disabled`.
CreateTermsOfServiceStatusForUserRequestBodyTosField tos
CreateTermsOfServiceStatusForUserRequestBodyUserField user
boolean isAccepted
boolean isAccepted
TransferOwnedFolderRequestBodyOwnedByField ownedBy
String id
String name
RestoreFileFromTrashRequestBodyParentField parent
String id
String name
RestoreFolderFromTrashRequestBodyParentField parent
String id
String name
RestoreWeblinkFromTrashRequestBodyParentField parent
String id
String name
Integer size
PreflightFileUploadCheckRequestBodyParentField parent
String id
String name
File names must be unique within their parent folder. The name check is case-insensitive, so a file named `New File` cannot be created in a parent folder that already contains a folder named `new file`.
UploadFileRequestBodyAttributesParentField parent
OffsetDateTime contentCreatedAt
If not set, the upload time will be used.
OffsetDateTime contentModifiedAt
If not set, the upload time will be used.
String id
String name
OffsetDateTime contentModifiedAt
If not set, the upload time will be used.
String name
File names must be unique within their parent folder. The name check is case-insensitive, so a file named `New File` cannot be created in a parent folder that already contains a folder named `new file`.
UploadWithPreflightCheckRequestBodyAttributesParentField parent
OffsetDateTime contentCreatedAt
If not set, the upload time will be used.
OffsetDateTime contentModifiedAt
If not set, the upload time will be used.
int size
String id
CreateCollaborationRequestBodyItemField item
CreateCollaborationRequestBodyAccessibleByField accessibleBy
EnumWrapper<E extends Enum<E> & Valuable> role
Boolean isAccessOnly
Boolean canViewPath
Be aware that this meaningfully increases the time required to load the invitee's **All Files** page. We recommend you limit the number of collaborations with `can_view_path` enabled to 1,000 per user.
Only an owner or co-owners can invite collaborators with a `can_view_path` of `true`. Only an owner can update `can_view_path` on existing collaborations.
`can_view_path` can only be used for folder collaborations.
When you delete a folder with `can_view_path=true`, collaborators may still see the parent path. For instructions on how to remove this, see [Even though a folder invited via can_view_path is deleted, the path remains displayed](https://support.box.com/hc/en-us/articles/37472814319891-Even-though-a-folder-invited-via-can-view-path-is-deleted-the-path-remains-displayed).
OffsetDateTime expiresAt
This feature will only work if the **Automatically remove invited collaborators: Allow folder owners to extend the expiry date** setting has been enabled in the **Enterprise Settings** of the **Admin Console**. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error.
EnumWrapper<E extends Enum<E> & Valuable> type
String id
Alternatively, use `login` to specify a user by email address.
String login
Alternatively, use `id` to specify a user by user ID.
EnumWrapper<E extends Enum<E> & Valuable> role
EnumWrapper<E extends Enum<E> & Valuable> status
OffsetDateTime expiresAt
This feature will only work if the **Automatically remove invited collaborators: Allow folder owners to extend the expiry date** setting has been enabled in the **Enterprise Settings** of the **Admin Console**. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error.
Additionally, a collaboration can only be given an expiration if it was created after the **Automatically remove invited collaborator** setting was enabled.
Boolean canViewPath
Be aware that this meaningfully increases the time required to load the invitee's **All Files** page. We recommend you limit the number of collaborations with `can_view_path` enabled to 1,000 per user.
Only an owner or co-owners can invite collaborators with a `can_view_path` of `true`. Only an owner can update `can_view_path` on existing collaborations.
`can_view_path` can only be used for folder collaborations.
When you delete a folder with `can_view_path=true`, collaborators may still see the parent path. For instructions on how to remove this, see [Even though a folder invited via can_view_path is deleted, the path remains displayed](https://support.box.com/hc/en-us/articles/37472814319891-Even-though-a-folder-invited-via-can-view-path-is-deleted-the-path-remains-displayed).
String name
String login
Required, unless `is_platform_access_only` is set to `true`.
Boolean isPlatformAccessOnly
EnumWrapper<E extends Enum<E> & Valuable> role
String language
Boolean isSyncEnabled
String jobTitle
String phone
String address
Long spaceAmount
List<E> trackingCodes
Boolean canSeeManagedUsers
String timezone
Boolean isExternalCollabRestricted
Boolean isExemptFromDeviceLimits
Boolean isExemptFromLoginVerification
EnumWrapper<E extends Enum<E> & Valuable> status
String externalAppUserId
String enterprise
Boolean notify
String name
String login
Note: If the target user's email is not confirmed, then the primary login address cannot be changed.
EnumWrapper<E extends Enum<E> & Valuable> role
String language
Boolean isSyncEnabled
String jobTitle
String phone
String address
List<E> trackingCodes
Boolean canSeeManagedUsers
String timezone
Boolean isExternalCollabRestricted
Boolean isExemptFromDeviceLimits
Boolean isExemptFromLoginVerification
Boolean isPasswordResetRequired
EnumWrapper<E extends Enum<E> & Valuable> status
Long spaceAmount
UpdateUserByIdRequestBodyNotificationEmailField notificationEmail
Set this value to `null` to remove the notification email.
String externalAppUserId
Note: In order to update this field, you need to request a token using the application that created the app user.
String email
CreateWebhookRequestBodyTargetField target
String address
List<E> triggers
UpdateWebhookByIdRequestBodyTargetField target
String address
List<E> triggers
String url
CreateWebLinkRequestBodyParentField parent
String name
String description
String id
String url
UpdateWebLinkByIdRequestBodyParentField parent
String name
String description
UpdateWebLinkByIdRequestBodySharedLinkField sharedLink
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String password
String vanityName
Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.
OffsetDateTime unsharedAt
EnumWrapper<E extends Enum<E> & Valuable> type
StartWorkflowRequestBodyFlowField flow
List<E> files
StartWorkflowRequestBodyFolderField folder
List<E> outcomes
String accessToken
Long expiresIn
EnumWrapper<E extends Enum<E> & Valuable> tokenType
List<E> restrictedTo
String refreshToken
EnumWrapper<E extends Enum<E> & Valuable> issuedTokenType
String type
EnumWrapper<E extends Enum<E> & Valuable> type
AiAgentLongTextTool longText
AiAgentBasicTextTool basicText
AiAgentSpreadsheetTool spreadsheet
AiAgentLongTextTool longTextMulti
AiAgentBasicTextTool basicTextMulti
AiAgentBasicTextTool basicImage
AiAgentBasicTextTool basicImageMulti
String contentTemplate
String systemMessage
String promptTemplate
String model
Long numTokensForCompletion
AiLlmEndpointParams llmEndpointParams
String systemMessage
String promptTemplate
When using the `prompt_template` parameter, you **must include** input for `{user_question}`. Inputs for `{current_date}` and `{content}` are optional, depending on the use.
EnumWrapper<E extends Enum<E> & Valuable> type
AiAgentLongTextTool longText
AiAgentBasicTextTool basicText
AiAgentBasicTextTool basicImage
EnumWrapper<E extends Enum<E> & Valuable> type
AiAgentLongTextTool longText
AiAgentBasicTextTool basicText
AiAgentBasicTextTool basicImage
AiAgentLongTextToolEmbeddingsField embeddings
String model
AiAgentLongTextToolEmbeddingsStrategyField strategy
AiAgentLongTextToolTextGenEmbeddingsField embeddings
String model
AiAgentLongTextToolTextGenEmbeddingsStrategyField strategy
EnumWrapper<E extends Enum<E> & Valuable> type
String id
String model
Long numTokensForCompletion
AiLlmEndpointParams llmEndpointParams
EnumWrapper<E extends Enum<E> & Valuable> type
AiAgentBasicGenTool basicGen
EnumWrapper<E extends Enum<E> & Valuable> mode
String prompt
List<E> items
List<E> dialogueHistory
Boolean includeCitations
AiAskAgent aiAgent
String type
String prompt
String answer
OffsetDateTime createdAt
String prompt
List<E> items
AiExtractAgent aiAgent
String type
List<E> items
AiExtractStructuredMetadataTemplateField metadataTemplate
List<E> fields
AiExtractStructuredAgent aiAgent
Boolean includeConfidenceScore
Boolean includeReference
String key
String description
String displayName
String prompt
String type
List<E> options
String key
String templateKey
EnumWrapper<E extends Enum<E> & Valuable> type
String scope
String type
Map<K,V> answer
OffsetDateTime createdAt
String completionReason
Map<K,V> confidenceScore
Map<K,V> reference
AiAgentInfo aiAgentInfo
EnumWrapper<E extends Enum<E> & Valuable> type
Double temperature
Double topP
EnumWrapper<E extends Enum<E> & Valuable> type
Double temperature
Double topP
Double topK
EnumWrapper<E extends Enum<E> & Valuable> type
Double temperature
Double topP
Double topK
EnumWrapper<E extends Enum<E> & Valuable> type
Double temperature
Double topP
Double frequencyPenalty
Double presencePenalty
String stop
Long limit
String nextMarker
String prevMarker
List<E> entries
String answer
OffsetDateTime createdAt
String completionReason
AiAgentInfo aiAgentInfo
String id
EnumWrapper<E extends Enum<E> & Valuable> type
String origin
String name
String accessState
UserBase createdBy
OffsetDateTime createdAt
UserBase modifiedBy
OffsetDateTime modifiedAt
String iconReference
List<E> allowedEntities
AiStudioAgentAskResponse ask
AiStudioAgentTextGenResponse textGen
AiStudioAgentExtractResponse extract
EnumWrapper<E extends Enum<E> & Valuable> type
String accessState
String description
String customInstructions
List<E> suggestedQuestions
AiStudioAgentLongTextTool longText
AiStudioAgentBasicTextTool basicText
AiStudioAgentBasicTextTool basicImage
AiStudioAgentSpreadsheetTool spreadsheet
AiStudioAgentLongTextTool longTextMulti
AiStudioAgentBasicTextTool basicTextMulti
AiStudioAgentBasicTextTool basicImageMulti
EnumWrapper<E extends Enum<E> & Valuable> type
String accessState
String description
String customInstructions
List<E> suggestedQuestions
AiStudioAgentLongTextToolResponse longText
AiStudioAgentBasicTextToolResponse basicText
AiStudioAgentBasicTextToolResponse basicImage
AiStudioAgentSpreadsheetToolResponse spreadsheet
AiStudioAgentLongTextToolResponse longTextMulti
AiStudioAgentBasicTextToolResponse basicTextMulti
AiStudioAgentBasicTextToolResponse basicImageMulti
Boolean isCustomInstructionsIncluded
Boolean isCustomInstructionsIncluded
EnumWrapper<E extends Enum<E> & Valuable> type
String accessState
String description
String customInstructions
AiStudioAgentLongTextTool longText
AiStudioAgentBasicTextTool basicText
AiStudioAgentBasicTextTool basicImage
EnumWrapper<E extends Enum<E> & Valuable> type
String accessState
String description
String customInstructions
AiStudioAgentLongTextToolResponse longText
AiStudioAgentBasicTextToolResponse basicText
AiStudioAgentBasicTextToolResponse basicImage
Boolean isCustomInstructionsIncluded
EnumWrapper<E extends Enum<E> & Valuable> type
String accessState
String description
String customInstructions
List<E> suggestedQuestions
AiStudioAgentBasicGenTool basicGen
EnumWrapper<E extends Enum<E> & Valuable> type
String accessState
String description
String customInstructions
List<E> suggestedQuestions
AiStudioAgentBasicGenToolResponse basicGen
String prompt
List<E> items
**Note**: Box AI handles documents with text representations up to 1MB in size. If the file size exceeds 1MB, the first 1MB of text representation will be processed.
List<E> dialogueHistory
AiTextGenAgent aiAgent
String type
String id
EnumWrapper<E extends Enum<E> & Valuable> type
AppItem appItem
AppItemAssociatedItem item
Long limit
String nextMarker
String prevMarker
List<E> entries
String boxSecurityClassificationKey
String parent
EnumWrapper<E extends Enum<E> & Valuable> template
String scope
This will be in the format `enterprise_{enterprise_id}`.
Long version
String type
Double typeVersion
Boolean canEdit
String id
EnumWrapper<E extends Enum<E> & Valuable> type
String scope
EnumWrapper<E extends Enum<E> & Valuable> templateKey
EnumWrapper<E extends Enum<E> & Valuable> displayName
Boolean hidden
Boolean copyInstanceOnItemCopy
List<E> fields
String id
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> key
EnumWrapper<E extends Enum<E> & Valuable> displayName
Boolean hidden
List<E> options
String id
String key
ClassificationTemplateFieldsOptionsStaticConfigField staticConfig
String classificationDefinition
Long colorId
Mapping between a `colorID` and a color may change without notice. Currently, the color mappings are as follows.
* `0`: Yellow. * `1`: Orange. * `2`: Watermelon red. * `3`: Purple rain. * `4`: Light blue. * `5`: Dark blue. * `6`: Light green. * `7`: Gray.
ClassificationTemplateFieldsOptionsStaticConfigClassificationField classification
This is not an exclusive list of properties, and more object fields might be returned. These fields are used for internal Box Shield and Box Governance purposes and no additional value must be derived from these fields.
EnumWrapper<E extends Enum<E> & Valuable> type
Integer status
EnumWrapper<E extends Enum<E> & Valuable> code
String message
Map<K,V> contextInfo
String helpUrl
String requestId
String id
EnumWrapper<E extends Enum<E> & Valuable> type
CollaborationItem item
AppItem appItem
CollaborationAccessGrantee accessibleBy
String inviteEmail
EnumWrapper<E extends Enum<E> & Valuable> role
OffsetDateTime expiresAt
Boolean isAccessOnly
EnumWrapper<E extends Enum<E> & Valuable> status
OffsetDateTime acknowledgedAt
UserCollaborations createdBy
OffsetDateTime createdAt
OffsetDateTime modifiedAt
CollaborationAcceptanceRequirementsStatusField acceptanceRequirementsStatus
CollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField termsOfServiceRequirement
CollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField strongPasswordRequirement
CollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField twoFactorAuthenticationRequirement
Boolean enterpriseHasStrongPasswordRequiredForExternalUsers
Boolean userHasStrongPassword
Boolean isAccepted
TermsOfServiceBase termsOfService
Boolean enterpriseHasTwoFactorAuthEnabled
Boolean userHasTwoFactorAuthenticationEnabled
Long limit
String nextMarker
String prevMarker
List<E> entries
String id
EnumWrapper<E extends Enum<E> & Valuable> type
String domain
EnumWrapper<E extends Enum<E> & Valuable> direction
CollaborationAllowlistEntryEnterpriseField enterprise
OffsetDateTime createdAt
String id
EnumWrapper<E extends Enum<E> & Valuable> type
CollaborationAllowlistExemptTargetEnterpriseField enterprise
UserMini user
OffsetDateTime createdAt
OffsetDateTime modifiedAt
Long limit
String nextMarker
String prevMarker
List<E> entries
String description
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime trashedAt
OffsetDateTime purgedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
FolderMini parent
String itemStatus
String sequenceId
String name
String id
String etag
String type
Long limit
String nextMarker
String prevMarker
List<E> entries
Long totalCount
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
Long limit
Long offset
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> entries
String id
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> name
EnumWrapper<E extends Enum<E> & Valuable> collectionType
Long totalCount
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
Long limit
Long offset
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> order
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> entries
Boolean isReplyComment
String message
UserMini createdBy
OffsetDateTime createdAt
OffsetDateTime modifiedAt
CommentItemField item
String taggedMessage
Long totalCount
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
Long limit
Long offset
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> order
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> entries
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> variableType
EnumWrapper<E extends Enum<E> & Valuable> variableValue
EnumWrapper<E extends Enum<E> & Valuable> type
String name
String accessState
String iconReference
List<E> allowedEntities
AiStudioAgentAsk ask
AiStudioAgentTextGen textGen
AiStudioAgentExtract extract
List<E> entries
Long limit
Long nextMarker
List<E> order
EnumWrapper<E extends Enum<E> & Valuable> by
EnumWrapper<E extends Enum<E> & Valuable> direction
String type
OffsetDateTime createdAt
OffsetDateTime recordedAt
String eventId
UserMini createdBy
EnumWrapper<E extends Enum<E> & Valuable> eventType
String sessionId
EventSourceResource source
Map<K,V> additionalDetails
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.
Long chunkSize
EventsNextStreamPositionField nextStreamPosition
List<E> entries
EnumWrapper<E extends Enum<E> & Valuable> itemType
String itemId
String itemName
EventSourceClassificationField classification
FolderMini parent
UserMini ownedBy
String name
String description
Long size
FilePathCollectionField pathCollection
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime trashedAt
OffsetDateTime purgedAt
OffsetDateTime contentCreatedAt
OffsetDateTime contentModifiedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
FileSharedLinkField sharedLink
FolderMini parent
EnumWrapper<E extends Enum<E> & Valuable> itemStatus
* `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.
String url
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.
String downloadUrl
This property will be `null` for folders.
String vanityUrl
String vanityName
EnumWrapper<E extends Enum<E> & Valuable> access
* `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.
EnumWrapper<E extends Enum<E> & Valuable> effectiveAccess
EnumWrapper<E extends Enum<E> & Valuable> effectivePermission
OffsetDateTime unsharedAt
boolean isPasswordEnabled
FileSharedLinkPermissionsField permissions
long downloadCount
long previewCount
boolean canDownload
This value can be set to `true` when the effective access level is set to `open` or `company`, not `collaborators`.
boolean canPreview
This value is always `true`. For shared links on folders this also applies to any items in the folder.
boolean canEdit
This value can only be `true` if `can_download` is also `true` and if the item has a type of `file`.
String id
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`.
String etag
EnumWrapper<E extends Enum<E> & Valuable> type
String versionNumber
Long commentCount
FileFullPermissionsField permissions
List<E> tags
FileFullLockField lock
String extension
Boolean isPackage
FileFullExpiringEmbedLinkField expiringEmbedLink
FileFullWatermarkInfoField watermarkInfo
Boolean isAccessibleViaSharedLink
List<E> allowedInviteeRoles
Boolean isExternallyOwned
Boolean hasCollaborations
FileFullMetadataField metadata
OffsetDateTime expiresAt
FileFullRepresentationsField representations
FileFullClassificationField classification
String uploaderDisplayName
OffsetDateTime dispositionAt
List<E> sharedLinkPermissionOptions
Boolean isAssociatedWithAppItem
String name
String definition
String color
String accessToken
Long expiresIn
EnumWrapper<E extends Enum<E> & Valuable> tokenType
List<E> restrictedTo
String url
String id
EnumWrapper<E extends Enum<E> & Valuable> type
UserMini createdBy
OffsetDateTime createdAt
OffsetDateTime expiredAt
Boolean isDownloadPrevented
EnumWrapper<E extends Enum<E> & Valuable> appType
boolean canDelete
boolean canDownload
boolean canInviteCollaborator
boolean canRename
boolean canSetShareAccess
boolean canShare
boolean canAnnotate
boolean canComment
boolean canPreview
boolean canUpload
boolean canViewAnnotationsAll
boolean canViewAnnotationsSelf
Boolean canApplyWatermark
String urlTemplate
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.
FileFullRepresentationsEntriesContentField content
FileFullRepresentationsEntriesInfoField info
FileFullRepresentationsEntriesPropertiesField properties
String representation
FileFullRepresentationsEntriesStatusField status
String url
EnumWrapper<E extends Enum<E> & Valuable> state
* `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.
Boolean isWatermarked
Boolean isWatermarkInherited
Boolean isWatermarkedByAccessPolicy
String sequenceId
String name
String sha1
FileVersionMini fileVersion
String id
EnumWrapper<E extends Enum<E> & Valuable> type
String title
This defaults to title of the file request that was copied to create this file request.
String description
This defaults to description of the file request that was copied to create this file request.
EnumWrapper<E extends Enum<E> & Valuable> status
When the status is set to `inactive`, the file request will no longer accept new submissions, and any visitor to the file request URL will receive a `HTTP 404` status code.
This defaults to status of file request that was copied to create this file request.
Boolean isEmailRequired
When this setting is set to true, the Box UI will show an email field on the file request form.
This defaults to setting of file request that was copied to create this file request.
Boolean isDescriptionRequired
When this setting is set to true, the Box UI will show a description field on the file request form.
This defaults to setting of file request that was copied to create this file request.
OffsetDateTime expiresAt
After this date, the `status` will automatically be set to `inactive`.
FolderMini folder
String url
String etag
UserMini createdBy
OffsetDateTime createdAt
UserMini updatedBy
OffsetDateTime updatedAt
FileRequestCopyRequestFolderField folder
String title
This will default to the value on the existing file request.
String description
This will default to the value on the existing file request.
EnumWrapper<E extends Enum<E> & Valuable> status
When the status is set to `inactive`, the file request will no longer accept new submissions, and any visitor to the file request URL will receive a `HTTP 404` status code.
This will default to the value on the existing file request.
Boolean isEmailRequired
When this setting is set to true, the Box UI will show an email field on the file request form.
This will default to the value on the existing file request.
Boolean isDescriptionRequired
When this setting is set to true, the Box UI will show a description field on the file request form.
This will default to the value on the existing file request.
OffsetDateTime expiresAt
After this date, the `status` will automatically be set to `inactive`.
This will default to the value on the existing file request.
Long limit
String nextMarker
String prevMarker
List<E> entries
Long limit
String nextMarker
String prevMarker
List<E> entries
String name
Long size
OffsetDateTime createdAt
OffsetDateTime modifiedAt
UserMini modifiedBy
OffsetDateTime trashedAt
UserMini trashedBy
OffsetDateTime restoredAt
UserMini restoredBy
OffsetDateTime purgedAt
String uploaderDisplayName
String versionNumber
String id
EnumWrapper<E extends Enum<E> & Valuable> type
FileVersionMini fileVersion
FileMini file
List<E> legalHoldPolicyAssignments
OffsetDateTime deletedAt
Long limit
String nextMarker
String prevMarker
List<E> entries
String sha1
String id
EnumWrapper<E extends Enum<E> & Valuable> type
FileVersionMini fileVersion
FileMini file
OffsetDateTime appliedAt
OffsetDateTime dispositionAt
RetentionPolicyMini winningRetentionPolicy
Long limit
String nextMarker
String prevMarker
List<E> entries
Long totalCount
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
Long limit
Long offset
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> order
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> entries
OffsetDateTime createdAt
OffsetDateTime modifiedAt
String description
Long size
Be careful parsing this integer as its value can get very large.
FolderPathCollectionField pathCollection
UserMini createdBy
UserMini modifiedBy
OffsetDateTime trashedAt
OffsetDateTime purgedAt
OffsetDateTime contentCreatedAt
OffsetDateTime contentModifiedAt
UserMini ownedBy
FolderSharedLinkField sharedLink
FolderFolderUploadEmailField folderUploadEmail
* 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`.
FolderMini parent
EnumWrapper<E extends Enum<E> & Valuable> itemStatus
* `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.
Items itemCollection
EnumWrapper<E extends Enum<E> & Valuable> access
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.
String email
String url
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.
String downloadUrl
This property will be `null` for folders.
String vanityUrl
String vanityName
EnumWrapper<E extends Enum<E> & Valuable> access
* `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.
EnumWrapper<E extends Enum<E> & Valuable> effectiveAccess
EnumWrapper<E extends Enum<E> & Valuable> effectivePermission
OffsetDateTime unsharedAt
boolean isPasswordEnabled
FolderSharedLinkPermissionsField permissions
long downloadCount
long previewCount
boolean canDownload
This value can be set to `true` when the effective access level is set to `open` or `company`, not `collaborators`.
boolean canPreview
This value is always `true`. For shared links on folders this also applies to any items in the folder.
boolean canEdit
This value can only be `true` if `can_download` is also `true` and if the item has a type of `file`.
String id
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`.
String etag
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> syncState
Boolean hasCollaborations
FolderFullPermissionsField permissions
List<E> tags
Boolean canNonOwnersInvite
Boolean isExternallyOwned
FolderFullMetadataField metadata
Boolean isCollaborationRestrictedToEnterprise
List<E> allowedSharedLinkAccessLevels
For some folders, like the root folder, this will always be an empty list as sharing is not allowed at that level.
List<E> allowedInviteeRoles
FolderFullWatermarkInfoField watermarkInfo
Boolean isAccessibleViaSharedLink
Boolean canNonOwnersViewCollaborators
It also restricts non-owners from inviting new collaborators.
FolderFullClassificationField classification
Boolean isAssociatedWithAppItem
String name
String definition
String color
boolean canDelete
boolean canDownload
boolean canInviteCollaborator
boolean canRename
boolean canSetShareAccess
boolean canShare
boolean canUpload
Boolean canApplyWatermark
Boolean isWatermarked
Boolean isWatermarkInherited
Boolean isWatermarkedByAccessPolicy
FolderMini folder
String id
String type
UserBase createdBy
OffsetDateTime createdAt
FolderLockLockedOperationsField lockedOperations
String lockType
boolean move
boolean delete
List<E> entries
String limit
String nextMarker
OffsetDateTime createdAt
OffsetDateTime modifiedAt
String provenance
String externalSyncIdentifier
String description
EnumWrapper<E extends Enum<E> & Valuable> invitabilityLevel
When set to `admins_only` the enterprise admin, co-admins, and the group's admin can invite the group.
When set to `admins_and_members` all the admins listed above and group members can invite the group.
When set to `all_managed_users` all managed users in the enterprise can invite the group.
EnumWrapper<E extends Enum<E> & Valuable> memberViewabilityLevel
* `admins_only` - the enterprise admin, co-admins, group's group admin. * `admins_and_members` - all admins and group members. * `all_managed_users` - all managed users in the enterprise.
GroupFullPermissionsField permissions
Boolean canInviteAsCollaborator
String id
EnumWrapper<E extends Enum<E> & Valuable> type
UserMini user
GroupMini group
EnumWrapper<E extends Enum<E> & Valuable> role
OffsetDateTime createdAt
OffsetDateTime modifiedAt
Long totalCount
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
Long limit
Long offset
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> order
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> entries
Long totalCount
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
Long limit
Long offset
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> order
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> entries
EnumWrapper<E extends Enum<E> & Valuable> integrationType
Boolean isManuallyCreated
IntegrationMappingSlackOptions options
UserIntegrationMappings createdBy
UserIntegrationMappings modifiedBy
IntegrationMappingPartnerItemSlack partnerItem
FolderMini boxItem
OffsetDateTime createdAt
OffsetDateTime modifiedAt
EnumWrapper<E extends Enum<E> & Valuable> type
String id
String slackWorkspaceId
String slackOrgId
EnumWrapper<E extends Enum<E> & Valuable> type
String id
String tenantId
String teamId
Long limit
String nextMarker
List<E> entries
IntegrationMappingPartnerItemSlack partnerItem
IntegrationMappingBoxItemSlack boxItem
IntegrationMappingSlackOptions options
Boolean isAccessManagementDisabled
EnumWrapper<E extends Enum<E> & Valuable> integrationType
Boolean isOverriddenByManualMapping
IntegrationMappingPartnerItemTeams partnerItem
FolderReference boxItem
OffsetDateTime createdAt
OffsetDateTime modifiedAt
IntegrationMappingPartnerItemTeamsCreateRequest partnerItem
FolderReference boxItem
String id
EnumWrapper<E extends Enum<E> & Valuable> type
InviteInvitedToField invitedTo
UserMini actionableBy
UserMini invitedBy
String status
OffsetDateTime createdAt
OffsetDateTime modifiedAt
Long limit
String nextMarker
String prevMarker
Long totalCount
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
Long offset
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> order
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> entries
Long totalCount
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
Long limit
Long offset
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> order
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> entries
OffsetDateTime createdAt
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> skillCardType
KeywordSkillCardSkillCardTitleField skillCardTitle
KeywordSkillCardSkillField skill
KeywordSkillCardInvocationField invocation
List<E> entries
String text
EnumWrapper<E extends Enum<E> & Valuable> type
String id
Long limit
String nextMarker
String prevMarker
List<E> entries
String policyName
String description
EnumWrapper<E extends Enum<E> & Valuable> status
LegalHoldPolicyAssignmentCountsField assignmentCounts
UserMini createdBy
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime deletedAt
If `null`, the policy was not deleted.
OffsetDateTime filterStartedAt
OffsetDateTime filterEndedAt
String releaseNotes
Long user
Long folder
Long file
Long fileVersion
Long ownership
Long interactions
LegalHoldPolicyMini legalHoldPolicy
LegalHoldPolicyAssignedItem assignedTo
UserMini assignedBy
OffsetDateTime assignedAt
OffsetDateTime deletedAt
Long limit
String nextMarker
String prevMarker
List<E> entries
String parent
String template
String scope
Long version
Long limit
String nextMarker
String prevMarker
List<E> entries
String id
EnumWrapper<E extends Enum<E> & Valuable> type
MetadataCascadePolicyOwnerEnterpriseField ownerEnterprise
MetadataCascadePolicyParentField parent
String scope
String templateKey
In many cases the template key is automatically derived of its display name, for example `Contract Template` would become `contractTemplate`. In some cases the creator of the template will have provided its own template key.
Please [list the templates for an enterprise][list], or get all instances on a [file][file] or [folder][folder] to inspect a template's key.
[list]: https://developer.box.com/reference/get-metadata-templates-enterprise [file]: https://developer.box.com/reference/get-files-id-metadata [folder]: https://developer.box.com/reference/get-folders-id-metadata
OffsetDateTime lt
OffsetDateTime gt
Double lt
Double gt
EnumWrapper<E extends Enum<E> & Valuable> scope
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.
String templateKey
In many cases the template key is automatically derived of its display name, for example `Contract Template` would become `contractTemplate`. In some cases the creator of the template will have provided its own template key.
Please [list the templates for an enterprise][list], or get all instances on a [file][file] or [folder][folder] to inspect a template's key.
[list]: https://developer.box.com/reference/get-metadata-templates-enterprise [file]: https://developer.box.com/reference/get-files-id-metadata [folder]: https://developer.box.com/reference/get-folders-id-metadata
Map<K,V> filters
Boolean canEdit
String id
String type
Long typeVersion
Map<K,V> extraData
String from
String query
For example, a value of `:amount` would represent the `amount` value in `query_params` object.
Map<K,V> queryParams
String ancestorFolderId
List<E> orderBy
The ordering `direction` must be the same for each item in the array.
Long limit
String marker
List<E> fields
This attribute takes a list of item fields, metadata template identifiers, or metadata template field identifiers.
For example:
* `created_by` will add the details of the user who created the item to the response. * `metadata.<scope>.<templateKey>` will return the mini-representation of the metadata instance identified by the `scope` and `templateKey`. * `metadata.<scope>.<templateKey>.<field>` will return all the mini-representation of the metadata instance identified by the `scope` and `templateKey` plus the field specified by the `field` name. Multiple fields for the same `scope` and `templateKey` can be defined.
String fieldKey
The `field_key` represents the `key` value of a field from the metadata template being searched for.
EnumWrapper<E extends Enum<E> & Valuable> direction
The `ordering` direction must be the same for each item in the array.
List<E> tags
Boolean isAccessibleViaSharedLink
List<E> allowedInviteeRoles
Boolean isExternallyOwned
Boolean hasCollaborations
Boolean isAssociatedWithAppItem
String description
Long size
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime trashedAt
OffsetDateTime purgedAt
OffsetDateTime contentCreatedAt
OffsetDateTime contentModifiedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
FolderMini parent
String itemStatus
String sequenceId
String name
String id
String etag
String type
List<E> entries
By default, this endpoint returns only the most basic info about the items. To get additional fields for each item, including any of the metadata, use the `fields` attribute in the query.
Long limit
String nextMarker
Long limit
String nextMarker
String prevMarker
List<E> entries
String id
String key
String displayName
String namespace
List<E> levels
String id
String displayName
long level
String parentId
List<E> nodePath
List<E> ancestors
Long limit
String nextMarker
String prevMarker
List<E> entries
String id
EnumWrapper<E extends Enum<E> & Valuable> type
String scope
String templateKey
String displayName
Boolean hidden
List<E> fields
Boolean copyInstanceOnItemCopy
EnumWrapper<E extends Enum<E> & Valuable> type
Additionally, metadata templates support an `enum` field for a basic list of items, and ` multiSelect` field for a similar list of items where the user can select more than one value.
**Note**: The `integer` value is deprecated. It is still present in the response, but cannot be used in the POST request.
String key
String displayName
String description
Boolean hidden
List<E> options
String id
Long limit
String nextMarker
String prevMarker
List<E> entries
String id
CollaboratorVariable collaborators
CompletionRuleVariable completionRule
RoleVariable fileCollaboratorRole
CollaboratorVariable taskCollaborators
RoleVariable role
EnumWrapper<E extends Enum<E> & Valuable> grantType
String clientId
Used in combination with `authorization_code`, `client_credentials`, or `urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.
String clientSecret
Used in combination with `authorization_code`, `client_credentials`, or `urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.
String code
Used in combination with `authorization_code` as the `grant_type`.
String refreshToken
Used in combination with `refresh_token` as the `grant_type`.
String assertion
Used in combination with `urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.
String subjectToken
Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
EnumWrapper<E extends Enum<E> & Valuable> subjectTokenType
Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
String actorToken
Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
EnumWrapper<E extends Enum<E> & Valuable> actorTokenType
Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
String scope
The `subject_token` will need to have all of these scopes or the call will error with **401 Unauthorized**..
String resource
EnumWrapper<E extends Enum<E> & Valuable> boxSubjectType
String boxSubjectId
String boxSharedLink
EnumWrapper<E extends Enum<E> & Valuable> grantType
String clientId
String clientSecret
String refreshToken
String type
String url
String ttl
String maxRetries
Long retryTimeout
This helps to overcome network issues where the long poll looks to be working but no packages are coming through.
String type
RecentItemResource item
EnumWrapper<E extends Enum<E> & Valuable> interactionType
OffsetDateTime interactedAt
String interactionSharedLink
String description
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime trashedAt
OffsetDateTime purgedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
FolderMini parent
String itemStatus
String sequenceId
String name
String id
String etag
String type
Long limit
String nextMarker
String prevMarker
List<E> entries
List<E> entries
Long limit
String nextMarker
String description
EnumWrapper<E extends Enum<E> & Valuable> policyType
EnumWrapper<E extends Enum<E> & Valuable> retentionType
* `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes.
* `non-modifiable`: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies.
EnumWrapper<E extends Enum<E> & Valuable> status
UserMini createdBy
OffsetDateTime createdAt
OffsetDateTime modifiedAt
Boolean canOwnerExtendRetention
Boolean areOwnersNotified
List<E> customNotificationRecipients
RetentionPolicyAssignmentCountsField assignmentCounts
String id
EnumWrapper<E extends Enum<E> & Valuable> type
RetentionPolicyMini retentionPolicy
RetentionPolicyAssignmentAssignedToField assignedTo
List<E> filterFields
UserMini assignedBy
OffsetDateTime assignedAt
String startDateField
List<E> entries
Long limit
String nextMarker
String policyName
String retentionLength
EnumWrapper<E extends Enum<E> & Valuable> dispositionAction
RetentionPolicyMaxExtensionLengthResponse maxExtensionLength
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> variableType
EnumWrapper<E extends Enum<E> & Valuable> variableValue
String description
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime trashedAt
OffsetDateTime purgedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
FolderMini parent
String itemStatus
String sequenceId
String name
String id
String etag
String type
Long totalCount
Long limit
Long offset
EnumWrapper<E extends Enum<E> & Valuable> type
List<E> entries
Long totalCount
Long limit
Long offset
EnumWrapper<E extends Enum<E> & Valuable> type
List<E> entries
String accessibleViaSharedLink
SearchResultWithSharedLinkItem item
String type
String description
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime trashedAt
OffsetDateTime purgedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
FolderMini parent
String itemStatus
String sequenceId
String name
String id
String etag
String type
String message
String id
EnumWrapper<E extends Enum<E> & Valuable> type
EnterpriseBase enterprise
EnumWrapper<E extends Enum<E> & Valuable> status
OffsetDateTime createdAt
UserBase createdBy
OffsetDateTime updatedAt
UserBase updatedBy
OffsetDateTime enabledAt
UserBase enabledBy
ShieldInformationBarrierBase shieldInformationBarrier
ShieldInformationBarrierReference shieldInformationBarrier
EnumWrapper<E extends Enum<E> & Valuable> status
ShieldInformationBarrierReportDetails details
OffsetDateTime createdAt
UserBase createdBy
OffsetDateTime updatedAt
ShieldInformationBarrierReportDetailsDetailsField details
String folderId
Long limit
String nextMarker
List<E> entries
Long limit
String nextMarker
List<E> entries
String id
EnumWrapper<E extends Enum<E> & Valuable> type
ShieldInformationBarrierBase shieldInformationBarrier
String name
String description
OffsetDateTime createdAt
UserBase createdBy
OffsetDateTime updatedAt
UserBase updatedBy
ShieldInformationBarrierBase shieldInformationBarrier
ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentField shieldInformationBarrierSegment
OffsetDateTime createdAt
UserBase createdBy
OffsetDateTime updatedAt
UserBase updatedBy
UserBase user
Long limit
String nextMarker
List<E> entries
ShieldInformationBarrierBase shieldInformationBarrier
OffsetDateTime createdAt
UserBase createdBy
OffsetDateTime updatedAt
UserBase updatedBy
ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentField shieldInformationBarrierSegment
ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentField restrictedSegment
Long limit
String nextMarker
List<E> entries
Long limit
String nextMarker
List<E> entries
EnumWrapper<E extends Enum<E> & Valuable> type
List<E> sourceFiles
List<E> signers
String signatureColor
String id
String prepareUrl
FileMini signingLog
EnumWrapper<E extends Enum<E> & Valuable> status
SignRequestSignFilesField signFiles
OffsetDateTime autoExpireAt
FolderMini parentFolder
String collaboratorLevel
String shortId
OffsetDateTime createdAt
OffsetDateTime finishedAt
String senderEmail
Long senderId
List<E> files
Boolean isReadyForDownload
Boolean isDocumentPreparationNeeded
String redirectUrl
String declinedRedirectUrl
Boolean areTextSignaturesEnabled
String emailSubject
String emailMessage
Boolean areRemindersEnabled
String name
List<E> prefillTags
Long daysValid
String externalId
String templateId
String externalSystemName
String reason
List<E> sourceFiles
EnumWrapper<E extends Enum<E> & Valuable> signatureColor
List<E> signers
**Note**: It may happen that some signers belong to conflicting [segments](https://developer.box.com/reference/resources/shield-information-barrier-segment-member) (user groups). This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts. In such a case, an attempt to send the sign request will result in an error.
Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
FolderMini parentFolder
String email
EnumWrapper<E extends Enum<E> & Valuable> role
Boolean isInPerson
Long order
String embedUrlExternalUserId
String redirectUrl
String declinedRedirectUrl
Boolean loginRequired
String verificationPhoneNumber
String password
String signerGroupId
Boolean suppressNotifications
String language
String documentTagId
String textValue
Boolean checkboxValue
OffsetDateTime dateValue
Long limit
String nextMarker
List<E> entries
Boolean hasViewedDocument
SignRequestSignerSignerDecisionField signerDecision
List<E> inputs
String embedUrl
String iframeableEmbedUrl
List<E> attachments
EnumWrapper<E extends Enum<E> & Valuable> type
OffsetDateTime finalizedAt
String additionalInfo
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> contentType
long pageIndex
Boolean readOnly
SignRequestSignerInputValidation validation
EnumWrapper<E extends Enum<E> & Valuable> validationType
String customRegex
String customErrorMessage
EnumWrapper<E extends Enum<E> & Valuable> validationType
EnumWrapper<E extends Enum<E> & Valuable> validationType
EnumWrapper<E extends Enum<E> & Valuable> validationType
EnumWrapper<E extends Enum<E> & Valuable> validationType
EnumWrapper<E extends Enum<E> & Valuable> validationType
EnumWrapper<E extends Enum<E> & Valuable> validationType
EnumWrapper<E extends Enum<E> & Valuable> validationType
EnumWrapper<E extends Enum<E> & Valuable> validationType
String validationType
EnumWrapper<E extends Enum<E> & Valuable> validationType
EnumWrapper<E extends Enum<E> & Valuable> validationType
EnumWrapper<E extends Enum<E> & Valuable> type
String id
String name
String emailSubject
String emailMessage
Long daysValid
FolderMini parentFolder
List<E> sourceFiles
Boolean areFieldsLocked
Boolean areOptionsLocked
Boolean areRecipientsLocked
Boolean areEmailSettingsLocked
Boolean areFilesLocked
List<E> signers
**Note**: It may happen that some signers specified in the template belong to conflicting [segments](https://developer.box.com/reference/resources/shield-information-barrier-segment-member) (user groups). This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts. In such a case, an attempt to send a sign request based on a template that lists signers in conflicting segments will result in an error.
Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
SignTemplateAdditionalInfoField additionalInfo
SignTemplateReadySignLinkField readySignLink
SignTemplateCustomBrandingField customBranding
List<E> nonEditable
SignTemplateAdditionalInfoRequiredField required
String url
String name
String instructions
String folderId
Boolean isNotificationDisabled
Boolean isActive
Long limit
String nextMarker
String prevMarker
List<E> entries
OffsetDateTime createdAt
String type
String skillCardType
Boolean canEdit
String id
String parent
String scope
String template
String type
Long typeVersion
Long version
List<E> cards
OffsetDateTime createdAt
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> skillCardType
StatusSkillCardSkillCardTitleField skillCardTitle
StatusSkillCardStatusField status
StatusSkillCardSkillField skill
StatusSkillCardInvocationField invocation
EnumWrapper<E extends Enum<E> & Valuable> type
String id
EnumWrapper<E extends Enum<E> & Valuable> code
String message
Long limit
String nextMarker
String prevMarker
List<E> entries
String name
String id
EnumWrapper<E extends Enum<E> & Valuable> type
StoragePolicyMini storagePolicy
StoragePolicyAssignmentAssignedToField assignedTo
Long limit
String nextMarker
String prevMarker
List<E> entries
String id
EnumWrapper<E extends Enum<E> & Valuable> type
FileMini item
OffsetDateTime dueAt
EnumWrapper<E extends Enum<E> & Valuable> action
String message
TaskAssignments taskAssignmentCollection
Boolean isCompleted
UserMini createdBy
OffsetDateTime createdAt
EnumWrapper<E extends Enum<E> & Valuable> completionRule
* `all_assignees` requires all assignees to review or approve the task in order for it to be considered completed. * `any_assignee` accepts any one assignee to review or approve the task in order for it to be considered completed.
String id
EnumWrapper<E extends Enum<E> & Valuable> type
FileMini item
UserMini assignedTo
String message
OffsetDateTime completedAt
OffsetDateTime assignedAt
OffsetDateTime remindedAt
EnumWrapper<E extends Enum<E> & Valuable> resolutionState
UserMini assignedBy
List<E> inputs
String email
EnumWrapper<E extends Enum<E> & Valuable> role
Boolean isInPerson
Long order
String signerGroupId
String label
String publicId
Boolean isPasswordRequired
Boolean isPhoneNumberRequired
Boolean loginRequired
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> contentType
Boolean isRequired
long pageIndex
String documentId
List<E> dropdownChoices
String groupId
TemplateSignerInputCoordinatesField coordinates
TemplateSignerInputDimensionsField dimensions
String label
Boolean readOnly
SignRequestSignerInputValidation validation
EnumWrapper<E extends Enum<E> & Valuable> status
TermsOfServiceEnterpriseField enterprise
EnumWrapper<E extends Enum<E> & Valuable> tosType
String text
OffsetDateTime createdAt
OffsetDateTime modifiedAt
String id
EnumWrapper<E extends Enum<E> & Valuable> type
TermsOfServiceBase tos
UserMini user
Boolean isAccepted
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime createdAt
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> skillCardType
TimelineSkillCardSkillCardTitleField skillCardTitle
TimelineSkillCardSkillField skill
TimelineSkillCardInvocationField invocation
Long duration
List<E> entries
String text
List<E> appears
String imageUrl
The image will be shown in a list of items (for example faces), and clicking the image will show the user where that entry appears during the duration of this entry.
EnumWrapper<E extends Enum<E> & Valuable> type
String id
OffsetDateTime createdAt
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> skillCardType
TranscriptSkillCardSkillCardTitleField skillCardTitle
TranscriptSkillCardSkillField skill
TranscriptSkillCardInvocationField invocation
Long duration
Used with a `skill_card_type` of `transcript` or `timeline`.
List<E> entries
Long start
EnumWrapper<E extends Enum<E> & Valuable> type
String id
String id
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`.
String etag
EnumWrapper<E extends Enum<E> & Valuable> type
String sequenceId
String name
String sha1
FileVersionMini fileVersion
String description
long size
TrashFilePathCollectionField pathCollection
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime trashedAt
OffsetDateTime purgedAt
OffsetDateTime contentCreatedAt
OffsetDateTime contentModifiedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
String sharedLink
FolderMini parent
EnumWrapper<E extends Enum<E> & Valuable> itemStatus
* `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.
EnumWrapper<E extends Enum<E> & Valuable> type
String id
String sequenceId
String etag
String name
String id
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`.
String etag
EnumWrapper<E extends Enum<E> & Valuable> type
String sequenceId
String name
String sha1
FileVersionMini fileVersion
String description
long size
TrashFileRestoredPathCollectionField pathCollection
OffsetDateTime createdAt
OffsetDateTime modifiedAt
String trashedAt
String purgedAt
OffsetDateTime contentCreatedAt
OffsetDateTime contentModifiedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
String sharedLink
FolderMini parent
EnumWrapper<E extends Enum<E> & Valuable> itemStatus
* `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.
String id
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`.
String etag
EnumWrapper<E extends Enum<E> & Valuable> type
String sequenceId
String name
OffsetDateTime createdAt
OffsetDateTime modifiedAt
String description
long size
Be careful parsing this integer as its value can get very large.
TrashFolderPathCollectionField pathCollection
UserMini createdBy
UserMini modifiedBy
OffsetDateTime trashedAt
OffsetDateTime purgedAt
OffsetDateTime contentCreatedAt
OffsetDateTime contentModifiedAt
UserMini ownedBy
String sharedLink
String folderUploadEmail
FolderMini parent
EnumWrapper<E extends Enum<E> & Valuable> itemStatus
* `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.
EnumWrapper<E extends Enum<E> & Valuable> type
String id
String sequenceId
String etag
String name
String id
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`.
String etag
EnumWrapper<E extends Enum<E> & Valuable> type
String sequenceId
String name
OffsetDateTime createdAt
OffsetDateTime modifiedAt
String description
Long size
Be careful parsing this integer as its value can get very large.
TrashFolderRestoredPathCollectionField pathCollection
UserMini createdBy
UserMini modifiedBy
String trashedAt
String purgedAt
OffsetDateTime contentCreatedAt
OffsetDateTime contentModifiedAt
UserMini ownedBy
String sharedLink
String folderUploadEmail
FolderMini parent
EnumWrapper<E extends Enum<E> & Valuable> itemStatus
* `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.
EnumWrapper<E extends Enum<E> & Valuable> type
String id
String sequenceId
String etag
String name
String url
FolderMini parent
String description
TrashWebLinkPathCollectionField pathCollection
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime trashedAt
OffsetDateTime purgedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
String sharedLink
EnumWrapper<E extends Enum<E> & Valuable> itemStatus
EnumWrapper<E extends Enum<E> & Valuable> type
String id
String sequenceId
String etag
String name
EnumWrapper<E extends Enum<E> & Valuable> type
String id
String sequenceId
String etag
String name
String url
FolderMini parent
String description
TrashWebLinkRestoredPathCollectionField pathCollection
OffsetDateTime createdAt
OffsetDateTime modifiedAt
String trashedAt
String purgedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
String sharedLink
EnumWrapper<E extends Enum<E> & Valuable> itemStatus
UploadPart part
String sha1
Long totalCount
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
Long limit
Long offset
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> order
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> entries
String id
EnumWrapper<E extends Enum<E> & Valuable> type
OffsetDateTime sessionExpiresAt
Long partSize
Only the last part is allowed to be of a smaller size.
Integer totalParts
Integer numPartsProcessed
When committing a file files, inspecting this property can provide insight if all parts have been uploaded correctly.
UploadSessionSessionEndpointsField sessionEndpoints
String uploadPart
String commit
String abort
String listParts
String status
String logEvent
OffsetDateTime createdAt
OffsetDateTime modifiedAt
String language
String timezone
Long spaceAmount
Long spaceUsed
Long maxUploadSize
EnumWrapper<E extends Enum<E> & Valuable> status
String jobTitle
String phone
String address
String avatarUrl
UserNotificationEmailField notificationEmail
UserAvatarPicUrlsField picUrls
String name
String login
Boolean isActive
EnumWrapper<E extends Enum<E> & Valuable> role
List<E> trackingCodes
Boolean canSeeManagedUsers
Boolean isSyncEnabled
Boolean isExternalCollabRestricted
Boolean isExemptFromDeviceLimits
Boolean isExemptFromLoginVerification
UserFullEnterpriseField enterprise
List<E> myTags
String hostname
Boolean isPlatformAccessOnly
String externalAppUserId
Long limit
String nextMarker
String prevMarker
Long totalCount
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
Long offset
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> order
This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
List<E> entries
List<E> entries
Long limit
String nextMarker
String id
EnumWrapper<E extends Enum<E> & Valuable> type
String name
The following restrictions to the archive name apply: names containing non-printable ASCII characters, forward and backward slashes (`/`, `\`), names with trailing spaces, and names `.` and `..` are not allowed.
long size
String description
ArchiveV2025R0OwnedByField ownedBy
EnumWrapper<E extends Enum<E> & Valuable> type
Integer status
EnumWrapper<E extends Enum<E> & Valuable> code
String message
Map<K,V> contextInfo
String helpUrl
String requestId
Boolean isCoOwnerRoleEnabled
Boolean isEditorRoleEnabled
Boolean isPreviewerRoleEnabled
Boolean isPreviewerUploaderRoleEnabled
Boolean isUploaderRoleEnabled
Boolean isViewerRoleEnabled
Boolean isViewerUploaderRoleEnabled
FileReferenceV2025R0 file
FileVersionBaseV2025R0 fileVersion
String inputSource
DocGenBatchCreateRequestV2025R0DestinationFolderField destinationFolder
String outputType
List<E> documentGenerationData
String createdAt
UserBaseV2025R0 createdBy
EnterpriseReferenceV2025R0 enterprise
String source
Long limit
String nextMarker
String prevMarker
List<E> entries
Long limit
String nextMarker
String prevMarker
List<E> entries
DocGenBatchBaseV2025R0 batch
FileReferenceV2025R0 templateFile
FileVersionBaseV2025R0 templateFileVersion
FileReferenceV2025R0 outputFile
FileVersionBaseV2025R0 outputFileVersion
EnumWrapper<E extends Enum<E> & Valuable> status
String outputType
String message
Long limit
String nextMarker
String prevMarker
List<E> entries
FileReferenceV2025R0 file
FileReferenceV2025R0 file
Long limit
String nextMarker
String prevMarker
List<E> entries
String fileName
List<E> enterpriseFeatureSettings
EnterpriseConfigurationItemStringV2025R0 sharingItemType
EnterpriseConfigurationItemStringV2025R0 sharedLinkCompanyDefinition
EnterpriseConfigurationItemStringV2025R0 sharedLinkAccess
EnterpriseConfigurationItemStringV2025R0 sharedLinkDefaultAccess
EnterpriseConfigurationContentAndSharingV2025R0SharedLinkDefaultPermissionsSelectedField sharedLinkDefaultPermissionsSelected
EnterpriseConfigurationItemBooleanV2025R0 isOpenCustomUrlsDisabled
EnterpriseConfigurationItemBooleanV2025R0 isCustomDomainHiddenInSharedLink
EnterpriseConfigurationContentAndSharingV2025R0CollaborationPermissionsField collaborationPermissions
EnterpriseConfigurationItemStringV2025R0 defaultCollaborationRole
EnterpriseConfigurationItemBooleanV2025R0 isInvitePrivilegeRestricted
EnterpriseConfigurationContentAndSharingV2025R0CollaborationRestrictionsField collaborationRestrictions
EnterpriseConfigurationItemBooleanV2025R0 isCollaboratorInviteLinksDisabled
EnterpriseConfigurationItemBooleanV2025R0 isInviteGroupCollaboratorDisabled
EnterpriseConfigurationItemBooleanV2025R0 isOwnershipTransferRestricted
EnterpriseConfigurationContentAndSharingV2025R0ExternalCollaborationStatusField externalCollaborationStatus
EnterpriseConfigurationContentAndSharingV2025R0ExternalCollaborationAllowlistUsersField externalCollaborationAllowlistUsers
EnterpriseConfigurationItemBooleanV2025R0 isWatermarkingEnterpriseFeatureEnabled
EnterpriseConfigurationItemBooleanV2025R0 isRootContentCreationRestricted
EnterpriseConfigurationItemBooleanV2025R0 isTagCreationRestricted
EnterpriseConfigurationItemStringV2025R0 tagCreationRestriction
EnterpriseConfigurationItemBooleanV2025R0 isEmailUploadsEnabled
EnterpriseConfigurationItemBooleanV2025R0 isCustomSettingsEnabled
EnterpriseConfigurationItemBooleanV2025R0 isFormsLoginRequired
EnterpriseConfigurationItemBooleanV2025R0 isFormsBrandingDefaultEnabled
EnterpriseConfigurationItemBooleanV2025R0 isCcFreeTrialActive
EnterpriseConfigurationItemBooleanV2025R0 isFileRequestEditorsAllowed
EnterpriseConfigurationItemBooleanV2025R0 isFileRequestBrandingDefaultEnabled
EnterpriseConfigurationItemBooleanV2025R0 isFileRequestLoginRequired
EnterpriseConfigurationItemBooleanV2025R0 isSharedLinksExpirationEnabled
EnterpriseConfigurationItemIntegerV2025R0 sharedLinksExpirationDays
EnterpriseConfigurationItemBooleanV2025R0 isPublicSharedLinksExpirationEnabled
EnterpriseConfigurationItemIntegerV2025R0 publicSharedLinksExpirationDays
EnterpriseConfigurationItemStringV2025R0 sharedExpirationTarget
EnterpriseConfigurationItemBooleanV2025R0 isSharedLinksExpirationNotificationEnabled
EnterpriseConfigurationItemIntegerV2025R0 sharedLinksExpirationNotificationDays
EnterpriseConfigurationItemBooleanV2025R0 isSharedLinksExpirationNotificationPrevented
EnterpriseConfigurationItemBooleanV2025R0 isAutoDeleteEnabled
EnterpriseConfigurationItemIntegerV2025R0 autoDeleteDays
EnterpriseConfigurationItemBooleanV2025R0 isAutoDeleteExpirationModificationPrevented
EnterpriseConfigurationItemStringV2025R0 autoDeleteTarget
EnterpriseConfigurationItemBooleanV2025R0 isCollaborationExpirationEnabled
EnterpriseConfigurationItemIntegerV2025R0 collaborationExpirationDays
EnterpriseConfigurationItemBooleanV2025R0 isCollaborationExpirationModificationPrevented
EnterpriseConfigurationItemBooleanV2025R0 isCollaborationExpirationNotificationEnabled
EnterpriseConfigurationItemStringV2025R0 collaborationExpirationTarget
EnterpriseConfigurationItemIntegerV2025R0 trashAutoClearTime
EnterpriseConfigurationItemStringV2025R0 permanentDeletionAccess
EnterpriseConfigurationContentAndSharingV2025R0PermanentDeletionAllowlistUsersField permanentDeletionAllowlistUsers
CollaborationPermissionsV2025R0 value
String value
SharedLinkPermissionsV2025R0 value
Boolean value
Long value
String value
Boolean isUsed
EnterpriseConfigurationItemBooleanV2025R0 isManagedUserSignupEnabled
EnterpriseConfigurationItemBooleanV2025R0 isManagedUserSignupNotificationEnabled
EnterpriseConfigurationItemBooleanV2025R0 isManagedUserSignupCorporateEmailEnabled
EnterpriseConfigurationItemBooleanV2025R0 isNewUserNotificationDailyDigestEnabled
EnterpriseConfigurationItemBooleanV2025R0 isManagedUserEmailChangeDisabled
EnterpriseConfigurationItemBooleanV2025R0 isMultiFactorAuthRequired
EnterpriseConfigurationItemBooleanV2025R0 isWeakPasswordPreventionEnabled
EnterpriseConfigurationItemBooleanV2025R0 isPasswordLeakDetectionEnabled
EnterpriseConfigurationSecurityV2025R0LastPasswordResetAtField lastPasswordResetAt
EnterpriseConfigurationItemBooleanV2025R0 isPasswordRequestNotificationEnabled
EnterpriseConfigurationItemBooleanV2025R0 isPasswordChangeNotificationEnabled
EnterpriseConfigurationItemBooleanV2025R0 isStrongPasswordForExtCollabEnabled
EnterpriseConfigurationItemBooleanV2025R0 isManagedUserMigrationDisabled
EnterpriseConfigurationItemStringV2025R0 joinLink
EnterpriseConfigurationItemStringV2025R0 joinUrl
EnterpriseConfigurationItemIntegerV2025R0 failedLoginAttemptsToTriggerAdminNotification
EnterpriseConfigurationItemIntegerV2025R0 passwordMinLength
EnterpriseConfigurationItemIntegerV2025R0 passwordMinUppercaseCharacters
EnterpriseConfigurationItemIntegerV2025R0 passwordMinNumericCharacters
EnterpriseConfigurationItemIntegerV2025R0 passwordMinSpecialCharacters
EnterpriseConfigurationItemStringV2025R0 passwordResetFrequency
EnterpriseConfigurationItemStringV2025R0 previousPasswordReuseLimit
EnterpriseConfigurationItemStringV2025R0 sessionDuration
EnterpriseConfigurationSecurityV2025R0ExternalCollabMultiFactorAuthSettingsField externalCollabMultiFactorAuthSettings
EnterpriseConfigurationSecurityV2025R0KeysafeField keysafe
EnterpriseConfigurationItemBooleanV2025R0 isCustomSessionDurationEnabled
EnterpriseConfigurationItemStringV2025R0 customSessionDurationValue
EnterpriseConfigurationSecurityV2025R0CustomSessionDurationGroupsField customSessionDurationGroups
EnterpriseConfigurationItemStringV2025R0 multiFactorAuthType
EnterpriseConfigurationSecurityV2025R0EnforcedMfaFrequencyField enforcedMfaFrequency
ExternalCollabSecuritySettingsV2025R0 value
KeysafeSettingsV2025R0 value
OffsetDateTime value
List<E> enterpriseFeatureSettings
EnterpriseConfigurationItemStringV2025R0 userInvitesExpirationTimeFrame
EnterpriseConfigurationItemBooleanV2025R0 isUsernameChangeRestricted
EnterpriseConfigurationItemBooleanV2025R0 isBoxSyncRestrictedForNewUsers
EnterpriseConfigurationItemBooleanV2025R0 isViewAllUsersEnabledForNewUsers
EnterpriseConfigurationItemBooleanV2025R0 isDeviceLimitExemptionEnabledForNewUsers
EnterpriseConfigurationItemBooleanV2025R0 isExternalCollaborationRestrictedForNewUsers
EnterpriseConfigurationItemBooleanV2025R0 isUnlimitedStorageEnabledForNewUsers
EnterpriseConfigurationItemIntegerV2025R0 newUserDefaultStorageLimit
EnterpriseConfigurationItemStringV2025R0 newUserDefaultTimezone
EnterpriseConfigurationItemStringV2025R0 newUserDefaultLanguage
EnterpriseConfigurationItemBooleanV2025R0 isEnterpriseSsoRequired
EnterpriseConfigurationItemBooleanV2025R0 isEnterpriseSsoInTesting
EnterpriseConfigurationItemBooleanV2025R0 isSsoAutoAddGroupsEnabled
EnterpriseConfigurationItemBooleanV2025R0 isSsoAutoAddUserToGroupsEnabled
EnterpriseConfigurationItemBooleanV2025R0 isSsoAutoRemoveUserFromGroupsEnabled
EnterpriseConfigurationUserSettingsV2025R0UserTrackingCodesField userTrackingCodes
EnterpriseConfigurationItemIntegerV2025R0 numberOfUserTrackingCodesRemaining
EnterpriseConfigurationItemBooleanV2025R0 isInstantLoginRestricted
String id
EnumWrapper<E extends Enum<E> & Valuable> type
EnterpriseConfigurationSecurityV2025R0 security
EnterpriseConfigurationContentAndSharingV2025R0 contentAndSharing
EnterpriseConfigurationUserSettingsV2025R0 userSettings
EnterpriseConfigurationShieldV2025R0 shield
EnterpriseFeatureSettingV2025R0 value
String id
EnterpriseFeatureSettingV2025R0FeatureField feature
String state
Boolean canConfigure
Boolean isConfigured
List<E> allowlist
List<E> denylist
String id
List<E> denylistDomains
List<E> denylistEmails
List<E> allowlistDomains
List<E> allowlistEmails
String state
String scheduledStatus
OffsetDateTime scheduledAt
String factorTypeSettings
String id
The ID for any Box Hub can be determined by visiting a Box Hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.
EnumWrapper<E extends Enum<E> & Valuable> type
HubCollaborationCreateRequestV2025R0HubField hub
HubCollaborationCreateRequestV2025R0AccessibleByField accessibleBy
String role
String type
String id
Alternatively, use `login` to specify a user by email address.
String login
Alternatively, use `id` to specify a user by user ID.
List<E> entries
Long limit
String nextMarker
String role
String id
EnumWrapper<E extends Enum<E> & Valuable> type
HubBaseV2025R0 hub
HubAccessGranteeV2025R0 accessibleBy
String role
EnumWrapper<E extends Enum<E> & Valuable> status
HubCollaborationV2025R0AcceptanceRequirementsStatusField acceptanceRequirementsStatus
HubCollaborationV2025R0AcceptanceRequirementsStatusTermsOfServiceRequirementField termsOfServiceRequirement
HubCollaborationV2025R0AcceptanceRequirementsStatusStrongPasswordRequirementField strongPasswordRequirement
HubCollaborationV2025R0AcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField twoFactorAuthenticationRequirement
Boolean enterpriseHasStrongPasswordRequiredForExternalUsers
Boolean userHasStrongPassword
Boolean isAccepted
TermsOfServiceBaseV2025R0 termsOfService
Boolean enterpriseHasTwoFactorAuthEnabled
Boolean userHasTwoFactorAuthenticationEnabled
EnumWrapper<E extends Enum<E> & Valuable> type
List<E> entries
EnumWrapper<E extends Enum<E> & Valuable> type
Long limit
String nextMarker
List<E> entries
EnumWrapper<E extends Enum<E> & Valuable> type
Long limit
String nextMarker
String id
String type
String parentId
String titleFragment
EnumWrapper<E extends Enum<E> & Valuable> type
String action
HubItemReferenceV2025R0 item
String parentId
Long status
String error
EnumWrapper<E extends Enum<E> & Valuable> action
HubItemReferenceV2025R0 item
String parentId
List<E> entries
Long limit
String nextMarker
List<E> entries
Long limit
String nextMarker
String title
String description
Boolean isAiEnabled
Boolean isCollaborationRestrictedToEnterprise
Boolean canNonOwnersInvite
Boolean canSharedLinkBeCreated
Boolean canPublicSharedLinkBeCreated
String title
String description
OffsetDateTime createdAt
OffsetDateTime updatedAt
UserMiniV2025R0 createdBy
UserMiniV2025R0 updatedBy
Integer viewCount
Boolean isAiEnabled
Boolean isCollaborationRestrictedToEnterprise
Boolean canNonOwnersInvite
Boolean canSharedLinkBeCreated
Boolean canPublicSharedLinkBeCreated
Boolean keysafeEnabled
String cloudProvider
String keyId
String accountId
String locationId
String projectId
String keyringId
String sharedLinksOption
String defaultSharedLinkType
String notesSharedLinkOption
String defaultNotesSharedLinkType
String id
String type
String type
String id
EnumWrapper<E extends Enum<E> & Valuable> type
String name
ShieldListMiniV2025R0ContentField content
String type
String name
String description
ShieldListContentRequestV2025R0 content
String name
String description
ShieldListContentRequestV2025R0 content
String id
String type
String name
EnterpriseReferenceV2025R0 enterprise
String description
OffsetDateTime createdAt
OffsetDateTime updatedAt
ShieldListContentV2025R0 content
String id
EnumWrapper<E extends Enum<E> & Valuable> type
String ruleCategory
String name
String description
EnumWrapper<E extends Enum<E> & Valuable> priority
OffsetDateTime createdAt
OffsetDateTime modifiedAt
String id
EnumWrapper<E extends Enum<E> & Valuable> type
EnumWrapper<E extends Enum<E> & Valuable> actionType
String description
OffsetDateTime createdAt
OffsetDateTime updatedAt
UserMiniV2026R0 createdBy
UserMiniV2026R0 updatedBy
AutomateWorkflowReferenceV2026R0 workflow
List<E> entries
Long limit
String nextMarker
EnumWrapper<E extends Enum<E> & Valuable> type
Integer status
EnumWrapper<E extends Enum<E> & Valuable> code
String message
Map<K,V> contextInfo
String helpUrl
String requestId
WatermarkWatermarkField watermark
OffsetDateTime createdAt
OffsetDateTime modifiedAt
UserMini createdBy
OffsetDateTime createdAt
String address
List<E> triggers
String id
EnumWrapper<E extends Enum<E> & Valuable> type
WebhookMiniTargetField target
Long limit
String nextMarker
String prevMarker
List<E> entries
FolderMini parent
String description
WebLinkPathCollectionField pathCollection
OffsetDateTime createdAt
OffsetDateTime modifiedAt
OffsetDateTime trashedAt
OffsetDateTime purgedAt
UserMini createdBy
UserMini modifiedBy
UserMini ownedBy
WebLinkSharedLinkField sharedLink
EnumWrapper<E extends Enum<E> & Valuable> itemStatus
String url
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.
String downloadUrl
This property will be `null` for folders.
String vanityUrl
String vanityName
EnumWrapper<E extends Enum<E> & Valuable> access
* `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.
EnumWrapper<E extends Enum<E> & Valuable> effectiveAccess
EnumWrapper<E extends Enum<E> & Valuable> effectivePermission
OffsetDateTime unsharedAt
boolean isPasswordEnabled
WebLinkSharedLinkPermissionsField permissions
long downloadCount
long previewCount
boolean canDownload
This value can be set to `true` when the effective access level is set to `open` or `company`, not `collaborators`.
boolean canPreview
This value is always `true`. For shared links on folders this also applies to any items in the folder.
boolean canEdit
This value can only be `true` if `can_download` is also `true` and if the item has a type of `file`.
String id
EnumWrapper<E extends Enum<E> & Valuable> type
WorkflowFlowsTriggerField trigger
List<E> outcomes
OffsetDateTime createdAt
UserBase createdBy
String id
EnumWrapper<E extends Enum<E> & Valuable> type
String name
EnumWrapper<E extends Enum<E> & Valuable> actionType
List<E> ifRejected
EnumWrapper<E extends Enum<E> & Valuable> type
String ref
WorkflowFlowsTriggerScopeObjectField object
String id
EnumWrapper<E extends Enum<E> & Valuable> type
String name
String description
Boolean isEnabled
Long limit
String nextMarker
String prevMarker
List<E> entries
String downloadUrl
It is important to note that the domain and path of this URL might change between API calls, and therefore it's important to use this URL as-is.
String statusUrl
It is important to note that the domain and path of this URL might change between API calls, and therefore it's important to use this URL as-is.
OffsetDateTime expiresAt
By default, these URLs are only valid for a few seconds, unless a download is started after which the `download_url` is valid for the duration of the download, and the `status_url` is valid for 12 hours from the start of the download.
List<E> nameConflicts
To solve these conflicts, the API will automatically rename an item and return a mapping between the original item's name and its new name.
For every conflict, both files will be renamed and therefore this list will always be a multiple of 2.
Long totalFileCount
Long downloadedFileCount
Long skippedFileCount
Long skippedFolderCount
EnumWrapper<E extends Enum<E> & Valuable> state