HubSpot: Contacts schemas

← Contacts operations · All schemas

Archive a batch of contacts — 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 CRM object. This array is required for batch processing operations.
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

Archive a batch of contacts — request body — body inputs item

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 object, represented as a string.

Create a batch of contacts — 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 CRM object to be created. Each object includes properties and associations necessary for the creation process.
inputs[]	Model	Each item	Expand Create a batch of contacts — request body — body inputs item

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

Create a batch of contacts — 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 specifies the related object IDs and types.
associations[]	Model	Each item	Expand Create a contact — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for the objects being created.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM objects to be created. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create a contact — request body — body associations item

Create a batch of contacts — 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 that categorizes 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 that provide 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 a unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation or recommended remediation steps for 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 contacts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Contacts 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, providing 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 representing the results of the batch operation.
results[]	Model	Each item	Expand Create a contact — 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 status of the batch processing request. The expected value is "COMPLETE". Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create a contact — response body

Create a batch of contacts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Contacts 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 standard errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Create a batch of contacts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
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
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 simple public objects that are the result of the batch operation.
results[]	Model	Each item	Expand Create a contact — 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 contacts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create a contact — response body

Create a contact — 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 link this CRM object to other objects. Each association specifies the target object and the type of association.
associations[]	Model	Each item	Expand Create a contact — request body — body associations item
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 the value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create a contact — request body — body associations item

Create a contact — 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 Read batch objects — carts batch Get Carts — request body — body inputs item
types	array	Required within parent	An array of association specifications, each detailing the category and type of association between the objects.
types[]	Model	Each item	Expand Create a contact — request body — body associations item types item

Referenced models: Read batch objects — carts batch Get Carts — request body — body inputs item, Create a contact — request body — body associations item types item

Create a contact — 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	The category of the association, indicating its origin or purpose. 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 representing the unique identifier for the type of association. Format: int32

Create a contact — 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 representing the trace ID for write operations related to 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 their historical values, each represented as an array of ValueWithTimestamp objects. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create a contact — 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 containing the URL of this object.
warnings	array	Optional	An array of PublicObjectWarning objects, each containing warnings related to this object.
warnings[]	Model	Each item	Expand Create a contact — response body — warnings item

Referenced models: Create a contact — response body — warnings item, Create a contact — response body — properties With History value item

Create a contact — 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 identifier for the specific source of the value.
sourceLabel	string	Optional	A string label that provides a human-readable name for 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 actual value being recorded. It is a string.

Create a contact — 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 representing the category of the warning.
context	object	Required within parent	An object providing additional context for the warning, with string values for each context key. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Create or update a batch of contacts — 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 needed for the upsert operation.
inputs[]	Model	Each item	Expand Create or update a batch of contacts — request body — body inputs item

Referenced models: Create or update a batch of contacts — request body — body inputs item

Create or update a batch of contacts — 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 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 contacts — 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 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.
new	boolean	Required within parent	A boolean indicating whether this object is newly created.
objectWriteTraceId	string	Optional	An identifier for tracing the creation request.
properties	object	Required within parent	A map of property names to their current values for the 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 Create a contact — 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 of the object.
warnings	array	Optional	An array of warnings related to the object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Create a contact — response body — warnings item

Referenced models: Create a contact — response body — warnings item, Create a contact — response body — properties With History value item

Create or update a batch of contacts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Contacts 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 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 objects representing the results of the upsert operation. Each object is a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Create or update a batch of contacts — 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 contacts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Create or update a batch of contacts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Contacts 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 encountered during the batch operation, each represented as a StandardError.
errors[]	Model	Each item	Expand Create a batch of contacts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs that provide additional information 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 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 containing the results of the upsert operation, each represented as a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Create or update a batch of contacts — 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 contacts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create or update a batch of contacts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

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

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

List associations — contacts 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 types, each including a label. Each item in the array is an object that specifies the type of association and its label.
associationTypes[]	Model	Each item	Expand List associations — contacts 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 — contacts get Associations By To Object Type — response body — results item association Types item

