> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a Pipeline Service

> Get a pipeline service by ID or fully qualified name

# Retrieve a Pipeline Service

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

## Get by ID

<ParamField path="id" type="string" required>
  UUID of the pipeline service to retrieve.
</ParamField>

<ParamField query="fields" type="string">
  Comma-separated list of fields to include (e.g., `owners,tags,domains`).
</ParamField>

<ParamField query="include" type="string" default="non-deleted">
  Include `all`, `deleted`, or `non-deleted` entities.
</ParamField>

## Get by Fully Qualified Name

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

<ParamField path="fqn" type="string" required>
  Fully qualified name of the pipeline service (e.g., `sample_airflow`).
</ParamField>

<ParamField query="fields" type="string">
  Comma-separated list of fields to include: `owners`, `tags`, `domains`.
</ParamField>

<ParamField query="include" type="string" default="non-deleted">
  Include `all`, `deleted`, or `non-deleted` entities.
</ParamField>

<RequestExample dropdown>
  ```python GET /v1/services/pipelineServices/{id} theme={null}
  import requests

  base_url = "https://your-company.open-metadata.org/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
  )
  ```

  ```java GET /v1/services/pipelineServices/{id} theme={null}
  import static org.openmetadata.sdk.fluent.PipelineServices.*;

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

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

  // Get by fully qualified name
  var svc = PipelineServices.retrieveByName("sample_airflow");

  // Get by name with fields
  var svc = PipelineServices.retrieveByName("sample_airflow", "owners,tags,domains");
  ```

  ```bash GET /v1/services/pipelineServices/{id} theme={null}
  # 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}"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "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": []
  }
  ```
</ResponseExample>

***

## Returns

Returns a pipeline service object with all requested fields populated.

## Response

<ResponseField name="id" type="string">
  Unique identifier for the pipeline service (UUID format).
</ResponseField>

<ResponseField name="name" type="string">
  Pipeline service name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name of the service.
</ResponseField>

<ResponseField name="displayName" type="string">
  Human-readable display name.
</ResponseField>

<ResponseField name="description" type="string">
  Description of the pipeline service in Markdown format.
</ResponseField>

<ResponseField name="serviceType" type="string">
  Type of pipeline service (e.g., Airflow, Dagster, Fivetran).
</ResponseField>

<ResponseField name="connection" type="object">
  Connection configuration for the service.

  <Expandable title="properties">
    <ResponseField name="config" type="object">
      Service-specific connection configuration.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="version" type="number">
  Version number for the entity.
</ResponseField>

<ResponseField name="owners" type="array" optional>
  List of owners. Only included when `fields` contains `owners`.
</ResponseField>

<ResponseField name="tags" type="array" optional>
  Classification tags. Only included when `fields` contains `tags`.
</ResponseField>

<ResponseField name="domains" type="array" optional>
  Domain assignments. Only included when `fields` contains `domains`.
</ResponseField>

***

## 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 |