get

HTTP Request

GET /api/v1/datasets/:datasetReference

Path parameters

Parameter

datasetReference

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

This endpoint extends the general API structure.

Authorization

Overview access to the dataset is required. 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.

If you are requesting the "next" (unreleased) version of a dataset, you must have edit access with and use a token with data.edit scope.

Request body

The request body must be empty.

Response body

Returns a JSON representation of a dataset resource.

Examples

curl
curl
# Get the IPUMS 1940 dataset from the StanfordPHS organization
curl -H "Authorization: Bearer $REDIVIS_ACCESS_TOKEN" \
"https://redivis.com/api/v1/datasets/stanfordphs.ipums_1940"