HubSpot: Tasks schemas

← Tasks operations · All schemas

Archive a batch of tasks 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 containing the ID of a CRM object to be processed. This is a required field.
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 tasks — 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 objects, each representing a simple public object to be created. Each object includes properties and associations necessary for the creation of the CRM object.
inputs[]	Model	Each item	Expand Create a batch of tasks — request body — body inputs item

Referenced models: Create a batch of tasks — request body — body inputs item

Create a batch of tasks — 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 object, where each association links the object to another object in the CRM. Each association is defined using the PublicAssociationsForObject schema.
associations[]	Model	Each item	Expand Create — tasks create Task — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for the object. This can be useful for debugging and tracking purposes.
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. This defines the attributes of the CRM object being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — tasks create Task — request body — body associations item

Create a batch of tasks — 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 categorizing the type of error.
context	object	Required within parent	An object containing additional context about the error, with keys as context names and values as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing additional information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string representing a unique identifier for this error instance.
links	object	Required within parent	An object mapping link names to associated URIs that provide documentation or remediation steps related to the error. 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 more specific categorization of the error.

Referenced models: Batch insert events — response body — errors item errors item

Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tasks 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 that provide additional information or actions 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 that represent the results of the batch operation.
results[]	Model	Each item	Expand Create — tasks create Task — 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 — tasks create Task — response body

Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tasks 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 errors encountered during the batch operation, each represented as a StandardError.
errors[]	Model	Each item	Expand Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional context or resources related to 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 results from the batch operation, each represented as a SimplePublicObject.
results[]	Model	Each item	Expand Create — tasks create Task — 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 — tasks create Task — response body, Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create or update a batch of tasks 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 representing an individual object to be created or updated. This property is required.
inputs[]	Model	Each item	Expand Create or update a batch of tasks by unique property values — request body — body inputs item

Referenced models: Create or update a batch of tasks by unique property values — request body — body inputs item

Create or update a batch of tasks 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 for the CRM object.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values for the CRM object. Each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Create or update a batch of tasks 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 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.
new	boolean	Required within parent	A boolean indicating whether this object is newly created.
objectWriteTraceId	string	Optional	A string used to trace the write operation that created or updated 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 values with timestamps, showing the history of changes for each property. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — tasks get Task — 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 the object.
warnings	array	Optional	An array of warnings related to this object, each represented by a PublicObjectWarning object.
warnings[]	Model	Each item	Expand Read — tasks get Task — response body — warnings item

Referenced models: Read — tasks get Task — response body — warnings item, Read — tasks get Task — response body — properties With History value item

Create or update a batch of tasks by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tasks 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 context or actions 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 SimplePublicUpsertObject items, representing the objects that were created or updated in the batch operation.
results[]	Model	Each item	Expand Create or update a batch of tasks 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 tasks by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Create or update a batch of tasks by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tasks 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 StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional documentation or resources related to the 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 SimplePublicUpsertObject items representing the results of the upsert operation.
results[]	Model	Each item	Expand Create or update a batch of tasks 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 tasks by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create — tasks create Task — 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 objects that specify the associations between the CRM object being created and other objects. Each association defines a relationship with another object, identified by its ID.
associations[]	Model	Each item	Expand Create — tasks create Task — 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 — tasks create Task — request body — body associations item

Create — tasks create Task — 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 — tasks create Task — request body — body associations item to
types	array	Required within parent	An array of association specifications, each detailing the type of association between the objects. Each item in the array is a reference to the AssociationSpec schema.
types[]	Model	Each item	Expand Create — tasks create Task — request body — body associations item types item

Referenced models: Create — tasks create Task — request body — body associations item to, Create — tasks create Task — request body — body associations item types item

Create — tasks create Task — 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	The unique identifier for the public object, represented as a string.

Create — tasks create Task — request body — body associations item types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
associationCategory	string	Required within parent	A string representing the category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeId	integer	Required within parent	An integer that uniquely identifies the type of association. Format: int32

Create — tasks create Task — 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 timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — tasks get Task — 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 associated with 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 — tasks get Task — response body — warnings item

Referenced models: Read — tasks get Task — response body — warnings item, Read — tasks get Task — response body — properties With History value item

List associations — tasks 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 — tasks get Tasks — response body — paging
results	array	Required within parent	An array of objects, each containing multiple associations with labels. Each object includes details about the associated object and the types of associations.
results[]	Model	Each item	Expand List associations — tasks get Associations By To Object Type — response body — results item

Referenced models: List — tasks get Tasks — response body — paging, List associations — tasks get Associations By To Object Type — response body — results item

List associations — tasks 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, each containing details about the type of association and its label. Each item in the array is an object of type AssociationSpecWithLabel.
associationTypes[]	Model	Each item	Expand List associations — tasks 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 being made. It is a string.

Referenced models: List associations — tasks get Associations By To Object Type — response body — results item association Types item

List associations — tasks 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, which can be one of 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', or 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	A string representing the object type ID from which the association originates.
label	string	Optional	A string representing the label for the association, which is optional.
toObjectTypeId	string	Optional	A string representing the object type ID to which the association points.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer representing the unique identifier for the association type. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — tasks get Tasks — 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 — tasks get Tasks — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, representing the objects retrieved in the current page of results.
results[]	Model	Each item	Expand Read — tasks get Task — response body

Referenced models: List — tasks get Tasks — response body — paging, Read — tasks get Task — response body

List — tasks get Tasks — 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 List — tasks get Tasks — response body — paging next

Referenced models: List — tasks get Tasks — response body — paging next

List — tasks get Tasks — response body — paging next

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

Merge objects — tasks merge — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Input data for merging two records.
objectIdToMerge	string	Required within parent	The unique identifier of the object that will be merged into the primary object. This is a string.
primaryObjectId	string	Required within parent	The unique identifier of the object that will be retained as the primary object after the merge. This is a string.

Read a batch of tasks 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 an 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 in the response for each object.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings indicating the properties whose historical values should be returned along with their current values.
propertiesWithHistory[]	string	Each item

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

Read — tasks get Task — 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	A boolean indicating whether this object has been archived.
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 — tasks get Task — 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	A string identifier used for tracing the write operations on this object.
properties	object	Required within parent	A map of property names to their current values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of their historical values, each with a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — tasks get Task — 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 for accessing 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 — tasks get Task — response body — warnings item

Referenced models: Read — tasks get Task — response body — associations value, Read — tasks get Task — response body — warnings item, Read — tasks get Task — response body — properties With History value item

Read — tasks get Task — 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 tasks using specified criteria — response body — paging
results	array	Required within parent	An array of associated IDs, where each item is an object representing an association with a unique ID and type.
results[]	Model	Each item	Expand Read — tasks get Task — response body — associations value results item

Referenced models: Read — tasks get Task — response body — associations value results item, Search for tasks using specified criteria — response body — paging

Read — tasks get Task — 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 value.
type	string	Required within parent	The type of the association. It is a string value.

Read — tasks get Task — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	A string representing the unique identifier of the source.
sourceLabel	string	Optional	A string label providing a human-readable description of the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value originated.
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	An integer representing the ID of the user who last updated the value. 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 — tasks get Task — 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. This object can contain various key-value pairs, where each value is a string. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Search for tasks using specified criteria — 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 define the search criteria. Each filter group contains multiple filters that are applied together.
filterGroups[]	Model	Each item	Expand Search for tasks using specified criteria — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return. Format: int32
properties	array	Required within parent	An array of strings indicating the specific properties of the objects to be returned in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be matched against the objects.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results.
sorts[]	string	Each item

Referenced models: Search for tasks using specified criteria — request body — body filter Groups item

Search for tasks using specified criteria — 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 search results. Each filter specifies a property, an operator, and a value or range of values to match against.
filters[]	Model	Each item	Expand Search for tasks using specified criteria — request body — body filter Groups item filters item

Referenced models: Search for tasks using specified criteria — request body — body filter Groups item filters item

Search for tasks using specified criteria — 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	The upper boundary value for range-based filter conditions. It is a string.
operator	string	Required within parent	The operator that defines the type of comparison to be made. Valid values include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and '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.
value	string	Optional	The value to be used in the filter condition. It is a string.
values	array	Optional	An array of string values used for filters that operate on multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search for tasks using specified criteria — 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 tasks using specified criteria — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing a CRM object with its properties.
results[]	Model	Each item	Expand Create — tasks create Task — 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 tasks using specified criteria — response body — paging, Create — tasks create Task — response body

Search for tasks using specified criteria — 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 List — tasks get Tasks — response body — paging next
prev	Model	Optional	Expand Search — postal Mail search Postal Mail — response body — paging prev

Referenced models: Search — postal Mail search Postal Mail — response body — paging prev, List — tasks get Tasks — response body — paging next

Update a batch of tasks 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 items, each representing an object to be updated. Each item contains the properties and identifiers necessary for the update.
inputs[]	Model	Each item	Expand Update a batch of tasks by internal ID, or unique property values — request body — body inputs item

Referenced models: Update a batch of tasks by internal ID, or unique property values — request body — body inputs item

Update a batch of tasks by internal ID, or unique property values — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.
id	string	Required within parent	The id to be updated. This can be the object id, or the unique property value of the idProperty property
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string identifier used to trace the write operation for the object. This can be useful for debugging and tracking purposes.
properties	object	Required within parent	A map of property names to their values, representing the data fields of the CRM object. Each property is a key-value pair where the key is the property name and the value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — tasks update Task — 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 each value is the property's value. All properties are expected to be strings. Additional keys: see wildcard field
properties.*	string	Additional keys