GET /v1/pipelines/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Pipelines

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac")
print(f"{pipeline.fullyQualifiedName.root}: {getattr(pipeline.description, 'root', 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", "domains"]
)

import org.openmetadata.schema.entity.data.Pipeline;

// client is an initialized OpenMetadataClient.

// Get by ID
Pipeline pipeline = client.pipelines().get("538faa63-d204-46ff-aead-d158d0401cac");

// Get by ID with fields
Pipeline pipelineWithFields = client.pipelines().get(
    "538faa63-d204-46ff-aead-d158d0401cac",
    "owners,tags,tasks"
);

// Get by fully qualified name
Pipeline pipelineByName = client.pipelines().getByName("sample_airflow.dbt_analytics_customers");

// Get by name with fields
Pipeline pipelineByNameWithFields = client.pipelines().getByName(
    "sample_airflow.dbt_analytics_customers",
    "owners,tags,tasks,domains"
);

# Get by ID
curl "{base_url}/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac?fields=owners,tags,tasks,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/pipelines/name/sample_airflow.dbt_analytics_customers" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/pipelines/name/sample_airflow.dbt_analytics_customers?fields=owners,tags,tasks,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

GET

pipelines

{id}

GET /v1/pipelines/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Pipelines

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac")
print(f"{pipeline.fullyQualifiedName.root}: {getattr(pipeline.description, 'root', 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", "domains"]
)

import org.openmetadata.schema.entity.data.Pipeline;

// client is an initialized OpenMetadataClient.

// Get by ID
Pipeline pipeline = client.pipelines().get("538faa63-d204-46ff-aead-d158d0401cac");

// Get by ID with fields
Pipeline pipelineWithFields = client.pipelines().get(
    "538faa63-d204-46ff-aead-d158d0401cac",
    "owners,tags,tasks"
);

// Get by fully qualified name
Pipeline pipelineByName = client.pipelines().getByName("sample_airflow.dbt_analytics_customers");

// Get by name with fields
Pipeline pipelineByNameWithFields = client.pipelines().getByName(
    "sample_airflow.dbt_analytics_customers",
    "owners,tags,tasks,domains"
);

# Get by ID
curl "{base_url}/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac?fields=owners,tags,tasks,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/pipelines/name/sample_airflow.dbt_analytics_customers" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/pipelines/name/sample_airflow.dbt_analytics_customers?fields=owners,tags,tasks,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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

string

required

UUID of the pipeline to retrieve.

string

Comma-separated list of fields to include, for example owners,tags,followers,votes,extension,domains,tasks,sourceHash.

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.

string

required

Fully qualified name of the pipeline, for example sample_airflow.dbt_analytics_customers.

string

Comma-separated list of fields to include: owners, tags, followers, votes, extension, domains, tasks, sourceHash.

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.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac")
print(f"{pipeline.fullyQualifiedName.root}: {getattr(pipeline.description, 'root', 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", "domains"]
)

import org.openmetadata.schema.entity.data.Pipeline;

// client is an initialized OpenMetadataClient.

// Get by ID
Pipeline pipeline = client.pipelines().get("538faa63-d204-46ff-aead-d158d0401cac");

// Get by ID with fields
Pipeline pipelineWithFields = client.pipelines().get(
    "538faa63-d204-46ff-aead-d158d0401cac",
    "owners,tags,tasks"
);

// Get by fully qualified name
Pipeline pipelineByName = client.pipelines().getByName("sample_airflow.dbt_analytics_customers");

// Get by name with fields
Pipeline pipelineByNameWithFields = client.pipelines().getByName(
    "sample_airflow.dbt_analytics_customers",
    "owners,tags,tasks,domains"
);

# Get by ID
curl "{base_url}/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac?fields=owners,tags,tasks,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/pipelines/name/sample_airflow.dbt_analytics_customers" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/pipelines/name/sample_airflow.dbt_analytics_customers?fields=owners,tags,tasks,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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

string

Unique identifier for the pipeline (UUID format).

string

Pipeline name.

string

Fully qualified name in format service.pipelineName.

string

Human-readable display name.

string

Description of the pipeline in Markdown format.

string

URL to the pipeline in the source system.

object

Reference to the parent pipeline service.

Show properties

string

UUID of the pipeline service.

string

Type of entity (always pipelineService).

string

Name of the pipeline service.

string

Fully qualified name of the pipeline service.

string

Type of pipeline service, for example Airflow, Dagster, DBTCloud.

array

Pipeline tasks. Only included when fields contains tasks.

Show properties

string

Name of the task.

string

Type of the task.

string

Description of the task.

array

Names of downstream dependent tasks.

number

Version number for the entity.

array

List of owners. Only included when fields contains owners.

array

Classification tags. Only included when fields contains tags.

array

Domain assignments. Only included when fields contains domains.

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this pipeline
`404`	`NOT_FOUND`	Pipeline with given ID or FQN does not exist

API Reference

Data Assets

Collaboration

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Retrieve a Pipeline

Retrieve a Pipeline

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling