list

HTTP Request

GET /api/v1/datasets/:datasetReference/tables
GET /api/v1/projects/:projectReference/tables

Path parameters

Parameter

datasetReference

A qualified reference to the dataset. See referencing resources for more information.

projectReference

A qualified reference to the project. See referencing resources for more information.

Query parameters

Parameter

includeDatasetTables

Whether to include the tables that belong to datasets that have been added to this project. Defaults to false.

maxResults

Default 100. Must be less than 1000.

nextPageToken

For paginating through results, provide the value returned from the previous table.list call

This endpoint extends the general API structure.

Authorization

Only datasets to which you have overview access will be returned. If a dataset's overview is not public, your access token must have one of the following scopes:

  • data.overview

  • data.metadata

  • data.data

  • data.edit

Learn more about authorization.

Request body

The request body must be empty.

Response body

Returns a JSON representation of an array of table resources.

{
"kind": "tableList",
"nextPageToken": integer,
"results": [
object(table.list)
]
}

Examples

curl
curl
# List the tables on the EPA Air Quality dataset from the StanfordPHS organization
curl -H "Authorization: Bearer $REDIVIS_ACCESS_TOKEN" \
"https://redivis.com/api/v1/datasets/stanfordphs.epa_air_quality/tables"