v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB
Topics

Retrieve a topic subscription

Retrieve a subscription by its unique identifier for a topic.

get/v2/topics/{topicKey}/subscriptions/{identifier}

Path parameters

topicKeystring required

The key identifier of the topic

identifierstring required

The unique identifier of the subscription

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

idstring required

The unique identifier of the subscription

identifierstring

The identifier of the subscription

namestring

The name of the subscription

contextKeysstring[]

Context keys that scope this subscription (e.g., tenant:org-a, project:proj-123)

Example response

{
  "id": "64f5e95d3d7946d80d0cb679",
  "identifier": "subscription-identifier",
  "name": "My Subscription",
  "preferences": [
    {
      "subscriptionId": "64f5e95d3d7946d80d0cb679",
      "workflow": {
        "id": "64a1b2c3d4e5f6g7h8i9j0k1",
        "identifier": "welcome-email",
        "name": "Welcome Email Workflow",
        "tags": [
          "user-onboarding",
          "email"
        ],
        "data": {
          "category": "onboarding",
          "priority": "high"
        }
      },
      "enabled": true,
      "condition": {
        "and": [
          {
            "===": [
              {
                "var": "payload.tier"
              },
              "premium"
            ]
          }
        ]
      }
    }
  ],
  "contextKeys": [
    "tenant:org-a",
    "project:proj-123"
  ]
}