Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
services
/
messagingServices
/
{id}
GET /v1/services/messagingServices/{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/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    headers=headers
)
service = response.json()
print(f"{service['fullyQualifiedName']}: {service['serviceType']}")

# Get by ID with fields
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    params={"fields": "owners,tags"},
    headers=headers
)

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

# Get by name with fields
response = requests.get(
    f"{base_url}/v1/services/messagingServices/name/sample_kafka",
    params={"fields": "owners,tags,domains"},
    headers=headers
)
{
  "id": "469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
  "name": "sample_kafka",
  "fullyQualifiedName": "sample_kafka",
  "serviceType": "Kafka",
  "connection": {
    "config": {
      "type": "Kafka",
      "bootstrapServers": "localhost:9092",
      "securityProtocol": "PLAINTEXT",
      "saslMechanism": "PLAIN",
      "schemaRegistryTopicSuffixName": "-value",
      "supportsMetadataExtraction": true
    }
  },
  "tags": [],
  "version": 0.1,
  "updatedAt": 1769982621031,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
  "deleted": false,
  "owners": [],
  "domains": []
}

Retrieve a Messaging Service

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

Get by ID

id
string
required
UUID of the messaging service to retrieve.
fields
string
Comma-separated list of fields to include. Valid fields: pipelines, owners, tags, domains, followers.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/services/messagingServices/name/{fqn} to retrieve by fully qualified name.
fqn
string
required
Fully qualified name of the messaging service (e.g., sample_kafka).
fields
string
Comma-separated list of fields to include. Valid fields: pipelines, owners, tags, domains, followers.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/services/messagingServices/{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/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    headers=headers
)
service = response.json()
print(f"{service['fullyQualifiedName']}: {service['serviceType']}")

# Get by ID with fields
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    params={"fields": "owners,tags"},
    headers=headers
)

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

# Get by name with fields
response = requests.get(
    f"{base_url}/v1/services/messagingServices/name/sample_kafka",
    params={"fields": "owners,tags,domains"},
    headers=headers
)
{
  "id": "469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
  "name": "sample_kafka",
  "fullyQualifiedName": "sample_kafka",
  "serviceType": "Kafka",
  "connection": {
    "config": {
      "type": "Kafka",
      "bootstrapServers": "localhost:9092",
      "securityProtocol": "PLAINTEXT",
      "saslMechanism": "PLAIN",
      "schemaRegistryTopicSuffixName": "-value",
      "supportsMetadataExtraction": true
    }
  },
  "tags": [],
  "version": 0.1,
  "updatedAt": 1769982621031,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
  "deleted": false,
  "owners": [],
  "domains": []
}

Returns

Returns a messaging service object with all requested fields populated.

Response

id
string
Unique identifier for the messaging service (UUID format).
name
string
Messaging service name.
fullyQualifiedName
string
Fully qualified name of the service.
displayName
string
Human-readable display name.
description
string
Description of the messaging service in Markdown format.
serviceType
string
Type of messaging service (e.g., Kafka, Redpanda, Kinesis).
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.
followers
array
Users following this service. Only included when fields contains followers.
pipelines
array
Ingestion pipelines associated with this service. Only included when fields contains pipelines.

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to view this messaging service
404NOT_FOUNDMessaging service with given ID or FQN does not exist