Skip to content

HubSpot: Search for meetings

HubSpot meetings.searchMeetings: arguments, response, policy and SDK examples.

← Meetings operations · Get started

Operation hubspot.meetings_search_meetings

Provider route: POST /crm/objects/2026-09/meetings/search. Alter supplies the connection’s credentials and routing.

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["meetings"]["searchMeetings"]>[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.meetings.searchMeetings(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.meetings.search_meetings(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Search for meetings — request body — body

Referenced models: Search for meetings — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Search for meetings — response body

Referenced models: Search for meetings — response body

1 more schema is linked from the tables above, on the schema pages.

Search for meetings — request body — body
FieldTypePresenceDescription and constraints
$objectRootDescribes a search request
afterstringRequired within parentA string representing the paging cursor token, used to retrieve the next set of results in a paginated response.
filterGroupsarrayRequired within parentAn array of filter groups used to narrow down search results. Each filter group contains multiple filters that define specific criteria for the search.
filterGroups[]ModelEach itemExpand Search for meetings — request body — body filter Groups item
limitintegerRequired within parentAn integer indicating the maximum number of results to return per page.
Format: int32
propertiesarrayRequired within parentAn array of strings specifying which properties of the objects should be included in the search results.
properties[]stringEach item
querystringOptionalA string representing a search query to match against object properties.
sortsarrayRequired within parentAn array of strings specifying the sorting order of the search results. Each string represents a property name to sort by, optionally prefixed with '-' to indicate descending order.
sorts[]stringEach item

Referenced models: Search for meetings — request body — body filter Groups item

Search for meetings — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents a list of simple objects returned from an API request, along with the total count of objects available.
pagingModelOptionalExpand Search for meetings — response body — paging
resultsarrayRequired within parentAn array of SimplePublicObject items, each representing an individual CRM object.
results[]ModelEach itemExpand Merge objects — meetings merge — response body
totalJSONRequired within parent
total (anyOf 1)integerAlternativeThe number of available results
Format: int32
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search for meetings — response body — paging, Merge objects — meetings merge — response body

Search for meetings — request body — body filter Groups item
FieldTypePresenceDescription and constraints
$objectRootRepresents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filtersarrayRequired within parentAn array of filter objects that define the criteria for filtering CRM objects. Each filter specifies a property, operator, and value to apply in the search query.
filters[]ModelEach itemExpand Search for meetings — request body — body filter Groups item filters item

Referenced models: Search for meetings — request body — body filter Groups item filters item

Search for meetings — response body — paging
FieldTypePresenceDescription and constraints
$objectRootRepresents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
nextModelOptionalExpand Search for meetings — response body — paging next
prevModelOptionalExpand Search for meetings — response body — paging prev

Referenced models: Search for meetings — response body — paging next, Search for meetings — response body — paging prev

Merge objects — meetings merge — response body
FieldTypePresenceDescription and constraints
$objectRootA simple public object.
archivedbooleanRequired within parentA boolean indicating whether this object is archived.
archivedAtstringOptionalThe date and time when this object was archived, in ISO 8601 format.
Format: date-time
createdAtstringRequired within parentThe date and time when this object was created, in ISO 8601 format.
Format: date-time
idstringRequired within parentThe unique identifier for this object, represented as a string.
objectWriteTraceIdstringOptionalA string used to trace the write operations for this object.
propertiesobjectRequired within parentA map of property names to their values, where each value is a string.
Additional keys: see wildcard field
properties.*stringAdditional keys
propertiesWithHistoryobjectOptionalA map of property names to arrays of historical values, each containing a value and its associated timestamp.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Read — meetings get Meeting — response body — properties With History value item
updatedAtstringRequired within parentThe date and time when this object was last updated, in ISO 8601 format.
Format: date-time
urlstringOptionalA string representing the URL of this object.
warningsarrayOptionalAn array of warnings related to this object, each containing a category, message, and context.
warnings[]ModelEach itemExpand Read — meetings get Meeting — response body — warnings item

Referenced models: Read — meetings get Meeting — response body — warnings item, Read — meetings get Meeting — response body — properties With History value item

Search for meetings — request body — body filter Groups item filters item
FieldTypePresenceDescription and constraints
$objectRootDefines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValuestringOptionalAn optional string value used when the filter operator requires a range, such as 'BETWEEN'.
operatorstringRequired within parentThe operator used to compare the property with the value(s). It is a string and can be one of several predefined operators, such as 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', or 'NOT_CONTAINS_TOKEN'.
One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyNamestringRequired within parentThe name of the property on which the filter is applied. It is a string that identifies the specific field in the CRM object.
valuestringOptionalThe value used in the filter condition. It is a string that represents the specific criteria for the filter.
valuesarrayOptionalAn array of strings representing multiple values used in filter conditions that support multiple criteria, such as 'IN' or 'NOT_IN'.
values[]stringEach item
Search for meetings — response body — paging next
FieldTypePresenceDescription and constraints
$objectRootSpecifies the paging information needed to retrieve the next set of results in a paginated API response
afterstringRequired within parentA string token that indicates the position after the last item in the current page of results. This token is used to retrieve the next page.
linkstringOptionalA URL string that provides a direct link to the next page of results.
Search for meetings — response body — paging prev
FieldTypePresenceDescription and constraints
$objectRootspecifies the paging information needed to retrieve the previous set of results in a paginated API response
beforestringRequired within parentA string token used to retrieve the previous page of results.
linkstringOptionalA string URL that points to the previous page of results.
Read — meetings get Meeting — response body — warnings item
FieldTypePresenceDescription and constraints
$objectRootRepresents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
categorystringRequired within parentA string indicating the category of the warning.
contextobjectRequired within parentAn object providing additional context about the warning, with properties as key-value pairs where both keys and values are strings.
Additional keys: see wildcard field
context.*stringAdditional keys
messagestringRequired within parentA string containing the warning message.

SDK function policy ID: hubspot.meetings_search_meetings. Catalog operation: meetings_search_meetings. 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.contacts.read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.