HubSpot: Retrieve contact I Ds

← Campaigns operations · Get started

Operation hubspot.campaigns_reports_get_contact_ids

Provider route: GET /marketing/campaigns/2026-09/{campaignGuid}/reports/contacts/{contactType}. Alter supplies the connection’s credentials and routing.

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["campaigns"]["reportsGetContactIds"]>[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.campaigns.reportsGetContactIds(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from 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.campaigns.reports_get_contact_ids(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.campaignGuid	string	Required within parent
path.contactType	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.after	string	Optional
query.endDate	string	Optional
query.limit	integer	Optional	Format: int32
query.startDate	string	Optional

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 Retrieve contact I Ds — response body

Referenced models: Retrieve contact I Ds — response body

Schemas

Retrieve contact I Ds — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve assets — response body — paging
results	array	Required within parent	An array of contact references, each representing a contact associated with the campaign. Each item in the array is a ContactReference object.
results[]	Model	Each item	Expand Retrieve contact I Ds — response body — results item

Referenced models: Retrieve assets — response body — paging, Retrieve contact I Ds — response body — results item

Retrieve assets — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand Retrieve assets — response body — paging next

Referenced models: Retrieve assets — response body — paging next

Retrieve contact I Ds — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the contact reference, represented as a string.

Retrieve assets — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token that serves as the paging cursor, indicating the position after the last successfully read resource.
link	string	Optional	A string URL that provides a link to the next page of results.

Policy, approvals and errors

SDK function policy ID: hubspot.campaigns_reports_get_contact_ids. Catalog operation: campaigns_reports_get_contact_ids. 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: ["marketing.campaigns.read"]

Official provider source