Skip to main content
GET
/
subscriptions
/
{subscriptionRef}
Get subscription results (alias of cloud)
curl --request GET \
  --url https://{host}/subscriptions/{subscriptionRef}
{
  "subscription": {
    "name": "<string>",
    "description": "<string>",
    "created": "<string>",
    "createdBy": "<string>",
    "updated": "<string>",
    "updatedBy": "<string>",
    "lastRefreshed": "<string>",
    "owner": "<string>"
  },
  "count": 123,
  "results": [
    {
      "divider": "<string>",
      "tags": [
        "<string>"
      ]
    }
  ]
}

Path Parameters

subscriptionRef
string
required

Unique subscription identifier.

Query Parameters

divider
enum<string>
default:true

Display divider between properties and tags in each result: "true" (default) shows "divider": "------------------------", "false" hides it.

Available options:
true,
false
limit
integer
default:3000

Maximum number of results to return. Default 3000; valid range 1–30000. Only applies to on-demand queries (no limit for scheduled webhook pushes).

Required range: 1 <= x <= 30000

Response

200 - application/json

Subscription results (same shape as above)

subscription
object
required
count
integer
required

Number of recommendations in results.

results
object[]
required