---
title: "Get bucket listing detail"
method: GET
path: "/v2/storage/buckets/{bucketId}/listing"
tags: ["Buckets"]
---

# Get bucket listing detail

`GET /v2/storage/buckets/{bucketId}/listing`

## Request

- Base URL: `https://connection.keboola.com`
- URL: `https://connection.keboola.com/v2/storage/buckets/{bucketId}/listing`
- Auth: one of:
  - API key in header `X-StorageApi-Token`
  - API key in header `X-KBC-ManageApiToken`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/keboola/apis/keboola-storage-api/docs/v2/storage/buckets/:bucketId/listing/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the listing configured on a bucket. Data is read from the database — no backend API call is performed.

## Path parameters

- `bucketId` string, required

## Response `200`

Bucket listing detail.

- BucketListingDetailResponse
  - `name` string, required: Human-readable listing name (used as the backend listing displayName).
  - `description` string: Listing description. Omitted from the response when not set.
  - `backend` 'bigquery' | 'snowflake', required: Backend of the listed bucket.
  - `bigquery` BigQueryBucketListingDetailResponse
    - `listingId` string, required: User-defined listing ID (unique within the exchange).
    - `listingResourceName` string: GCP listing resource name. Omitted from the response when the listing has not yet been provisioned (the async job is still running or has failed).
    - `subscribers` string[], required: IAM principals with subscriber access (each prefixed with `user:` or `group:`).
  - `snowflake` SnowflakeBucketListingDetailResponse
    - `mode` 'grant' | 'share', required: `grant`: roles in the backend's account read the bucket schema. `share`: other accounts read it through a Snowflake share.
    - `grantees` string[]: Grantee roles, upper case. Present only in `grant` mode.
    - `accounts` string[]: Consumer accounts (`<ORGANIZATION>.<ACCOUNT>`), upper case. Present only in `share` mode.
    - `objectName` string, nullable, required: Quoted name of the exposed object: `"<DATABASE>"."<SCHEMA>"` in `grant` mode, the share name in `share` mode. Null until the create job has provisioned the exposure.
  - `createdAt` string, date-time, required: Listing creation timestamp.

## Other responses

- `403`: Returned when the token does not have read privilege on the bucket.
- `404`: Returned when the bucket is not found or has no listing.

---

[API](https://skmtc.dev/keboola/apis/keboola-storage-api.md) - [All operations](https://skmtc.dev/keboola/apis/keboola-storage-api/llms.txt) - [OpenAPI document](https://skmtc.dev/keboola/apis/keboola-storage-api/revisions/34b5ceac0317?raw)