get

HTTP Request

GET /api/v1/datasets/:datasetId/versions/:versionTag|latest

Parameters

Value

Description

Path parameters

:organizationShortName

string

Short name of the organization (provide either this or the id)

:organizationId

integer

Id of the organization (provide either this or the shortName)

Query parameters

fields

string

Required. Comma-separated list of fields.

maxResults

unsigned integer

Optional. Maximum number of results to return. Defaults to 25, may not exceed 100.

pageToken

string

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

accessLevel

string

Optional. The requesting user's access level to the dataset. Must be one of overview ,metadata ,data

Request body

Do not supply a request body with this method.

Authorization

Optional. Only publicly visible datasets will be returned if no authorization is provided.

An API access token can be specified in the request header or as a query parameter (read more). In this case, only datasets visible to the access token's owner will be returned.

Response

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

{
"kind": "versionList",
"nextPageToken": string,
"versions": [
{
"kind": "version",
"id": integer,
"tag": string,
}
]
}