HubSpot: Read participations counters by Marketing Event internal identifier
HubSpot marketingEvents.getParticipationsByMarketingEventId: arguments, response, policy and SDK examples.
← Marketing events operations · Get started
Operation hubspot.marketing_events_get_participations_by_marketing_event_id
Provider route: GET /marketing/marketing-events/2026-09/participations/{marketingEventId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { HubSpotIntegration } from "@alter-ai/hubspot";
async function execute(input: Parameters<HubSpotIntegration["marketingEvents"]["getParticipationsByMarketingEventId"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.marketingEvents.getParticipationsByMarketingEventId(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_hubspot import HubSpotIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.marketing_events.get_participations_by_marketing_event_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.marketingEventId | integer | Required within parent | Format: int64 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Read participations counters by Marketing Event external identifier — response body |
Referenced models: Read participations counters by Marketing Event external identifier — response body
Schemas
Section titled “Schemas”Read participations counters by Marketing Event external identifier — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attended | JSON | Required within parent | |
attended (anyOf 1) | integer | Alternative | Number of attended contact records of a marketing event Format: int32 |
attended (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cancelled | JSON | Required within parent | |
cancelled (anyOf 1) | integer | Alternative | Number of cancelled contact records of a marketing event Format: int32 |
cancelled (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
noShows | JSON | Required within parent | |
noShows (anyOf 1) | integer | Alternative | Number of no-show contact records of a marketing event Format: int32 |
noShows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
registered | JSON | Required within parent | |
registered (anyOf 1) | integer | Alternative | Number of registered contact records of a marketing event Format: int32 |
registered (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.marketing_events_get_participations_by_marketing_event_id. Catalog operation: marketing_events_get_participations_by_marketing_event_id. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["crm.objects.marketing_events.read"]