GET /v1/pipelines
from metadata.sdk import configure
from metadata.sdk.entities import Pipelines
configure(
host="https://your-company.getcollate.io/api",
jwt_token="your-jwt-token"
)
# List first page
pipelines = Pipelines.list(limit=50)
for p in pipelines.data:
print(f"{p.fullyQualifiedName}")
# List all with auto-pagination
for p in Pipelines.list_all():
print(f"{p.fullyQualifiedName}")
# Filter by service
pipelines = Pipelines.list(
service="sample_airflow",
fields=["owners", "tags", "tasks"],
limit=50
)
for p in pipelines.data:
print(f"{p.fullyQualifiedName}")
if p.owners:
print(f" Owners: {[o.name for o in p.owners]}")
if p.tasks:
print(f" Tasks: {[t.name for t in p.tasks]}")
import static org.openmetadata.sdk.fluent.Pipelines.*;
// List first page
var result = Pipelines.list()
.limit(50)
.execute();
for (var p : result.getData()) {
System.out.println(p.getFullyQualifiedName());
}
// Filter by service with fields
var result = Pipelines.list()
.service("sample_airflow")
.fields("owners", "tags", "tasks")
.limit(50)
.execute();
for (var p : result.getData()) {
System.out.println(p.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/pipelines?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/pipelines?service=sample_airflow&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/pipelines?service=sample_airflow&fields=owners,tags,tasks,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "538faa63-d204-46ff-aead-d158d0401cac",
"name": "dbt_analytics_customers",
"displayName": "DBT Customer Analytics",
"fullyQualifiedName": "sample_airflow.dbt_analytics_customers",
"version": 0.1,
"updatedAt": 1769982668397,
"updatedBy": "admin",
"service": {
"id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
"type": "pipelineService",
"name": "sample_airflow",
"fullyQualifiedName": "sample_airflow",
"deleted": false
},
"serviceType": "DBTCloud",
"href": "http://localhost:8585/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac",
"deleted": false,
"owners": [],
"tags": [],
"followers": [],
"votes": {
"upVotes": 0,
"downVotes": 0
},
"domains": []
}
],
"paging": {
"after": "...",
"total": 5
}
}
List Pipelines
List all pipeline entities with optional filtering by service, schedule type, owner, tag, domain, and pagination support via the Collate REST API.
GET
/
v1
/
pipelines
GET /v1/pipelines
from metadata.sdk import configure
from metadata.sdk.entities import Pipelines
configure(
host="https://your-company.getcollate.io/api",
jwt_token="your-jwt-token"
)
# List first page
pipelines = Pipelines.list(limit=50)
for p in pipelines.data:
print(f"{p.fullyQualifiedName}")
# List all with auto-pagination
for p in Pipelines.list_all():
print(f"{p.fullyQualifiedName}")
# Filter by service
pipelines = Pipelines.list(
service="sample_airflow",
fields=["owners", "tags", "tasks"],
limit=50
)
for p in pipelines.data:
print(f"{p.fullyQualifiedName}")
if p.owners:
print(f" Owners: {[o.name for o in p.owners]}")
if p.tasks:
print(f" Tasks: {[t.name for t in p.tasks]}")
import static org.openmetadata.sdk.fluent.Pipelines.*;
// List first page
var result = Pipelines.list()
.limit(50)
.execute();
for (var p : result.getData()) {
System.out.println(p.getFullyQualifiedName());
}
// Filter by service with fields
var result = Pipelines.list()
.service("sample_airflow")
.fields("owners", "tags", "tasks")
.limit(50)
.execute();
for (var p : result.getData()) {
System.out.println(p.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/pipelines?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/pipelines?service=sample_airflow&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/pipelines?service=sample_airflow&fields=owners,tags,tasks,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "538faa63-d204-46ff-aead-d158d0401cac",
"name": "dbt_analytics_customers",
"displayName": "DBT Customer Analytics",
"fullyQualifiedName": "sample_airflow.dbt_analytics_customers",
"version": 0.1,
"updatedAt": 1769982668397,
"updatedBy": "admin",
"service": {
"id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
"type": "pipelineService",
"name": "sample_airflow",
"fullyQualifiedName": "sample_airflow",
"deleted": false
},
"serviceType": "DBTCloud",
"href": "http://localhost:8585/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac",
"deleted": false,
"owners": [],
"tags": [],
"followers": [],
"votes": {
"upVotes": 0,
"downVotes": 0
},
"domains": []
}
],
"paging": {
"after": "...",
"total": 5
}
}
List Pipelines
List all pipelines with optional filtering and pagination.Query Parameters
string
Filter by pipeline service fully qualified name.
integer
default:"10"
Maximum number of results to return (max: 1000000).
string
Cursor for backward pagination.
string
Cursor for forward pagination.
string
Comma-separated list of fields to include:
owners, tags, followers, votes, extension, domains, tasks, sourceHash. See Supported Fields below.string
default:"non-deleted"
Include
all, deleted, or non-deleted entities.GET /v1/pipelines
from metadata.sdk import configure
from metadata.sdk.entities import Pipelines
configure(
host="https://your-company.getcollate.io/api",
jwt_token="your-jwt-token"
)
# List first page
pipelines = Pipelines.list(limit=50)
for p in pipelines.data:
print(f"{p.fullyQualifiedName}")
# List all with auto-pagination
for p in Pipelines.list_all():
print(f"{p.fullyQualifiedName}")
# Filter by service
pipelines = Pipelines.list(
service="sample_airflow",
fields=["owners", "tags", "tasks"],
limit=50
)
for p in pipelines.data:
print(f"{p.fullyQualifiedName}")
if p.owners:
print(f" Owners: {[o.name for o in p.owners]}")
if p.tasks:
print(f" Tasks: {[t.name for t in p.tasks]}")
import static org.openmetadata.sdk.fluent.Pipelines.*;
// List first page
var result = Pipelines.list()
.limit(50)
.execute();
for (var p : result.getData()) {
System.out.println(p.getFullyQualifiedName());
}
// Filter by service with fields
var result = Pipelines.list()
.service("sample_airflow")
.fields("owners", "tags", "tasks")
.limit(50)
.execute();
for (var p : result.getData()) {
System.out.println(p.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/pipelines?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/pipelines?service=sample_airflow&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/pipelines?service=sample_airflow&fields=owners,tags,tasks,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "538faa63-d204-46ff-aead-d158d0401cac",
"name": "dbt_analytics_customers",
"displayName": "DBT Customer Analytics",
"fullyQualifiedName": "sample_airflow.dbt_analytics_customers",
"version": 0.1,
"updatedAt": 1769982668397,
"updatedBy": "admin",
"service": {
"id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
"type": "pipelineService",
"name": "sample_airflow",
"fullyQualifiedName": "sample_airflow",
"deleted": false
},
"serviceType": "DBTCloud",
"href": "http://localhost:8585/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac",
"deleted": false,
"owners": [],
"tags": [],
"followers": [],
"votes": {
"upVotes": 0,
"downVotes": 0
},
"domains": []
}
],
"paging": {
"after": "...",
"total": 5
}
}
Returns
Returns a paginated list of pipeline objects. By default, only basic fields are included. Use thefields parameter to request additional data.
Response
array
Array of pipeline objects.
Show properties
Show properties
string
Unique identifier for the pipeline (UUID format).
string
Pipeline name.
string
Fully qualified name in format
service.pipelineName.string
Human-readable display name.
object
Reference to the parent pipeline service.
string
Type of pipeline service (e.g., Airflow, Dagster, DBTCloud).
array
List of pipeline tasks. Only included when
fields contains tasks.array
List of owners assigned to the pipeline. Only included when
fields contains owners.array
Classification tags applied. Only included when
fields contains tags.array
Domain assignments for governance. Only included when
fields contains domains.array
Users following this pipeline. Only included when
fields contains followers.object
User votes and ratings. Only included when
fields contains votes.object
Custom properties. Only included when
fields contains extension.object
Supported Fields
The following fields can be requested via thefields query parameter:
| Field | Description |
|---|---|
owners | Owner references (users and teams) |
tags | Classification tags |
followers | Users following the pipeline |
votes | User votes and ratings |
extension | Custom property values |
domains | Domain assignments for governance |
tasks | Pipeline task definitions |
sourceHash | Hash for change detection |
Error Handling
| Code | Error Type | Description |
|---|---|---|
401 | UNAUTHORIZED | Invalid or missing authentication token |
403 | FORBIDDEN | User lacks permission to list pipelines |
Was this page helpful?
⌘I