Box Hub Items resources

A set of endpoints used to manage items within a Box Hub.

Box Hub Item

A Box Hub Item is a Box Item that is referenced in a Box Hub.

Attributes and example

Property	Type	Required	Description
`id`	`string`	Yes	The unique identifier for this item.
`type`	`enum<string>`	Yes	The type of the item. Available options: `file`, `folder`, `web_link`.
`name`	`string`	Yes	The name of the item.

Example

{
  "id": "12345678",
  "type": "file",
  "name": "My File"
}

Box Hub Items

A list of Box Hub items.

Attributes and example

Property	Type	Required	Description
`entries`	array of Box Hub Item	No	A list of Box Hub items.
`limit`	`integer`	No	The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
`next_marker`	`string`	No	The marker for the start of the next page of results. Can be `null`.

Example

{
  "entries": [
    {
      "id": "12345678",
      "type": "file",
      "name": "My File"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}

Box Hub Items Manage Response

Response schema for the status of Box Hub items management operations.

Attributes and example

Property	Type	Required	Description
`operations`	array of `Box Hub Item Operation Result`	Yes	List of operations performed on Box Hub items.

Example

{
  "operations": [
    {
      "action": "add",
      "item": {
        "type": "file",
        "id": "42037322"
      },
      "parent_id": "721d97d7-ac8a-4e5e-adb6-ef11af4e6d9e",
      "status": 200,
      "error": "Item not found"
    }
  ]
}

​Box Hub Item

​Box Hub Items

​Box Hub Items Manage Response

Box Hub Item

Box Hub Items

Box Hub Items Manage Response