HubSpot · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Marketing Marketing Events Participant State API

6 actions 6 updates phrasing extends openapi/hubspot-participant-state-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for HubSpot's API. It is a proposal applied on top of the contract, not a document HubSpot publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/marketing/marketing-events/2026-09/participations/contacts/{contactIdentifier}/breakdown'].get
$.paths['/marketing/marketing-events/2026-09/participations/{externalAccountId}/{externalEventId}'].get
$.paths['/marketing/marketing-events/2026-09/participations/{externalAccountId}/{externalEventId}/breakdown'].get
$.paths['/marketing/marketing-events/2026-09/participations/{marketingEventId}'].get
$.paths['/marketing/marketing-events/2026-09/participations/{marketingEventId}/breakdown'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Marketing Marketing Events Participant State API
  version: 1.0.0
extends: openapi/hubspot-participant-state-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/marketing/marketing-events/2026-09/participations/contacts/{contactIdentifier}/breakdown'].get
  update:
    x-apievangelist-phrasing:
      intent: See which marketing events a contact took part in
      effect: read
      questions:
      - Which webinars and events has a given contact registered for or attended?
      - Can I look up a contact's event history by their email address?
      - How do I find the events a contact was a no-show for?
      instructions:
      - text: Show the event participations for contact {contactIdentifier}.
        slots:
          contactIdentifier: path.contactIdentifier
      - text: List events where contact {contactIdentifier} has state {state}, {limit} per page.
        slots:
          contactIdentifier: path.contactIdentifier
          state: query.state
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/marketing/marketing-events/2026-09/participations/{externalAccountId}/{externalEventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Count attendees for an event by its external ID
      effect: read
      questions:
      - How many people registered, attended or cancelled for an event synced from my event app?
      - Can I get attendance totals using the event ID from my external event platform?
      instructions:
      - text: Get participation counts for external event {externalEventId} in account {externalAccountId}.
        slots:
          externalEventId: path.externalEventId
          externalAccountId: path.externalAccountId
      - text: Tally registrations and attendance for event {externalEventId} from external account {externalAccountId}.
        slots:
          externalEventId: path.externalEventId
          externalAccountId: path.externalAccountId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/marketing/marketing-events/2026-09/participations/{externalAccountId}/{externalEventId}/breakdown'].get
  update:
    x-apievangelist-phrasing:
      intent: List participants of an event by its external ID
      effect: read
      questions:
      - Who attended an event I synced from my external event tool?
      - Can I filter the participant list of an externally managed event to just no-shows?
      instructions:
      - text: List participants of external event {externalEventId} in account {externalAccountId}.
        slots:
          externalEventId: path.externalEventId
          externalAccountId: path.externalAccountId
      - text: Show participants with state {state} for external event {externalEventId} under account {externalAccountId}.
        slots:
          state: query.state
          externalEventId: path.externalEventId
          externalAccountId: path.externalAccountId
      - text: Check whether contact {contactIdentifier} participated in external event {externalEventId} from account {externalAccountId}.
        slots:
          contactIdentifier: query.contactIdentifier
          externalEventId: path.externalEventId
          externalAccountId: path.externalAccountId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/marketing/marketing-events/2026-09/participations/{marketingEventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Count attendees for a HubSpot marketing event
      effect: read
      questions:
      - How many contacts registered and attended a marketing event, using its HubSpot ID?
      - What are the registration and no-show totals for one of my HubSpot marketing events?
      instructions:
      - text: Get participation counts for marketing event {marketingEventId}.
        slots:
          marketingEventId: path.marketingEventId
      - text: Summarize attended, registered, cancelled and no-show totals for HubSpot event {marketingEventId}.
        slots:
          marketingEventId: path.marketingEventId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/marketing/marketing-events/2026-09/participations/{marketingEventId}/breakdown'].get
  update:
    x-apievangelist-phrasing:
      intent: List participants of a HubSpot marketing event
      effect: read
      questions:
      - Who registered for a marketing event, looked up by its HubSpot event ID?
      - Can I list only the attendees who cancelled for one of my HubSpot events?
      instructions:
      - text: List participants of marketing event {marketingEventId}.
        slots:
          marketingEventId: path.marketingEventId
      - text: Show participants of HubSpot event {marketingEventId} whose state is {state}, {limit} at a time.
        slots:
          marketingEventId: path.marketingEventId
          state: query.state
          limit: query.limit
      - text: Check contact {contactIdentifier}'s participation in HubSpot event {marketingEventId}.
        slots:
          contactIdentifier: query.contactIdentifier
          marketingEventId: path.marketingEventId
      method: generated
      generated: '2026-09-24'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/hubspot-participant-state-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.