HubSpot: Meetings schemas
35 HubSpot schemas with complete fields and constraints.
← Meetings operations · All schemas
Archive a batch of meetings by ID — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot. |
inputs | array | Required within parent | An array of SimplePublicObjectId objects, each representing a unique identifier for a public object. This array is required and is used to specify the objects involved in the batch operation. |
inputs[] | Model | Each item | Expand Archive a batch of contacts — request body — body inputs item |
Referenced models: Archive a batch of contacts — request body — body inputs item
Create a batch of meetings — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once. |
inputs | array | Required within parent | An array of SimplePublicObjectBatchInputForCreate objects, each containing the properties and associations needed to create a single CRM object. |
inputs[] | Model | Each item | Expand Create a batch of meetings — request body — body inputs item |
Referenced models: Create a batch of meetings — request body — body inputs item
Create a batch of meetings — request body — body inputs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An input object that contains a collection of objects to be created together in a batch. |
associations | array | Required within parent | An array of associations for the CRM objects, where each association links the object to another object. Each item in the array is a 'PublicAssociationsForObject' object. |
associations[] | Model | Each item | Expand Create — meetings create Meeting — request body — body associations item |
objectWriteTraceId | string | Optional | A string used to trace the write operations for the objects being created. This is optional and can be used for debugging or tracking purposes. |
properties | object | Required within parent | An object containing key-value pairs representing the properties of the CRM objects to be created. Each key is a property name, and each value is the property's value. Additional keys: see wildcard field |
properties.* | string | Additional keys |
Referenced models: Create — meetings create Meeting — request body — body associations item
Create a batch of meetings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request. |
category | string | Required within parent | A string representing the category of the error. |
context | object | Required within parent | An object containing additional context about the error, with string arrays as values. Additional keys: see wildcard field |
context.* | array | Additional keys | |
context.*[] | string | Each item | |
errors | array | Required within parent | An array of ErrorDetail objects providing further information about the error. |
errors[] | Model | Each item | Expand Batch insert events — response body — errors item errors item |
id | string | Optional | A string representing the unique identifier for this error. |
links | object | Required within parent | An object mapping link names to associated URIs containing documentation about the error or recommended remediation steps. Additional keys: see wildcard field |
links.* | string | Additional keys | |
message | string | Required within parent | A string containing a human-readable message describing the error. |
status | string | Required within parent | A string indicating the status of the error. |
subCategory | object | Optional | An object providing additional categorization of the error. |
Referenced models: Batch insert events — response body — errors item errors item
Create a batch of meetings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Meetings Batch Response Simple Public Object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A public object batch response object |
completedAt | string | Required within parent | The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time |
links | object | Optional | A map of link names to associated URIs for additional information related to the batch operation. Additional keys: see wildcard field |
links.* | string | Additional keys | |
requestedAt | string | Optional | The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time |
results | array | Required within parent | An array of SimplePublicObject items representing the results of the batch operation. |
results[] | Model | Each item | Expand Merge objects — meetings merge — response body |
startedAt | string | Required within parent | The date and time when the batch operation started, in ISO 8601 format. Format: date-time |
status | string | Required within parent | The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING |
Referenced models: Merge objects — meetings merge — response body
Create a batch of meetings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Meetings Batch Response Simple Public Object With Errors
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation. |
completedAt | string | Required within parent | The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time |
errors | array | Optional | An array of StandardError items detailing any errors that occurred during the batch operation. |
errors[] | Model | Each item | Expand Create a batch of meetings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item |
links | object | Optional | A map of link names to associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field |
links.* | string | Additional keys | |
numErrors | JSON | Optional | |
numErrors (anyOf 1) | integer | Alternative | The total number of errors encountered during the batch operation. Format: int32 |
numErrors (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestedAt | string | Optional | The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time |
results | array | Required within parent | An array of SimplePublicObject items representing the successful results of the batch operation. |
results[] | Model | Each item | Expand Merge objects — meetings merge — response body |
startedAt | string | Required within parent | The date and time when the batch operation started, in ISO 8601 format. Format: date-time |
status | string | Required within parent | The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING |
Referenced models: Create a batch of meetings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Merge objects — meetings merge — response body
Create or update a batch of meetings by unique property values — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance. |
inputs | array | Required within parent | An array of SimplePublicObjectBatchInputUpsert objects, each containing the properties and identifiers necessary for creating or updating a CRM object. This is a required field. |
inputs[] | Model | Each item | Expand Create or update a batch of meetings by unique property values — request body — body inputs item |
Referenced models: Create or update a batch of meetings by unique property values — request body — body inputs item
Create or update a batch of meetings by unique property values — request body — body inputs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID. |
id | string | Required within parent | A string representing the unique identifier of the object. |
idProperty | string | Optional | The name of a property whose values are unique for this object |
objectWriteTraceId | string | Optional | A string used for tracing the write operation of the object. This is optional. |
properties | object | Required within parent | An object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and each value is the property's value. Additional keys: see wildcard field |
properties.* | string | Additional keys |
Create or update a batch of meetings by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a CRM object that has either been created or updated (upserted) |
archived | boolean | Required within parent | A boolean indicating whether the object is archived. |
archivedAt | string | Optional | The date and time when the object was archived, in ISO 8601 format. Format: date-time |
createdAt | string | Required within parent | The date and time when the object was created, in ISO 8601 format. Format: date-time |
id | string | Required within parent | The unique identifier for the object, represented as a string. |
new | boolean | Required within parent | A boolean indicating whether the object is newly created. |
objectWriteTraceId | string | Optional | A string used to trace the write operation for the object. |
properties | object | Required within parent | A map of property names to their current 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 their historical values, where each value is an array of objects containing the value and its 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 the object was last updated, in ISO 8601 format. Format: date-time |
url | string | Optional | A string representing the URL of the object. |
warnings | array | Optional | An array of warnings associated with the object, where each warning includes 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
Create or update a batch of meetings by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Meetings Batch Response Simple Public Upsert Object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects. |
completedAt | string | Required within parent | The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time |
links | object | Optional | A map of link names to associated URIs, providing additional resources or documentation. Additional keys: see wildcard field |
links.* | string | Additional keys | |
requestedAt | string | Optional | The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time |
results | array | Required within parent | An array of objects representing the results of the batch upsert operation. |
results[] | Model | Each item | Expand Create or update a batch of meetings by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item |
startedAt | string | Required within parent | The date and time when the batch operation started, in ISO 8601 format. Format: date-time |
status | string | Required within parent | The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING |
Referenced models: Create or update a batch of meetings by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
Create or update a batch of meetings by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Meetings Batch Response Simple Public Upsert Object With Errors
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing. |
completedAt | string | Required within parent | The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time |
errors | array | Optional | An array of errors that occurred during the batch operation, each described by a StandardError object. |
errors[] | Model | Each item | Expand Create a batch of meetings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item |
links | object | Optional | A map of link names to associated URIs that provide additional information about the batch operation. Additional keys: see wildcard field |
links.* | string | Additional keys | |
numErrors | JSON | Optional | |
numErrors (anyOf 1) | integer | Alternative | The number of errors that occurred during the batch operation. Format: int32 |
numErrors (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestedAt | string | Optional | The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time |
results | array | Required within parent | An array of objects representing the results of the upsert operation. |
results[] | Model | Each item | Expand Create or update a batch of meetings by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item |
startedAt | string | Required within parent | The date and time when the batch operation started, in ISO 8601 format. Format: date-time |
status | string | Required within parent | The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING |
Referenced models: Create a batch of meetings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create or update a batch of meetings by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
Create — meetings create Meeting — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects. |
associations | array | Required within parent | An array of associations that define relationships between the new CRM object and other existing objects. Each association specifies the target object and the type of relationship. |
associations[] | Model | Each item | Expand Create — meetings create Meeting — request body — body associations item |
properties | object | Required within parent | An object containing key-value pairs where each key is a property name and each value is the property's value. These properties define the attributes of the CRM object being created. Additional keys: see wildcard field |
properties.* | string | Additional keys |
Referenced models: Create — meetings create Meeting — request body — body associations item
Create — meetings create Meeting — request body — body associations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved. |
to | Model | Required within parent | Expand Create — meetings create Meeting — request body — body associations item to |
types | array | Required within parent | An array of association specifications, each defining the category and type of association between the objects. |
types[] | Model | Each item | Expand Create meeting — request body — body associations item types item |
Referenced models: Create meeting — request body — body associations item types item, Create — meetings create Meeting — request body — body associations item to
Create — meetings create Meeting — request body — body associations item to
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the Id of a Public Object |
id | string | Required within parent | A string representing the unique identifier for the CRM object. |
List associations — meetings get Associations By To Object Type — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a paginated collection of objects that are associated with multiple labels, including the results and pagination details. This component is used when retrieving associated objects with specific labels in a forward-paging manner. |
paging | Model | Optional | Expand List — meetings get Meetings — response body — paging |
results | array | Required within parent | An array of objects, each representing an association with multiple labels. Each object contains details about the associated object and the types of associations. |
results[] | Model | Each item | Expand List associations — meetings get Associations By To Object Type — response body — results item |
Referenced models: List — meetings get Meetings — response body — paging, List associations — meetings get Associations By To Object Type — response body — results item
List associations — meetings get Associations By To Object Type — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an object that is associated with multiple other objects, with optional context. |
associationTypes | array | Required within parent | An array of association specifications with labels, detailing the types of associations between the objects. |
associationTypes[] | Model | Each item | Expand List associations — meetings get Associations By To Object Type — response body — results item association Types item |
toObjectId | string | Required within parent | The unique identifier of the target object to which associations are made. It is a string. |
Referenced models: List associations — meetings get Associations By To Object Type — response body — results item association Types item
List associations — meetings get Associations By To Object Type — response body — results item association Types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines the type, direction, and details of the relationship between two CRM objects. |
category | string | Required within parent | The category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK |
fromObjectTypeId | string | Optional | The object type ID of the source object in the association. |
label | string | Optional | A string label for the association, providing a human-readable description. |
toObjectTypeId | string | Optional | The object type ID of the target object in the association. |
typeId | JSON | Required within parent | |
typeId (anyOf 1) | integer | Alternative | An integer representing the unique identifier for the type of association. Format: int32 |
typeId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List — meetings get Meetings — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API. |
paging | Model | Optional | Expand List — meetings get Meetings — response body — paging |
results | array | Required within parent | An array of SimplePublicObjectWithAssociations, each representing a CRM object along with its associated data. |
results[] | Model | Each item | Expand Read — meetings get Meeting — response body |
Referenced models: List — meetings get Meetings — response body — paging, Read — meetings get Meeting — response body
List — meetings get Meetings — 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 Search for meetings — response body — paging next |
Referenced models: Search for meetings — response body — paging next
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
Read a batch of meetings by internal ID, or unique property values — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property. |
idProperty | string | Optional | When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID. |
inputs | array | Required within parent | An array of SimplePublicObjectId objects, each containing an ID of the object to be read. |
inputs[] | Model | Each item | Expand Archive a batch of contacts — request body — body inputs item |
properties | array | Required within parent | An array of strings representing the properties to be returned for each object. If a specified property is not present on an object, it will be ignored. |
properties[] | string | Each item | |
propertiesWithHistory | array | Required within parent | An array of strings indicating the properties to be returned along with their history of previous values. Specifying properties here will reduce the maximum number of objects that can be read in a single request. |
propertiesWithHistory[] | string | Each item |
Referenced models: Archive a batch of contacts — request body — body inputs item
Read — meetings get Meeting — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type. |
archived | boolean | Required within parent | Indicates whether this object is archived. A boolean value. |
archivedAt | string | Optional | The date and time when this object was archived, in ISO 8601 format. Format: date-time |
associations | object | Optional | A map of associated object types to their associated IDs. Additional keys: see wildcard field |
associations.* | Model | Additional keys | Expand Read — meetings get Meeting — response body — associations value |
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. |
objectWriteTraceId | string | Optional | An identifier used to trace the write operations for this object. |
properties | object | Required within parent | A map of property names to their current values. Additional keys: see wildcard field |
properties.* | string | Additional keys | |
propertiesWithHistory | object | Optional | A map of property names to their values, including historical values with timestamps. 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 | The URL link to access this object. |
warnings | array | Optional | A list 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 — associations value, Read — meetings get Meeting — response body — warnings item, Read — meetings get Meeting — response body — properties With History value item
Read — meetings get Meeting — response body — associations value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results. |
paging | Model | Optional | Expand Search for meetings — response body — paging |
results | array | Required within parent | An array of associated IDs, each represented by an AssociatedId object. This property is required. |
results[] | Model | Each item | Expand Read — meetings get Meeting — response body — associations value results item |
Referenced models: Read — meetings get Meeting — response body — associations value results item, Search for meetings — response body — paging
Read — meetings get Meeting — response body — associations value results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the id and type of an association |
id | string | Required within parent | The unique identifier for the associated object. It is a string that represents the ID of the object being associated. |
type | string | Required within parent | The type of association between objects. It is a string that specifies the nature of the relationship. |
Read — meetings get Meeting — response body — properties With History value item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Property model that includes timestamp. |
sourceId | string | Optional | The identifier of the source from which the value was obtained. It is a string. |
sourceLabel | string | Optional | A label describing the source from which the value was obtained. It is a string. |
sourceType | string | Required within parent | The type of source from which the value was obtained. It is a string. |
timestamp | string | Required within parent | The date and time when the value was recorded, in ISO 8601 format. Format: date-time |
updatedByUserId | JSON | Optional | |
updatedByUserId (anyOf 1) | integer | Alternative | The ID of the user who updated the value. It is an integer. Format: int32 |
updatedByUserId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value | string | Required within parent | The value associated with the timestamp. It is a string. |
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. |
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 — 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 — 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
| 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 — 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
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. |
Update a batch of meetings by internal ID, or unique property values — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously. |
inputs | array | Required within parent | An array of SimplePublicObjectBatchInput objects, each containing the properties and identifiers for a CRM object to be updated. |
inputs[] | Model | Each item | Expand Update batch objects — line Items batch Update Line Items — request body — body inputs item |
Referenced models: Update batch objects — line Items batch Update Line Items — request body — body inputs item
Update — meetings update Meeting — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the input required to update a CRM object, containing an object with property names and their corresponding values. |
properties | object | Required within parent | An object containing key-value pairs where each key is a property name and the value is the property's value. All properties are strings. Additional keys: see wildcard field |
properties.* | string | Additional keys |