Skip to main content
GET
GET /v1/pipelines/{id}

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}

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