Get a data product version

GET

dataproducts

{externalId}

versions

{version}

Get a data product version

curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "version": "1.2.34",
  "views": [
    {
      "space": "<string>",
      "externalId": "<string>",
      "version": "<string>"
    }
  ],
  "status": "draft",
  "terms": {
    "usage": "<string>",
    "limitations": "<string>"
  },
  "createdTime": 1730204346000,
  "lastUpdatedTime": 1730204346000,
  "description": "<string>"
}

{
  "error": {
    "code": 401,
    "message": "Could not authenticate.",
    "missing": [
      {}
    ],
    "duplicated": [
      {}
    ]
  }
}

Authorizations

Authorization

string

header

required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Path Parameters

externalId

string

required

Data product external identifier

Required string length: 1 - 100

Pattern: ^[a-z]([a-z0-9_-]{0,98}[a-z0-9])?$

version

string

required

The semantic version of the data product version to retrieve. A semantic version number. We currently use a simplified version of what is described at semver.org.

Required string length: 5 - 14

Pattern: ^(0|[1-9]\d{0,3})\.(0|[1-9]\d{0,3})\.(0|[1-9]\d{0,3})$

Example:

"1.2.34"

Response

The requested data product version.

A version of a data product, with a collection of data modeling view references. Each item of the collection is immutable (it may not be modified or removed later), but items may be added later. A data product can have up to 10 versions.

version

string

required

The semantic version of this data product version. Together, the data product external id (in the request path) and the semantic version uniquely identifies this data product version. Note that even if a data product version is deleted, its semantic version may never be reused within its owning data product. We currently use a simplified version of what is described at semver.org, only allowing major.minor.patch with up to four digits in each.

Required string length: 5 - 14

Pattern: ^(0|[1-9]\d{0,3})\.(0|[1-9]\d{0,3})\.(0|[1-9]\d{0,3})$

Example:

"1.2.34"

views

object[]

required

A collection of references to views (with versions) that are associated with this data product version. Each item of the collection is immutable (it may not be modified or removed later), but items may be added later.

Maximum array length: 100

Show child attributes

status

enum<string>

required

The status of this data product version.

Available options:

draft,

published,

deprecated

terms

object

required

Terms and conditions for using this data product version.

Show child attributes

createdTime

integer<int64>

required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

lastUpdatedTime

integer<int64>

required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0

Example:

1730204346000

description

string<markdown>

A detailed description of this specific version of the data product. The text will be interpreted as markdown.

Maximum string length: 2000

Last modified on September 24, 2026

⌘I

Get a data product version

curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/{externalId}/versions/{version}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "version": "1.2.34",
  "views": [
    {
      "space": "<string>",
      "externalId": "<string>",
      "version": "<string>"
    }
  ],
  "status": "draft",
  "terms": {
    "usage": "<string>",
    "limitations": "<string>"
  },
  "createdTime": 1730204346000,
  "lastUpdatedTime": 1730204346000,
  "description": "<string>"
}

{
  "error": {
    "code": 401,
    "message": "Could not authenticate.",
    "missing": [
      {}
    ],
    "duplicated": [
      {}
    ]
  }
}