Method: datasets.list

Lists all datasets in the specified project to which the user has been granted the READER dataset role.

HTTP request

GET https://bigquery.googleapis.com/bigquery/v2/projects/{projectId}/datasets

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

Required. Project ID of the datasets to be listed

Query parameters

Parameters
maxResults

integer

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

pageToken

string

Page token, returned by a previous call, to request the next page of results

all

boolean

Whether to list all datasets, including hidden ones

filter

string

An expression for filtering the results of the request by label. The syntax is "labels.<name>[:<value>]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.

Request body

The request body must be empty.

Response body

Response format for a page of results when listing datasets.

If successful, the response body contains data with the following structure:

JSON representation
{
  "kind": string,
  "etag": string,
  "nextPageToken": string,
  "datasets": [
    {
      "kind": string,
      "id": string,
      "datasetReference": {
        object (DatasetReference)
      },
      "labels": {
        string: string,
        ...
      },
      "friendlyName": string,
      "location": string
    }
  ],
  "unreachable": [
    string
  ]
}
Fields
kind

string

Output only. The resource type. This property always returns the value "bigquery#datasetList"

etag

string

Output only. A hash value of the results page. You can use this property to determine if the page has changed since the last request.

nextPageToken

string

A token that can be used to request the next results page. This property is omitted on the final results page.