Box Developer Documentation
Log in
Latest version

List file app item associations

get
https://api.box.com/2.0
/files/:file_id/app_item_associations

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

This is a beta feature, which means that its availability might be limited. Returns all app items the file is associated with. This includes app items associated with ancestors of the file. Assuming the context user has access to the file, the type/ids are revealed even if the context user does not have View permission on the app item.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Query Parameters

stringin queryoptional
hubs

If given, only return app items for this application type

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

Response

application/jsonApp item associations

Returns a collection of app item objects. If there are no app items on this file, an empty collection will be returned. This list includes app items on ancestors of this File.

application/jsonClient error

Returned if the file is not found, or the user does not have access to the file.

application/jsonClient error

An unexpected client error.

get
List file app item associations
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.appItemAssociations.getFileAppItemAssociations(fileId);
Python Gen
client.app_item_associations.get_file_app_item_associations(file_id)
.NET Gen
await client.AppItemAssociations.GetFileAppItemAssociationsAsync(fileId: fileId);
Swift Gen (Beta)
try await client.appItemAssociations.getFileAppItemAssociations(fileId: fileId)

Response Example

{
  "entries": [
    {
      "app_item": {
        "application_type": "hubs",
        "id": "12345678",
        "type": "app_item"
      },
      "id": "12345678",
      "item": {
        "etag": "1",
        "id": "12345",
        "type": "file"
      },
      "type": "app_item_association"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}