buckets

List buckets

List the organization's connected buckets.

Non-secret auth metadata (auth type, role ARN, external ID) is included; access-key credentials are never returned.

Args: options: The pagination options.

Returns: BucketListResponse: The list of buckets.

get/v1/buckets

Request

Base URL
https://api.mixedbread.com
URL
https://api.mixedbread.com/v1/buckets
Auth
HTTP bearer

Query parameters

limitinteger

Maximum number of items to return per page (1-100)

Example:10

afterstring nullable

Cursor for forward pagination - get items after this position. Use last_cursor from previous response.

Example:eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==

beforestring nullable

Cursor for backward pagination - get items before this position. Use first_cursor from previous response.

Example:eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==

include_totalboolean

Whether to include total count in response (expensive operation)

Response

The organization's buckets

object'list'

The object type of the response

Example response

{
  "pagination": {
    "has_more": true,
    "first_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==",
    "last_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMFQyMzo1OTo1OS4wMDBaIiwiaWQiOiJ4eXo3ODkifQ==",
    "total": 42
  }
}

Changes

No recorded changes to this operation across all 44 revisions of this API.