GET /v1/services/messagingServices
import requests
base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}
# List with pagination
response = requests.get(
f"{base_url}/v1/services/messagingServices",
params={"limit": 50, "fields": "owners,tags"},
headers=headers
)
page = response.json()
for svc in page["data"]:
print(f"{svc['name']} ({svc['serviceType']})")
# Filter by domain
response = requests.get(
f"{base_url}/v1/services/messagingServices",
params={"domain": "engineering", "limit": 50},
headers=headers
)
import static org.openmetadata.sdk.fluent.MessagingServices.*;
// List services
var result = MessagingServices.list()
.fields("owners", "tags")
.limit(50)
.execute();
for (MessagingService svc : result.getData()) {
System.out.println(svc.getName() + " (" + svc.getServiceType() + ")");
}
# List all
curl "{base_url}/api/v1/services/messagingServices?limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/services/messagingServices?fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by domain
curl "{base_url}/api/v1/services/messagingServices?domain=engineering&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"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": []
}
],
"paging": {
"after": "eyJ...",
"total": 3
}
}
List Messaging Services
List all messaging service connections with optional filtering by service type, owner, status, and pagination support for browsing integrations via the Collate REST API.
GET
/
v1
/
services
/
messagingServices
GET /v1/services/messagingServices
import requests
base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}
# List with pagination
response = requests.get(
f"{base_url}/v1/services/messagingServices",
params={"limit": 50, "fields": "owners,tags"},
headers=headers
)
page = response.json()
for svc in page["data"]:
print(f"{svc['name']} ({svc['serviceType']})")
# Filter by domain
response = requests.get(
f"{base_url}/v1/services/messagingServices",
params={"domain": "engineering", "limit": 50},
headers=headers
)
import static org.openmetadata.sdk.fluent.MessagingServices.*;
// List services
var result = MessagingServices.list()
.fields("owners", "tags")
.limit(50)
.execute();
for (MessagingService svc : result.getData()) {
System.out.println(svc.getName() + " (" + svc.getServiceType() + ")");
}
# List all
curl "{base_url}/api/v1/services/messagingServices?limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/services/messagingServices?fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by domain
curl "{base_url}/api/v1/services/messagingServices?domain=engineering&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"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": []
}
],
"paging": {
"after": "eyJ...",
"total": 3
}
}
List Messaging Services
List all messaging services with optional filtering and pagination.Query Parameters
integer
default:"10"
Maximum number of results to return (max: 1000000).
string
Cursor for backward pagination.
string
Cursor for forward pagination.
string
Comma-separated list of fields to include. Valid fields:
pipelines, owners, tags, domains, followers.string
Filter by domain fully qualified name.
string
default:"non-deleted"
Include
all, deleted, or non-deleted entities.GET /v1/services/messagingServices
import requests
base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}
# List with pagination
response = requests.get(
f"{base_url}/v1/services/messagingServices",
params={"limit": 50, "fields": "owners,tags"},
headers=headers
)
page = response.json()
for svc in page["data"]:
print(f"{svc['name']} ({svc['serviceType']})")
# Filter by domain
response = requests.get(
f"{base_url}/v1/services/messagingServices",
params={"domain": "engineering", "limit": 50},
headers=headers
)
import static org.openmetadata.sdk.fluent.MessagingServices.*;
// List services
var result = MessagingServices.list()
.fields("owners", "tags")
.limit(50)
.execute();
for (MessagingService svc : result.getData()) {
System.out.println(svc.getName() + " (" + svc.getServiceType() + ")");
}
# List all
curl "{base_url}/api/v1/services/messagingServices?limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/services/messagingServices?fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by domain
curl "{base_url}/api/v1/services/messagingServices?domain=engineering&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"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": []
}
],
"paging": {
"after": "eyJ...",
"total": 3
}
}
Returns
Returns a paginated list of messaging service objects. By default, only basic fields are included. Use thefields parameter to request additional data.
Response
array
Array of messaging service objects.
Show properties
Show properties
string
Unique identifier for the messaging service (UUID format).
string
Messaging service name.
string
Fully qualified name of the service.
string
Human-readable display name.
string
Type of messaging service (e.g., Kafka, Redpanda, Kinesis).
array
List of owners assigned to the service. Only included when
fields contains owners.array
Classification tags applied to the service. Only included when
fields contains tags.array
Domain assignments for governance. Only included when
fields contains domains.array
Ingestion pipelines associated with this service. Only included when
fields contains pipelines.array
Users following this service. Only included when
fields contains followers.Was this page helpful?
⌘I