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.
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["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 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.meetings.search_meetings(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Search for meetings — request body — body |
Referenced models: Search for meetings — request body — body
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 Search for meetings — response body |
Referenced models: Search for meetings — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Search for meetings — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a search request |
after | string | Required within parent | A string representing the paging cursor token, used to retrieve the next set of results in a paginated response. |
filterGroups | array | Required within parent | An array of filter groups used to narrow down search results. Each filter group contains multiple filters that define specific criteria for the search. |
filterGroups[] | Model | Each item | Expand Search for meetings — request body — body filter Groups item |
limit | integer | Required within parent | An integer indicating the maximum number of results to return per page. Format: int32 |
properties | array | Required within parent | An array of strings specifying which properties of the objects should be included in the search results. |
properties[] | string | Each item | |
query | string | Optional | A string representing a search query to match against object properties. |
sorts | array | Required within parent | An 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[] | string | Each item |
Referenced models: Search for meetings — request body — body filter Groups item
Search for meetings — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a list of simple objects returned from an API request, along with the total count of objects available. |
paging | Model | Optional | Expand Search for meetings — response body — paging |
results | array | Required within parent | An array of SimplePublicObject items, each representing an individual CRM object. |
results[] | Model | Each item | Expand Merge objects — meetings merge — response body |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | The number of available results Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints. |
filters | array | Required within parent | An 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[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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. |
next | Model | Optional | Expand Search for meetings — response body — paging next |
prev | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A simple public object. |
archived | boolean | Required within parent | A boolean indicating whether this object is archived. |
archivedAt | string | Optional | The date and time when this object was archived, in ISO 8601 format. Format: date-time |
createdAt | string | Required within parent | The date and time when this object was created, in ISO 8601 format. Format: date-time |
id | string | Required within parent | The unique identifier for this object, represented as a string. |
objectWriteTraceId | string | Optional | A string used to trace the write operations for this object. |
properties | object | Required within parent | A map of property names to their values, where each value is a string. Additional keys: see wildcard field |
properties.* | string | Additional keys | |
propertiesWithHistory | object | Optional | A map of property names to arrays of historical values, each containing a value and its associated timestamp. Additional keys: see wildcard field |
propertiesWithHistory.* | array | Additional keys | |
propertiesWithHistory.*[] | Model | Each item | Expand Read — meetings get Meeting — response body — properties With History value item |
updatedAt | string | Required within parent | The date and time when this object was last updated, in ISO 8601 format. Format: date-time |
url | string | Optional | A string representing the URL of this object. |
warnings | array | Optional | An array of warnings related to this object, each containing a category, message, and context. |
warnings[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines 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. |
highValue | string | Optional | An optional string value used when the filter operator requires a range, such as 'BETWEEN'. |
operator | string | Required within parent | The 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 |
propertyName | string | Required within parent | The name of the property on which the filter is applied. It is a string that identifies the specific field in the CRM object. |
value | string | Optional | The value used in the filter condition. It is a string that represents the specific criteria for the filter. |
values | array | Optional | An array of strings representing multiple values used in filter conditions that support multiple criteria, such as 'IN' or 'NOT_IN'. |
values[] | string | Each item |
Search for meetings — 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 indicates the position after the last item in the current page of results. This token is used to retrieve the next page. |
link | string | Optional | A URL string that provides a direct link to the next page of results. |
Search for meetings — response body — paging prev
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | specifies the paging information needed to retrieve the previous set of results in a paginated API response |
before | string | Required within parent | A string token used to retrieve the previous page of results. |
link | string | Optional | A string URL that points to the previous page of results. |
Read — meetings get Meeting — response body — warnings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning. |
category | string | Required within parent | A string indicating the category of the warning. |
context | object | Required within parent | An 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.* | string | Additional keys | |
message | string | Required within parent | A string containing the warning message. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]