Skip to main content
GET
/
v1
/
pipelines
/
{id}
GET /v1/pipelines/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Pipelines

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac")
print(f"{pipeline.fullyQualifiedName}: {pipeline.description}")

# Get by ID with fields
pipeline = Pipelines.retrieve(
    "538faa63-d204-46ff-aead-d158d0401cac",
    fields=["owners", "tags", "tasks"]
)

# Get by fully qualified name
pipeline = Pipelines.retrieve_by_name("sample_airflow.dbt_analytics_customers")

# Get by name with fields
pipeline = Pipelines.retrieve_by_name(
    "sample_airflow.dbt_analytics_customers",
    fields=["owners", "tags", "tasks", "domain"]
)

{
  "id": "538faa63-d204-46ff-aead-d158d0401cac",
  "name": "dbt_analytics_customers",
  "displayName": "DBT Customer Analytics",
  "fullyQualifiedName": "sample_airflow.dbt_analytics_customers",
  "description": "Analytics pipeline for customer data processing",
  "version": 0.1,
  "updatedAt": 1769982668397,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:8080/tree?dag_id=dbt_analytics_customers",
  "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": []
}

​
Retrieve a Pipeline

Get a single pipeline by its unique ID or fully qualified name.

​
Get by ID

​
id
string
required
UUID of the pipeline to retrieve.
​
fields
string
Comma-separated list of fields to include (e.g., owners,tags,followers,votes,extension,domains,tasks,sourceHash).
​
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

​
Get by Fully Qualified Name

Use GET /v1/pipelines/name/{fqn} to retrieve by fully qualified name.
​
fqn
string
required
Fully qualified name of the pipeline (e.g., sample_airflow.dbt_analytics_customers).
​
fields
string
Comma-separated list of fields to include: owners, tags, followers, votes, extension, domains, tasks, sourceHash.
​
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/pipelines/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Pipelines

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac")
print(f"{pipeline.fullyQualifiedName}: {pipeline.description}")

# Get by ID with fields
pipeline = Pipelines.retrieve(
    "538faa63-d204-46ff-aead-d158d0401cac",
    fields=["owners", "tags", "tasks"]
)

# Get by fully qualified name
pipeline = Pipelines.retrieve_by_name("sample_airflow.dbt_analytics_customers")

# Get by name with fields
pipeline = Pipelines.retrieve_by_name(
    "sample_airflow.dbt_analytics_customers",
    fields=["owners", "tags", "tasks", "domain"]
)

{
  "id": "538faa63-d204-46ff-aead-d158d0401cac",
  "name": "dbt_analytics_customers",
  "displayName": "DBT Customer Analytics",
  "fullyQualifiedName": "sample_airflow.dbt_analytics_customers",
  "description": "Analytics pipeline for customer data processing",
  "version": 0.1,
  "updatedAt": 1769982668397,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:8080/tree?dag_id=dbt_analytics_customers",
  "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": []
}

​
Returns

Returns a pipeline object with all requested fields populated.

​
Response

​
id
string
Unique identifier for the pipeline (UUID format).
​
name
string
Pipeline name.
​
fullyQualifiedName
string
Fully qualified name in format service.pipelineName.
​
displayName
string
Human-readable display name.
​
description
string
Description of the pipeline in Markdown format.
​
sourceUrl
string
URL to the pipeline in the source system.
​
service
object
Reference to the parent pipeline service.
​
serviceType
string
Type of pipeline service (e.g., Airflow, Dagster, DBTCloud).
​
tasks
array
Pipeline tasks. Only included when fields contains tasks.
​
version
number
Version number for the entity.
​
owners
array
List of owners. Only included when fields contains owners.
​
tags
array
Classification tags. Only included when fields contains tags.
​
domains
array
Domain assignments. Only included when fields contains domains.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to view this pipeline
404NOT_FOUNDPipeline with given ID or FQN does not exist