Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

You can list Box Hubs in two ways: Use query parameters to search, filter by scope, and sort results.
Box Hubs endpoints require the box-version: 2025.0 header. If you omit this header, the API returns a 400 error with the message Missing required box-version header. Supported API versions: [2025.0]. For more information, see Box API versioning strategy.

List hubs for the requesting user

To retrieve all Box Hubs accessible to the authenticated user, call the endpoint.
box hubs --scope all --sort name --direction ASC

Query parameters (list hubs for user)

ParameterTypeRequiredDescription
querystringNoSearch string for Box Hubs.
scopestringNoeditable, view_only, or all. Default is all.
sortstringNoSort by name, updated_at, last_accessed_at, view_count, or relevance. Default is relevance.
directionstringNoASC or DESC.
markerstringNoMarker for marker-based pagination.
limitintegerNoMaximum items per page (must not exceed 1000).

List hubs for the enterprise

Admins or Hub Co-admins of an enterprise with scope can list all Box Hubs for the enterprise using the endpoint.
box hubs:enterprise --sort name --direction ASC
Both endpoints return a list of hubs with pagination fields (limit, next_marker). Use the API reference for full parameter descriptions and limitations.