Sign in
Bucket Objects

List Objects (GET)

List objects in a bucket via GET with cursor-based pagination. Use POST /list for filtering and sorting.

get/v1/buckets/{bucket_identifier}/objects

Path parameters

bucket_identifierstring required

The unique identifier of the bucket.

The unique identifier of the bucket.

Query parameters

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Response

Successful Response

Example response

{
  "pagination": {
    "has_more": false,
    "limit": 10,
    "skip": 0
  },
  "results": [
    {
      "blobs": [],
      "bucket_id": "bkt_9xy8z7",
      "created_at": "2024-10-21T10:30:00Z",
      "key_prefix": "/contract-2024",
      "metadata": {
        "category": "contracts",
        "year": 2024
      },
      "object_id": "obj_123abc456def",
      "status": "DRAFT",
      "updated_at": "2024-10-21T10:30:00Z"
    }
  ]
}

Changes

Changed in 4 of the 30 revisions of this API.23

  • 1c7f318214241See the full diff
    • ●

      added the new signals enum value to the results/items/source_details/items/type response property for the response status 200

      response-property-enum-value-added

  • 5d4c905106b41See the full diff
    • ○

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API

      api-security-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9603dfdab4631See the full diff
    • ●

      added the new DEACTIVATED enum value to the results/items/status response property for the response status 200

      response-property-enum-value-added

  • 72cc17ba6f7f2See the full diff
    • ○

      added the new optional query request parameter after

      new-optional-request-parameter

    • ○

      added the new optional query request parameter next_cursor

      new-optional-request-parameter