List Buckets
This endpoint lists buckets with pagination, sorting, and filtering options.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
1 <= x <= 10001 <= x <= 10000 <= x <= 10000x >= 1Body
Request model for listing buckets.
Inherits body-level limit/page_size/offset/page (BACKE-2846). The old hardcoded limit=10/offset=0 defaults moved to the controller so an unset body field can fall back to query-string pagination (body wins when set).
Page size. A body value wins over the limit query param.
1 <= x <= 1000Alias for limit (page size). If both are given, limit wins.
1 <= x <= 1000Number of results to skip (legacy, use cursor instead). A body value wins over the offset query param.
0 <= x <= 100001-indexed page number. Folds to offset = (page-1) * limit. If both page and offset are given, offset wins.
x >= 1Search term for wildcard search across bucket_id, bucket_name, description, and other text fields
Filters to apply to the bucket list. Supports filtering by bucket_id or bucket_name.
Sort options for the bucket list (single-column, legacy)
Sort options for the bucket list as a list of {field, direction} — the shape Studio datatables and the retriever list send. The first entry is the primary sort. Takes precedence over the singular sort.
If True, filters and search will be case-sensitive
Response
Successful Response
Response model for listing buckets.
Total number of buckets matching the query
PaginationResponse.
Cursor-based pagination response:
- Use next_cursor for navigation
- Total count fields only populated when include_total=true
Aggregate statistics across all buckets in the result

