Skip to content
This repository was archived by the owner on Nov 6, 2026. It is now read-only.

Latest commit

 

History

History
83 lines (60 loc) · 3.14 KB

hub_items.md

File metadata and controls

83 lines (60 loc) · 3.14 KB

HubItemsManager

Caution

box-python-sdk-gen is deprecated and no longer maintained. As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects.

Use box-python-sdk v10+ instead: pip install "boxsdk>=10". The equivalent of this page is box-python-sdk/docs/hub_items.md. To migrate existing code, see the migration guide.

Get Box Hub items

Retrieves all items associated with a Box Hub.

This operation is performed by calling function get_hub_items_v2025_r0.

See the endpoint docs at API Reference.

client.hub_items.get_hub_items_v2025_r0(created_hub.id)

Arguments

  • hub_id str
    • The unique identifier that represent a hub. The ID for any hub can be determined by visiting this 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.
  • marker Optional[str]
    • 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.
  • limit Optional[int]
    • The maximum number of items to return per page.
  • box_version BoxVersionHeaderV2025R0
    • Version header.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type HubItemsV2025R0.

Retrieves the items associated with the specified Box Hub.

Manage Box Hub items

Adds and/or removes Box Hub items from a Box Hub.

This operation is performed by calling function manage_hub_items_v2025_r0.

See the endpoint docs at API Reference.

client.hub_items.manage_hub_items_v2025_r0(
    created_hub.id,
    operations=[
        HubItemOperationV2025R0(
            action=HubItemOperationV2025R0ActionField.ADD,
            item=FolderReferenceV2025R0(id=folder.id),
        )
    ],
)

Arguments

  • hub_id str
    • The unique identifier that represent a hub. The ID for any hub can be determined by visiting this 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. Example: "12345"
  • operations Optional[List[HubItemOperationV2025R0]]
    • List of operations to perform on Box Hub items.
  • box_version BoxVersionHeaderV2025R0
    • Version header.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type HubItemsManageResponseV2025R0.