Python SDK
res = client.workflows.versions.list(["my_workflow", "my_workflow_2"])
from cognite.client.data_classes import WorkflowVersionId
res = client.workflows.versions.list(
[WorkflowVersionId("my_workflow"), WorkflowVersionId("my_workflow_2")])
res = client.workflows.versions.list(
[("my_workflow", "1"), ("my_workflow_2", "2")])curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"workflowFilters": [
{
"externalId": "<string>",
"version": "<string>"
}
]
},
"limit": 100,
"cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {workflowFilters: [{externalId: '<string>', version: '<string>'}]},
limit: 100,
cursor: '4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo'
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions/list', 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}/workflows/versions/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'workflowFilters' => [
[
'externalId' => '<string>',
'version' => '<string>'
]
]
],
'limit' => 100,
'cursor' => '4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions/list"
payload := strings.NewReader("{\n \"filter\": {\n \"workflowFilters\": [\n {\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n },\n \"limit\": 100,\n \"cursor\": \"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"workflowFilters\": [\n {\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n },\n \"limit\": 100,\n \"cursor\": \"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"workflowFilters\": [\n {\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n },\n \"limit\": 100,\n \"cursor\": \"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"workflowExternalId": "<string>",
"version": "<string>",
"workflowDefinition": {
"hash": "<string>",
"tasks": [
{
"externalId": "<string>",
"parameters": {
"function": {
"externalId": "my.known.id",
"data": {
"key1": "value1",
"key2": "value2"
}
},
"isAsyncComplete": false
},
"name": "<string>",
"description": "<string>",
"retries": 3,
"timeout": 3600,
"onFailure": "abortWorkflow",
"dependsOn": [
{
"externalId": "my.known.id"
}
],
"lineageAnnotation": {
"sources": [
{
"uri": "cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings"
}
],
"targets": [
{
"uri": "cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings"
}
]
}
}
],
"description": "<string>"
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}
],
"nextCursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}Filter workflow versions
Required capabilities:
workflowOrchestrationACL:READ
List workflow versions matching a given filter.
POST
/
workflows
/
versions
/
list
Python SDK
res = client.workflows.versions.list(["my_workflow", "my_workflow_2"])
from cognite.client.data_classes import WorkflowVersionId
res = client.workflows.versions.list(
[WorkflowVersionId("my_workflow"), WorkflowVersionId("my_workflow_2")])
res = client.workflows.versions.list(
[("my_workflow", "1"), ("my_workflow_2", "2")])curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"workflowFilters": [
{
"externalId": "<string>",
"version": "<string>"
}
]
},
"limit": 100,
"cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {workflowFilters: [{externalId: '<string>', version: '<string>'}]},
limit: 100,
cursor: '4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo'
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions/list', 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}/workflows/versions/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'workflowFilters' => [
[
'externalId' => '<string>',
'version' => '<string>'
]
]
],
'limit' => 100,
'cursor' => '4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions/list"
payload := strings.NewReader("{\n \"filter\": {\n \"workflowFilters\": [\n {\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n },\n \"limit\": 100,\n \"cursor\": \"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"workflowFilters\": [\n {\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n },\n \"limit\": 100,\n \"cursor\": \"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"workflowFilters\": [\n {\n \"externalId\": \"<string>\",\n \"version\": \"<string>\"\n }\n ]\n },\n \"limit\": 100,\n \"cursor\": \"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"workflowExternalId": "<string>",
"version": "<string>",
"workflowDefinition": {
"hash": "<string>",
"tasks": [
{
"externalId": "<string>",
"parameters": {
"function": {
"externalId": "my.known.id",
"data": {
"key1": "value1",
"key2": "value2"
}
},
"isAsyncComplete": false
},
"name": "<string>",
"description": "<string>",
"retries": 3,
"timeout": 3600,
"onFailure": "abortWorkflow",
"dependsOn": [
{
"externalId": "my.known.id"
}
],
"lineageAnnotation": {
"sources": [
{
"uri": "cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings"
}
],
"targets": [
{
"uri": "cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings"
}
]
}
}
],
"description": "<string>"
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}
],
"nextCursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
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.
Body
application/json
Show child attributes
Show child attributes
The maximum number of results to return.
Required range:
1 <= x <= 1000Cursor to use for paging through results. This cursor is returned in the response of a previous request as nextCursor. If not specified, start from the first page of results.
Example:
"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
Last modified on July 10, 2026
Was this page helpful?
⌘I