List subscriptions

Subscriptions

get /v1/subscriptions

Lists up to 100 active profile and post subscription definitions. This endpoint is not paginated. Execution is paused in this release, so these definitions do not start refreshes.

Authentication

• ApiKey bearer token

  Send the current Benchmark API key only in the Authorization header.

Responses

• 200

  The organization's subscriptions.

• 400

  The request failed validation.

• 401

  The bearer credential is missing or invalid.

• 403

  The key cannot perform this operation.

• 429

  The Cloudflare rate limiter rejected the request.

• 500

  The request failed without exposing internal diagnostics.

• 503

  A required service is unavailable.

Request

cURL

curl --request GET \
  --url "${BENCHMARK_API_BASE_URL}/v1/subscriptions" \
  --header "Authorization: Bearer ${BENCHMARK_API_KEY}"

Response

200

{
  "subscriptions": [
    {
      "id": "60000000-0000-4000-8000-000000000006",
      "entityId": "50000000-0000-4000-8000-000000000005",
      "dataLevel": "basic",
      "executionStatus": "paused",
      "refreshIntervalSeconds": 3600,
      "isActive": true
    }
  ]
}