API Box Platform
(https://box.dev) provides functionality to provide access to content stored within [Box](https://box.com). It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
1 subscribers
100 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
API Box Platform endpoints
| Method | Endpoint | Description |
|---|---|---|
| Box Sign | ||
| POST |
post_sign_requests_id_resend /sign_requests/{sign_request_id}/resend |
Resends a sign request email to all outstanding signers. |
| Classifications on folders | ||
| GET |
get_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo |
Retrieves the classification metadata instance that has been applied to a folder. This API can also be called by including the enterprise ID in the URL explicitly, for example… |
| DELETE |
delete_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo |
Removes any classifications from a folder. This API can also be called by including the enterprise ID in the URL explicitly, for example… |
| Collaborations | ||
| DELETE |
delete_collaborations_id /collaborations/{collaboration_id} |
Deletes a single collaboration. |
| Domain restrictions (User exemptions) | ||
| GET |
get_collaboration_whitelist_exempt_targets_id /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id} |
Returns a users who has been exempt from the collaboration domain restrictions. |
| File requests | ||
| PUT |
put_file_requests_id /file_requests/{file_request_id} |
Updates a file request. This can be used to activate or deactivate a file request. |
| GET |
get_file_requests_id /file_requests/{file_request_id} |
Retrieves the information about a file request. |
| File version legal holds | ||
| GET |
get_file_version_legal_holds_id /file_version_legal_holds/{file_version_legal_hold_id} |
Retrieves information about the legal hold policies assigned to a file version. |
| File versions | ||
| GET |
get_files_id_versions_id /files/{file_id}/versions/{file_version_id} |
Retrieve a specific version of a file. Versions are only tracked for Box users with premium accounts. |
| Files | ||
| DELETE |
delete_files_id /files/{file_id} |
Deletes a file, either permanently or by moving it to the trash. The the enterprise settings determine whether the item will be permanently deleted from Box or moved to the trash. |
| Folder Locks | ||
| GET |
get_folder_locks /folder_locks |
Retrieves folder lock details for a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint. |
| DELETE |
delete_folder_locks_id /folder_locks/{folder_lock_id} |
Deletes a folder lock on a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint. |
| POST |
post_folder_locks /folder_locks |
Creates a folder lock on a folder, preventing it from being moved and/or deleted. You must be authenticated as the owner or co-owner of the folder to use this endpoint. |
| Folders | ||
| DELETE |
delete_folders_id /folders/{folder_id} |
Deletes a folder, either permanently or by moving it to the trash. |
| POST |
post_folders_id_copy /folders/{folder_id}/copy |
Creates a copy of a folder within a destination folder. The original folder will not be changed. |
| PUT |
put_folders_id /folders/{folder_id} |
Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more. |
| GET |
get_folders_id /folders/{folder_id} |
Retrieves details for a folder, including the first 100 entries in the folder. To fetch more items within the folder, please use the [Get items in a… |
| Group memberships | ||
| GET |
get_group_memberships_id /group_memberships/{group_membership_id} |
Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API. |
| POST |
post_group_memberships /group_memberships |
Creates a group membership. Only users with admin-level permissions will be able to use this API. |
| Groups | ||
| DELETE |
delete_groups_id /groups/{group_id} |
Permanently deletes a group. Only users with admin-level permissions will be able to use this API. |
| POST |
post_groups /groups |
Creates a new group of users in an enterprise. Only users with admin permissions can create new groups. |
| GET |
get_groups_id /groups/{group_id} |
Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API. |
| GET |
get_groups /groups |
Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups. |
| PUT |
put_groups_id /groups/{group_id} |
Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API. |
| Legal hold policies | ||
| GET |
get_legal_hold_policies_id /legal_hold_policies/{legal_hold_policy_id} |
Retrieve a legal hold policy. |
| Legal hold policy assignments | ||
| GET |
get_legal_hold_policy_assignments /legal_hold_policy_assignments |
Retrieves a list of items a legal hold policy has been assigned to. |
| Metadata instances (Files) | ||
| DELETE |
delete_files_id_metadata_id_id /files/{file_id}/metadata/{scope}/{template_key} |
Deletes a piece of file metadata. |
| GET |
get_files_id_metadata_id_id /files/{file_id}/metadata/{scope}/{template_key} |
Retrieves the instance of a metadata template that has been applied to a file. |
| POST |
post_files_id_metadata_id_id /files/{file_id}/metadata/{scope}/{template_key} |
Applies an instance of a metadata template to a file. In most cases only values that are present in the metadata template will be accepted, except for the `global.properties`… |
| PUT |
put_files_id_metadata_id_id /files/{file_id}/metadata/{scope}/{template_key} |
Updates a piece of metadata on a file. The metadata instance can only be updated if the template has already been applied to the file before. When editing metadata, only values… |
| Metadata instances (Folders) | ||
| GET |
get_folders_id_metadata /folders/{folder_id}/metadata |
Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`. |
| POST |
post_folders_id_metadata_id_id /folders/{folder_id}/metadata/{scope}/{template_key} |
Applies an instance of a metadata template to a folder. In most cases only values that are present in the metadata template will be accepted, except for the `global.properties`… |
| Metadata templates | ||
| GET |
get_metadata_templates_enterprise /metadata_templates/enterprise |
Used to retrieve all metadata templates created to be used specifically within the user's enterprise |
| GET |
get_metadata_templates_id /metadata_templates/{template_id} |
Retrieves a metadata template by its ID. |
| GET |
get_metadata_templates /metadata_templates |
Finds a metadata template by searching for the ID of an instance of the template. |
| POST |
post_metadata_templates_schema /metadata_templates/schema |
Creates a new metadata template that can be applied to files and folders. |
| GET |
get_metadata_templates_global /metadata_templates/global |
Used to retrieve all generic, global metadata templates available to all enterprises using Box. |
| DELETE |
delete_metadata_templates_id_id_schema /metadata_templates/{scope}/{template_key}/schema |
Delete a metadata template and its instances. This deletion is permanent and can not be reversed. |
| PUT |
put_metadata_templates_id_id_schema /metadata_templates/{scope}/{template_key}/schema |
Updates a metadata template. The metadata template can only be updated if the template already exists. The update is applied atomically. If any errors occur during the… |
| Recent items | ||
| GET |
get_recent_items /recent_items |
Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed. |
| Retention policy assignments | ||
| DELETE |
delete_retention_policy_assignments_id /retention_policy_assignments/{retention_policy_assignment_id} |
Removes a retention policy assignment applied to content. |
| POST |
post_retention_policy_assignments /retention_policy_assignments |
Assigns a retention policy to an item. |
| GET |
get_retention_policy_assignments_id /retention_policy_assignments/{retention_policy_assignment_id} |
Retrieves a retention policy assignment |
| GET |
get_retention_policy_assignments_id_files_under_retention /retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention |
Returns a list of files under retention for a retention policy assignment. |
| GET |
get_retention_policy_assignments_id_file_versions_under_retention /retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention |
Returns a list of file versions under retention for a retention policy assignment. |
| GET |
get_retention_policies_id_assignments /retention_policies/{retention_policy_id}/assignments |
Returns a list of all retention policy assignments associated with a specified retention policy. |
| Search | ||
| GET |
get_metadata_query_indices /metadata_query_indices |
Retrieves the metadata query indices for a given scope and template key. |
| Shared links (Files) | ||
| PUT |
put_files_id#remove_shared_link /files/{file_id}#remove_shared_link |
Removes a shared link from a file. |
| PUT |
put_files_id#add_shared_link /files/{file_id}#add_shared_link |
Adds a shared link to a file. |
| GET |
get_files_id#get_shared_link /files/{file_id}#get_shared_link |
Gets the information for a shared link on a file. |
+ 50 more endpoints on the provider's documentation.
API Box Platform pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | $5 / month | — |
|
| PRO | $10 / month | — |
|
| ULTRA | $15 / month | — |
|
| MEGA | $20 / month | — |
|