List associations — contacts 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	A string representing the type ID of the object from which the association originates.
label	string	Optional	A string representing the label for the association.
toObjectTypeId	string	Optional	A string representing the type ID of the object to which the association is directed.
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]+)?$

Merge two contacts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Input data for merging two records.
objectIdToMerge	string	Required within parent	The object ID of the record that the merge will not set as the current value after the merge.
primaryObjectId	string	Required within parent	The object ID of the record that the merge will generally set as the current value after the merge.

Permanently delete a contact (GDPR-compliant) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	An input that contains the information required to process a public GDPR data deletion request.
idProperty	string	Optional	The name of a property whose values are unique for this object. An alternative to identifying a contact by ID.
objectId	string	Required within parent	The ID of the contact to permanently delete.

Retrieve a batch of contacts — 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 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 representing the properties to be returned along with their history of previous values. If a specified property is not present on an object, it will be ignored.
propertiesWithHistory[]	string	Each item

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

Retrieve a contact — 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 respective associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Retrieve a contact — 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 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 their values along with a history of changes, including timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create a contact — 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 associated with this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Create a contact — response body — warnings item

Referenced models: Retrieve a contact — response body — associations value, Create a contact — response body — warnings item, Create a contact — response body — properties With History value item

Retrieve a contact — 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 contacts — response body — paging
results	array	Required within parent	An array of associated IDs, where each item represents an associated object. The array contains objects of type 'AssociatedId'.
results[]	Model	Each item	Expand Retrieve a contact — response body — associations value results item

Referenced models: Retrieve a contact — response body — associations value results item, Search for contacts — response body — paging

Retrieve a contact — 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. This is a string value.
type	string	Required within parent	The type of association between the objects. This is a string value.

Retrieve contacts — 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 Retrieve contacts — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing a CRM object with its associated data.
results[]	Model	Each item	Expand Retrieve a contact — response body

Referenced models: Retrieve contacts — response body — paging, Retrieve a contact — response body

Retrieve contacts — 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 Retrieve contacts — response body — paging next

Referenced models: Retrieve contacts — response body — paging next

Retrieve contacts — 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 on the current page. This token is used to fetch the next set of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Search for contacts — 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 to retrieve results after a specific point in the result set.
filterGroups	array	Required within parent	An array of filter groups used to narrow down the search results. Each filter group contains a set of filters that are applied together.
filterGroups[]	Model	Each item	Expand Search for contacts — request body — body filter Groups item
limit	integer	Required within parent	An integer indicating the maximum number of results to return. 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 the search query to be applied to 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 contacts — request body — body filter Groups item

Search for contacts — 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 the search. Each filter specifies a property, an operator, and a value to match against.
filters[]	Model	Each item	Expand Search for contacts — request body — body filter Groups item filters item

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

Search for contacts — 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 representing the upper bound of a range filter, used when the operator is 'BETWEEN'.
operator	string	Required within parent	The operator used to compare the property value. It is a string and 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 to filter on. It is a string that specifies which object property the filter applies to.
value	string	Optional	The value to compare against the specified property. It is a string used in conjunction with the operator to determine matching results.
values	array	Optional	An array of strings representing multiple values to compare against the specified property, used with operators like 'IN' or 'NOT_IN'.
values[]	string	Each item

Search for contacts — 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 contacts — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing an individual public object.
results[]	Model	Each item	Expand Create a contact — 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 contacts — response body — paging, Create a contact — response body

Search for contacts — 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 Retrieve contacts — response body — paging next
prev	Model	Optional	Expand Search for contacts — response body — paging prev

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

Search for contacts — 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 identify the position before the current page in a paginated list.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Update a batch of contacts — 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 object contains the properties and identifiers necessary for processing a batch update operation.
inputs[]	Model	Each item	Expand Update a batch of contacts — request body — body inputs item

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

Update a batch of contacts — 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 of the contact to update. This can be the object ID, or the unique property value of the `idProperty` property.
idProperty	string	Optional	The name of a unique property, when identifying records by property.
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or tracking purposes.
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

Update a contact — 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 representing the properties of the CRM object to be updated. Each key is a property name, and each value is the property's new value, both as strings. Additional keys: see wildcard field
properties.*	string	Additional keys