← Back to catalog

Storage

Box

swirls add box
actionGETv1.0.0

Authorize user

Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf. This is the first step when authenticating a user using OAuth 2.0. To request a user's authorization to use the Box APIs on their behalf you will need to send a user to the URL with this format.

Source
actionGETv1.0.0

Find file for shared link

Returns the file represented by a shared link. A shared file can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve information about a shared file when only given a shared link. The `shared_link_permission_options` array field can be returned by requesting it in the `fields` query parameter.

Source
actionGETv1.0.0

Find folder for shared link

Return the folder represented by a shared link. A shared folder can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve information about a shared folder when only given a shared link.

Source
actionGETv1.0.0

Find web link for shared link

Returns the web link represented by a shared link. A shared web link can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve information about a shared web link when only given a shared link.

Source
actionGETv1.0.0

Get allowed collaboration domain

Returns a domain that has been deemed safe to create collaborations for within the current enterprise.

Source
actionGETv1.0.0

Get classification on file

Retrieves the classification metadata instance that has been applied to a file. This API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Source
actionGETv1.0.0

Get classification on folder

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 `/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Source
actionGETv1.0.0

Get comment

Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.

Source
actionGETv1.0.0

Get device pin

Retrieves information about an individual device pin.

Source
actionGETv1.0.0

Get file request

Retrieves the information about a file request.

Source
actionGETv1.0.0

Get files under retention

Returns a list of files under retention for a retention policy assignment.

Source
actionGETv1.0.0

Get folder information

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 folder](#get-folders-id-items) endpoint.

Source
actionGETv1.0.0

Get group

Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.

Source
actionGETv1.0.0

Get group membership

Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Source
actionGETv1.0.0

Get metadata instance on folder

Retrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID `0`.

Source
actionGETv1.0.0

Get trashed file

Retrieves a file that has been moved to the trash. Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](e://get_folders_id_trash) API. To list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](e://get-folders-trash-items/) API.

Source
actionGETv1.0.0

Get trashed folder

Retrieves a folder that has been moved to the trash. Please note that only if the folder itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](e://get_folders_id_trash) API. To list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](e://get-folders-trash-items/) API.

Source
actionGETv1.0.0

List all collections

Retrieves all collections for a given user. Currently, only the `favorites` collection is supported.

Source
actionGETv1.0.0

List allowed collaboration domains

Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.

Source
actionGETv1.0.0

List Box Skill cards on file

List the Box Skills metadata cards that are attached to a file.

Source
actionGETv1.0.0

List collection items

Retrieves the files and/or folders contained within this collection.

Source
actionGETv1.0.0

List enterprise device pins

Retrieves all the device pins within an enterprise. The user must have admin privileges, and the application needs the "manage enterprise" scope to make this call.

Source
actionGETv1.0.0

List file collaborations

Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.

Source
actionGETv1.0.0

List folder collaborations

Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.

Source
actionGETv1.0.0

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

Source
actionGETv1.0.0

List group collaborations

Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups. Each collaboration object has details on which files or folders the group has access to and with what role.

Source
actionGETv1.0.0

List groups for enterprise

Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.

Source
actionGETv1.0.0

List members of group

Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.

Source
actionGETv1.0.0

List metadata cascade policies

Retrieves a list of all the metadata cascade policies that are applied to a given folder. This can not be used on the root folder with ID `0`.

Source
actionGETv1.0.0

List recently accessed 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.

Source
actionGETv1.0.0

List retention policy assignments

Returns a list of all retention policy assignments associated with a specified retention policy.

Source
actionGETv1.0.0

List tasks on file

Retrieves a list of all the tasks for a file. This endpoint does not support pagination.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec