Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
inputsarrayRequired within parentAn 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[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
inputsarrayRequired within parentAn array of SimplePublicObjectBatchInputForCreate objects, each containing the properties and associations needed to create a single CRM object.
inputs[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootAn input object that contains a collection of objects to be created together in a batch.
associationsarrayRequired within parentAn 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[]ModelEach itemExpand Create — meetings create Meeting — request body — body associations item
objectWriteTraceIdstringOptionalA string used to trace the write operations for the objects being created. This is optional and can be used for debugging or tracking purposes.
propertiesobjectRequired within parentAn 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.*stringAdditional 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

FieldTypePresenceDescription and constraints
$objectRootRepresents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
categorystringRequired within parentA string representing the category of the error.
contextobjectRequired within parentAn object containing additional context about the error, with string arrays as values.
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
errorsarrayRequired within parentAn array of ErrorDetail objects providing further information about the error.
errors[]ModelEach itemExpand Batch insert events — response body — errors item errors item
idstringOptionalA string representing the unique identifier for this error.
linksobjectRequired within parentAn object mapping link names to associated URIs containing documentation about the error or recommended remediation steps.
Additional keys: see wildcard field
links.*stringAdditional keys
messagestringRequired within parentA string containing a human-readable message describing the error.
statusstringRequired within parentA string indicating the status of the error.
subCategoryobjectOptionalAn 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

FieldTypePresenceDescription and constraints
$objectRootA public object batch response object
completedAtstringRequired within parentThe date and time when the batch operation was completed, in ISO 8601 format.
Format: date-time
linksobjectOptionalA map of link names to associated URIs for additional information related to the batch operation.
Additional keys: see wildcard field
links.*stringAdditional keys
requestedAtstringOptionalThe date and time when the batch operation was requested, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array of SimplePublicObject items representing the results of the batch operation.
results[]ModelEach itemExpand Merge objects — meetings merge — response body
startedAtstringRequired within parentThe date and time when the batch operation started, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
completedAtstringRequired within parentThe date and time when the batch operation was completed, in ISO 8601 format.
Format: date-time
errorsarrayOptionalAn array of StandardError items detailing any errors that occurred during the batch operation.
errors[]ModelEach itemExpand Create a batch of meetings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
linksobjectOptionalA map of link names to associated URIs, providing additional information or actions related to the batch operation.
Additional keys: see wildcard field
links.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeThe total number of errors encountered during the batch operation.
Format: int32
numErrors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAtstringOptionalThe date and time when the batch operation was requested, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array of SimplePublicObject items representing the successful results of the batch operation.
results[]ModelEach itemExpand Merge objects — meetings merge — response body
startedAtstringRequired within parentThe date and time when the batch operation started, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
inputsarrayRequired within parentAn array of SimplePublicObjectBatchInputUpsert objects, each containing the properties and identifiers necessary for creating or updating a CRM object. This is a required field.
inputs[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
idstringRequired within parentA string representing the unique identifier of the object.
idPropertystringOptionalThe name of a property whose values are unique for this object
objectWriteTraceIdstringOptionalA string used for tracing the write operation of the object. This is optional.
propertiesobjectRequired within parentAn 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.*stringAdditional keys

Create or update a batch of meetings by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

FieldTypePresenceDescription and constraints
$objectRootRepresents a CRM object that has either been created or updated (upserted)
archivedbooleanRequired within parentA boolean indicating whether the object is archived.
archivedAtstringOptionalThe date and time when the object was archived, in ISO 8601 format.
Format: date-time
createdAtstringRequired within parentThe date and time when the object was created, in ISO 8601 format.
Format: date-time
idstringRequired within parentThe unique identifier for the object, represented as a string.
newbooleanRequired within parentA boolean indicating whether the object is newly created.
objectWriteTraceIdstringOptionalA string used to trace the write operation for the object.
propertiesobjectRequired within parentA map of property names to their current values, where each value is a string.
Additional keys: see wildcard field
properties.*stringAdditional keys
propertiesWithHistoryobjectOptionalA 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.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Read — meetings get Meeting — response body — properties With History value item
updatedAtstringRequired within parentThe date and time when the object was last updated, in ISO 8601 format.
Format: date-time
urlstringOptionalA string representing the URL of the object.
warningsarrayOptionalAn array of warnings associated with the object, where each warning includes 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

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

FieldTypePresenceDescription and constraints
$objectRootRepresents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
completedAtstringRequired within parentThe date and time when the batch operation was completed, in ISO 8601 format.
Format: date-time
linksobjectOptionalA map of link names to associated URIs, providing additional resources or documentation.
Additional keys: see wildcard field
links.*stringAdditional keys
requestedAtstringOptionalThe date and time when the batch operation was requested, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array of objects representing the results of the batch upsert operation.
results[]ModelEach itemExpand Create or update a batch of meetings by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAtstringRequired within parentThe date and time when the batch operation started, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootRepresents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.
completedAtstringRequired within parentThe date and time when the batch operation was completed, in ISO 8601 format.
Format: date-time
errorsarrayOptionalAn array of errors that occurred during the batch operation, each described by a StandardError object.
errors[]ModelEach itemExpand Create a batch of meetings — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
linksobjectOptionalA map of link names to associated URIs that provide additional information about the batch operation.
Additional keys: see wildcard field
links.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeThe number of errors that occurred during the batch operation.
Format: int32
numErrors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAtstringOptionalThe date and time when the batch operation was requested, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array of objects representing the results of the upsert operation.
results[]ModelEach itemExpand Create or update a batch of meetings by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAtstringRequired within parentThe date and time when the batch operation started, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootIs 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.
associationsarrayRequired within parentAn 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[]ModelEach itemExpand Create — meetings create Meeting — request body — body associations item
propertiesobjectRequired within parentAn 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.*stringAdditional keys

Referenced models: Create — meetings create Meeting — request body — body associations item

Create — meetings create Meeting — request body — body associations item

FieldTypePresenceDescription and constraints
$objectRootRepresents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.
toModelRequired within parentExpand Create — meetings create Meeting — request body — body associations item to
typesarrayRequired within parentAn array of association specifications, each defining the category and type of association between the objects.
types[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootContains the Id of a Public Object
idstringRequired within parentA string representing the unique identifier for the CRM object.

List associations — meetings get Associations By To Object Type — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
pagingModelOptionalExpand List — meetings get Meetings — response body — paging
resultsarrayRequired within parentAn array of objects, each representing an association with multiple labels. Each object contains details about the associated object and the types of associations.
results[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootRepresents an object that is associated with multiple other objects, with optional context.
associationTypesarrayRequired within parentAn array of association specifications with labels, detailing the types of associations between the objects.
associationTypes[]ModelEach itemExpand List associations — meetings get Associations By To Object Type — response body — results item association Types item
toObjectIdstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootDefines the type, direction, and details of the relationship between two CRM objects.
categorystringRequired within parentThe category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'.
Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeIdstringOptionalThe object type ID of the source object in the association.
labelstringOptionalA string label for the association, providing a human-readable description.
toObjectTypeIdstringOptionalThe object type ID of the target object in the association.
typeIdJSONRequired within parent
typeId (anyOf 1)integerAlternativeAn integer representing the unique identifier for the type of association.
Format: int32
typeId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — meetings get Meetings — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
pagingModelOptionalExpand List — meetings get Meetings — response body — paging
resultsarrayRequired within parentAn array of SimplePublicObjectWithAssociations, each representing a CRM object along with its associated data.
results[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootPaging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
nextModelOptionalExpand Search for meetings — response body — paging next

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

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

Read a batch of meetings by internal ID, or unique property values — request body — body

FieldTypePresenceDescription and constraints
$objectRootSpecifies 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.
idPropertystringOptionalWhen using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
inputsarrayRequired within parentAn array of SimplePublicObjectId objects, each containing an ID of the object to be read.
inputs[]ModelEach itemExpand Archive a batch of contacts — request body — body inputs item
propertiesarrayRequired within parentAn 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[]stringEach item
propertiesWithHistoryarrayRequired within parentAn 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[]stringEach item

Referenced models: Archive a batch of contacts — request body — body inputs item

Read — meetings get Meeting — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
archivedbooleanRequired within parentIndicates whether this object is archived. A boolean value.
archivedAtstringOptionalThe date and time when this object was archived, in ISO 8601 format.
Format: date-time
associationsobjectOptionalA map of associated object types to their associated IDs.
Additional keys: see wildcard field
associations.*ModelAdditional keysExpand Read — meetings get Meeting — response body — associations value
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.
objectWriteTraceIdstringOptionalAn identifier used to trace the write operations for this object.
propertiesobjectRequired within parentA map of property names to their current values.
Additional keys: see wildcard field
properties.*stringAdditional keys
propertiesWithHistoryobjectOptionalA map of property names to their values, including historical values with timestamps.
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
urlstringOptionalThe URL link to access this object.
warningsarrayOptionalA list 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 — 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

FieldTypePresenceDescription and constraints
$objectRootRepresents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.
pagingModelOptionalExpand Search for meetings — response body — paging
resultsarrayRequired within parentAn array of associated IDs, each represented by an AssociatedId object. This property is required.
results[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootContains the id and type of an association
idstringRequired within parentThe unique identifier for the associated object. It is a string that represents the ID of the object being associated.
typestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootProperty model that includes timestamp.
sourceIdstringOptionalThe identifier of the source from which the value was obtained. It is a string.
sourceLabelstringOptionalA label describing the source from which the value was obtained. It is a string.
sourceTypestringRequired within parentThe type of source from which the value was obtained. It is a string.
timestampstringRequired within parentThe date and time when the value was recorded, in ISO 8601 format.
Format: date-time
updatedByUserIdJSONOptional
updatedByUserId (anyOf 1)integerAlternativeThe ID of the user who updated the value. It is an integer.
Format: int32
updatedByUserId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
valuestringRequired within parentThe value associated with the timestamp. It is a string.

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.

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 — 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 — 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

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 — 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

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.

Update a batch of meetings by internal ID, or unique property values — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
inputsarrayRequired within parentAn array of SimplePublicObjectBatchInput objects, each containing the properties and identifiers for a CRM object to be updated.
inputs[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootRepresents the input required to update a CRM object, containing an object with property names and their corresponding values.
propertiesobjectRequired within parentAn 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.*stringAdditional keys

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.