Datasets: list

Requires authorization

Lists all datasets in the specified project to which you have been granted the READER dataset role.


HTTP request



Parameter name Value Description
Path parameters
projectId string Project ID of the datasets to be listed
Optional query parameters
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". See Filtering datasets using labels for details.
maxResults unsigned integer The maximum number of results to return
pageToken string Page token, returned by a previous call, to request the next page of results


This request requires authorization with at least one of the following scopes (read more about authentication and authorization).


Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "bigquery#datasetList",
  "etag": etag,
  "nextPageToken": string,
  "datasets": [
      "kind": "bigquery#dataset",
      "id": string,
      "datasetReference": {
        "datasetId": string,
        "projectId": string
      "labels": {
        (key): string
      "friendlyName": string,
      "location": string
Property name Value Description Notes
kind bigquery#datasetList The list type. This property always returns the value "bigquery#datasetList".
etag etag 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.
datasets[] list An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.
datasets[].kind string The resource type. This property always returns the value "bigquery#dataset".
datasets[].id string The fully-qualified, unique, opaque ID of the dataset.
datasets[].datasetReference nested object The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID.
datasets[].datasetReference.datasetId string [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
datasets[].datasetReference.projectId string [Optional] The ID of the project containing this dataset.
datasets[].friendlyName string A descriptive name for the dataset, if one exists.
datasets[].labels object The labels associated with this dataset. You can use these to organize and group your datasets.
datasets[].labels.(key) string
datasets[].location string The geographic location where the data resides.

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.

Was this page helpful? Let us know how we did:

Send feedback about...