Bigquery.tables.list

Lists all tables in the specified dataset. Requires the READER dataset role.

GET/projects/{projectId}/datasets/{datasetId}/tables

Use it in a workflow

Add a step and choose the BigQuery connector.
Pick the Bigquery.tables.list action (under tables).
Fill in the fields below, then reference the result from later steps as {{bigqueryTablesList.response.data}}.

Request

Path parameters

projectIdstringrequired

Project ID of the tables to list

datasetIdstringrequired

Dataset ID of the tables to list

Query parameters

altstring

Data format for the response.

One ofjson

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIpstring

Deprecated. Please use quotaUser instead.

maxResultsinteger

Maximum number of results to return

pageTokenstring

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

Response

Returns 200 with an object. Read it in later steps with {{bigqueryTablesList.response.data.<field>}}.

etagstring

A hash of this page of results.

kindstring

The type of list.

Default "bigquery#tableList"

nextPageTokenstring

A token to request the next page of results.

tablesarray<object>

Tables in the requested dataset.

clusteringobject1 fields

creationTimestring (int64)

The time when this table was created, in milliseconds since the epoch.

expirationTimestring (int64)

[Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.

friendlyNamestring

The user-friendly name for this table.

idstring

An opaque ID of the table

kindstring

The resource type.

Default "bigquery#table"

labelsobject

The labels associated with this table. You can use these to organize and group your tables.

rangePartitioningobject2 fields

tableReferenceobject3 fields

timePartitioningobject4 fields

typestring

The type of table. Possible values are: TABLE, VIEW.

viewobject1 fields

Additional details for a view.

totalItemsinteger (int32)

The total number of tables in the dataset.

json

{
  "etag": "string",
  "kind": "bigquery#tableList",
  "nextPageToken": "string",
  "tables": [
    {
      "clustering": {
        "fields": [
          "string"
        ]
      },
      "creationTime": "string",
      "expirationTime": "string",
      "friendlyName": "string",
      "id": "string",
      "kind": "bigquery#table",
      "labels": {},
      "rangePartitioning": {
        "field": "string",
        "range": {
          "end": "string",
          "interval": "string",
          "start": "string"
        }
      },
      "tableReference": {
        "datasetId": "string",
        "projectId": "string",
        "tableId": "string"
      },
      "timePartitioning": {
        "expirationMs": "string",
        "field": "string",
        "requirePartitionFilter": false,
        "type": "string"
      },
      "type": "string",
      "view": {
        "useLegacySql": false
      }
    }
  ],
  "totalItems": 0
}

Need more? See the BigQuery guide for connection setup and behaviour shared by every action.

Was this page helpful?