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

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. Valid fields: pipelines, owners, tags, domains, followers.
domain
string
Filter by domain fully qualified name.
include
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
)
{
  "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 the fields parameter to request additional data.

Response

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