GET /v1/services/pipelineServices/{id}

import requests

base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# Get by ID
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
    headers=headers
)
service = response.json()
print(f"{service['fullyQualifiedName']}: {service['serviceType']}")

# Get by ID with fields
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5?fields=owners,tags,domains",
    headers=headers
)

# Get by fully qualified name
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow",
    headers=headers
)

# Get by name with fields
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow?fields=owners,tags,domains",
    headers=headers
)

import org.openmetadata.schema.entity.services.PipelineService;
import org.openmetadata.sdk.fluent.PipelineServices;

// client is an initialized OpenMetadataClient.
PipelineServices.setDefaultClient(client);

// Get by ID
PipelineService service = PipelineServices.retrieve("daa58a49-df05-48a3-a417-45dfd12eacf5");

// Get by ID with fields
PipelineService serviceWithFields = PipelineServices.retrieve(
    "daa58a49-df05-48a3-a417-45dfd12eacf5",
    "owners,tags,domains"
);

// Get by fully qualified name
PipelineService serviceByName = PipelineServices.retrieveByName("sample_airflow");

// Get by name with fields
PipelineService serviceByNameWithFields = PipelineServices.retrieveByName("sample_airflow", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

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

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

{
  "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
  "name": "sample_airflow",
  "fullyQualifiedName": "sample_airflow",
  "serviceType": "Airflow",
  "version": 0.1,
  "updatedAt": 1769982621418,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

GET

services

pipelineServices

{id}

GET /v1/services/pipelineServices/{id}

import requests

base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# Get by ID
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
    headers=headers
)
service = response.json()
print(f"{service['fullyQualifiedName']}: {service['serviceType']}")

# Get by ID with fields
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5?fields=owners,tags,domains",
    headers=headers
)

# Get by fully qualified name
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow",
    headers=headers
)

# Get by name with fields
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow?fields=owners,tags,domains",
    headers=headers
)

import org.openmetadata.schema.entity.services.PipelineService;
import org.openmetadata.sdk.fluent.PipelineServices;

// client is an initialized OpenMetadataClient.
PipelineServices.setDefaultClient(client);

// Get by ID
PipelineService service = PipelineServices.retrieve("daa58a49-df05-48a3-a417-45dfd12eacf5");

// Get by ID with fields
PipelineService serviceWithFields = PipelineServices.retrieve(
    "daa58a49-df05-48a3-a417-45dfd12eacf5",
    "owners,tags,domains"
);

// Get by fully qualified name
PipelineService serviceByName = PipelineServices.retrieveByName("sample_airflow");

// Get by name with fields
PipelineService serviceByNameWithFields = PipelineServices.retrieveByName("sample_airflow", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

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

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

{
  "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
  "name": "sample_airflow",
  "fullyQualifiedName": "sample_airflow",
  "serviceType": "Airflow",
  "version": 0.1,
  "updatedAt": 1769982621418,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

Retrieve a Pipeline Service

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

Get by ID

string

required

UUID of the pipeline service to retrieve.

string

Comma-separated list of fields to include, for example owners,tags,domains.

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/services/pipelineServices/name/{fqn} to retrieve by fully qualified name.

string

required

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

string

Comma-separated list of fields to include: owners, tags, domains.

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/services/pipelineServices/{id}

import requests

base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# Get by ID
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
    headers=headers
)
service = response.json()
print(f"{service['fullyQualifiedName']}: {service['serviceType']}")

# Get by ID with fields
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5?fields=owners,tags,domains",
    headers=headers
)

# Get by fully qualified name
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow",
    headers=headers
)

# Get by name with fields
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow?fields=owners,tags,domains",
    headers=headers
)

import org.openmetadata.schema.entity.services.PipelineService;
import org.openmetadata.sdk.fluent.PipelineServices;

// client is an initialized OpenMetadataClient.
PipelineServices.setDefaultClient(client);

// Get by ID
PipelineService service = PipelineServices.retrieve("daa58a49-df05-48a3-a417-45dfd12eacf5");

// Get by ID with fields
PipelineService serviceWithFields = PipelineServices.retrieve(
    "daa58a49-df05-48a3-a417-45dfd12eacf5",
    "owners,tags,domains"
);

// Get by fully qualified name
PipelineService serviceByName = PipelineServices.retrieveByName("sample_airflow");

// Get by name with fields
PipelineService serviceByNameWithFields = PipelineServices.retrieveByName("sample_airflow", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

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

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

{
  "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
  "name": "sample_airflow",
  "fullyQualifiedName": "sample_airflow",
  "serviceType": "Airflow",
  "version": 0.1,
  "updatedAt": 1769982621418,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

Returns

Returns a pipeline service object with all requested fields populated.

Response

string

Unique identifier for the pipeline service (UUID format).

string

Pipeline service name.

string

Fully qualified name of the service.

string

Human-readable display name.

string

Description of the pipeline service in Markdown format.

string

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

object

Connection configuration for the service.

Show properties

object

Service-specific connection configuration.

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 service
`404`	`NOT_FOUND`	Pipeline service with given ID or FQN does not exist

API Reference

SDK

API

Data Assets

AI Assets

Discovery

Lineage

Data Contracts

Teams & Users

Data Governance

Data Quality

Alerts

Incidents

Billing

Query Runner

Context Plugins

Standards

Retrieve a Pipeline Service

Retrieve a Pipeline Service

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling