Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
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
)

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

​
id
string
required
UUID of the pipeline service to retrieve.
​
fields
string
Comma-separated list of fields to include (e.g., owners,tags,domains).
​
include
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.
​
fqn
string
required
Fully qualified name of the pipeline service (e.g., sample_airflow).
​
fields
string
Comma-separated list of fields to include: owners, tags, domains.
​
include
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
)

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

​
id
string
Unique identifier for the pipeline service (UUID format).
​
name
string
Pipeline service name.
​
fullyQualifiedName
string
Fully qualified name of the service.
​
displayName
string
Human-readable display name.
​
description
string
Description of the pipeline service in Markdown format.
​
serviceType
string
Type of pipeline service (e.g., Airflow, Dagster, Fivetran).
​
connection
object
Connection configuration for the service.
​
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 service
404NOT_FOUNDPipeline service with given ID or FQN does not exist