Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
services
/
pipelineServices
GET /v1/services/pipelineServices
import requests

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

# List all
response = requests.get(
    f"{base_url}/v1/services/pipelineServices?limit=50",
    headers=headers
)
services = response.json()
for svc in services["data"]:
    print(f"{svc['fullyQualifiedName']} ({svc['serviceType']})")

# With fields
response = requests.get(
    f"{base_url}/v1/services/pipelineServices?fields=owners,tags,domains&limit=50",
    headers=headers
)
{
  "data": [
    {
      "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": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

List Pipeline Services

List all pipeline services with optional filtering and pagination.

Query Parameters

limit
integer
default:"10"
Maximum number of results to return (max: 1000000).
before
string
Cursor for backward pagination.
after
string
Cursor for forward pagination.
fields
string
Comma-separated list of fields to include: owners, tags, domains. See Supported Fields below.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/services/pipelineServices
import requests

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

# List all
response = requests.get(
    f"{base_url}/v1/services/pipelineServices?limit=50",
    headers=headers
)
services = response.json()
for svc in services["data"]:
    print(f"{svc['fullyQualifiedName']} ({svc['serviceType']})")

# With fields
response = requests.get(
    f"{base_url}/v1/services/pipelineServices?fields=owners,tags,domains&limit=50",
    headers=headers
)
{
  "data": [
    {
      "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": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

Returns

Returns a paginated list of pipeline service objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data
array
Array of pipeline service objects.
paging
object
Pagination information.

Supported Fields

The following fields can be requested via the fields query parameter:
FieldDescription
ownersOwner references (users and teams)
tagsClassification tags
domainsDomain assignments for governance

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to list pipeline services