HubSpot: Leads schemas

← Leads operations · All schemas

Archive a batch of leads by ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each representing a unique identifier for a CRM object. This is used to specify which objects are included in the batch operation.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item

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

Create a batch of leads — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInputForCreate objects, each containing the properties and associations needed to create a new CRM object.
inputs[]	Model	Each item	Expand Create a batch of leads — request body — body inputs item

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

Create a batch of leads — 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 that define relationships between the CRM objects being created and other objects. Each association specifies the target object and the type of association.
associations[]	Model	Each item	Expand Create — leads create Lead — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operations for the objects being created. This can be used for debugging or 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 objects to be created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — leads create Lead — request body — body associations item

Create a batch of leads — 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 indicating the category of the error.
context	object	Required within parent	An object containing additional context about the error, where each key maps to an array 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 further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string that uniquely identifies this error instance.
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 representing the status of the error.
subCategory	object	Optional	An object that provides more specific details about the error category.

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

Create a batch of leads — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Leads 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 about 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 simple public objects that were processed in the batch operation.
results[]	Model	Each item	Expand Create — leads create Lead — 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 — leads create Lead — response body

Create a batch of leads — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Leads Batch Response Simple Public Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Create a batch of leads — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
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
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 SimplePublicObject items representing the successful results of the batch operation.
results[]	Model	Each item	Expand Create — leads create Lead — 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 leads — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create — leads create Lead — response body

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

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

Create or update a batch of leads by unique property values — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
id	string	Required within parent	A string representing the unique identifier of the CRM object. This is required for identifying the object to be upserted.
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 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 corresponding property value. Additional keys: see wildcard field
properties.*	string	Additional keys

Create or update a batch of leads 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.
new	boolean	Required within parent	A boolean indicating whether this object is newly created.
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 current values, represented as key-value pairs. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of historical values, each with a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — leads get Lead — 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 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 — leads get Lead — response body — warnings item

Referenced models: Read — leads get Lead — response body — warnings item, Read — leads get Lead — response body — properties With History value item

Create or update a batch of leads by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Leads 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 that provide additional information about 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 results of the batch upsert operation.
results[]	Model	Each item	Expand Create or update a batch of leads 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 leads by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Create or update a batch of leads by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Leads 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 leads — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch upsert operation, each represented as a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Create or update a batch of leads by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

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

Create — leads create Lead — 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 object to other objects. Each association is defined by the 'PublicAssociationsForObject' schema.
associations[]	Model	Each item	Expand Create — leads create Lead — request body — body associations item
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

Referenced models: Create — leads create Lead — request body — body associations item

Create — leads create Lead — 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 — leads create Lead — request body — body associations item to
types	array	Required within parent	An array of association specifications, detailing the types of associations that exist between the objects. Each item in the array is an AssociationSpec object.
types[]	Model	Each item	Expand Create — carts create Cart — request body — body associations item types item

Referenced models: Create — carts create Cart — request body — body associations item types item, Create — leads create Lead — request body — body associations item to

Create — leads create Lead — request body — body associations item to

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	A string representing the unique identifier for the public object.

Create — leads create Lead — 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 on 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 a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — leads get Lead — 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 warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — leads get Lead — response body — warnings item

Referenced models: Read — leads get Lead — response body — warnings item, Read — leads get Lead — response body — properties With History value item

GDPR Delete — leads gdpr Delete — 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
objectId	string	Required within parent	A string representing the unique identifier of the object to be deleted. This property is required.

List associations — leads 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 — calls get Calls — response body — paging
results	array	Required within parent	An array of objects, each representing a multi-associated object with labels. Each object contains information about the associations and their respective labels.
results[]	Model	Each item	Expand List associations — leads get Associations By To Object Type — response body — results item

Referenced models: List — calls get Calls — response body — paging, List associations — leads get Associations By To Object Type — response body — results item

List associations — leads get Associations By To Object Type — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object that is associated with multiple other objects, with optional context.
associationTypes	array	Required within parent	An array of association specifications with labels, detailing the types of associations between the objects.
associationTypes[]	Model	Each item	Expand List associations — leads 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 — leads get Associations By To Object Type — response body — results item association Types item

List associations — leads 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, indicating its origin or purpose. 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 originating object in the association.
label	string	Optional	A string label that describes the association.
toObjectTypeId	string	Optional	A string representing the type ID of the target object in the association.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer representing the unique identifier for the type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — leads get Leads — 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 — calls get Calls — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing an object with its associated data.
results[]	Model	Each item	Expand Read — leads get Lead — response body

Referenced models: List — calls get Calls — response body — paging, Read — leads get Lead — response body

Merge objects — leads 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 primary object that will remain after the merge. This is a string.

Read a batch of leads 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. These IDs are used to specify which objects should be included in the batch read operation.
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 does not exist 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. Using this parameter may reduce the number of objects that can be read in a single request.
propertiesWithHistory[]	string	Each item

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

Read — leads get Lead — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
archived	boolean	Required within parent	Indicates whether this object is archived. A boolean value.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
associations	object	Optional	A map of associated object types to their associated IDs, representing the relationships this object has with others. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — leads get Lead — response body — associations value
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
objectWriteTraceId	string	Optional	An identifier used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their current values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values, including a history of previous values with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — leads get Lead — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL link to access this object.
warnings	array	Optional	A list of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — leads get Lead — response body — warnings item

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

Read — leads get Lead — 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 leads using specified criteria — response body — paging
results	array	Required within parent	An array of associated IDs, where each item is an object containing an ID and its type. This property is required.
results[]	Model	Each item	Expand Read — leads get Lead — response body — associations value results item

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

Read — leads get Lead — 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	A string that uniquely identifies the associated object.
type	string	Required within parent	A string indicating the type of the association.

Read — leads get Lead — 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 providing a human-readable description of the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value was derived. This property is required.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	The ID of the user who last updated the value, represented as an integer. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The value associated with the timestamp. It is represented as a string.

Read — leads get Lead — response body — warnings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
category	string	Required within parent	A string indicating the category of the warning.
context	object	Required within parent	An object providing additional context about the warning, with string properties. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the message that describes the warning.

Search for leads 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 that serves as a cursor for pagination, indicating where to start returning results.
filterGroups	array	Required within parent	An array of filter groups used to narrow down the search results based on specified criteria.
filterGroups[]	Model	Each item	Expand Search for leads 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 which properties of the CRM 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 CRM objects.
sorts	array	Required within parent	An array of strings specifying the sort order of the search results.
sorts[]	string	Each item

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

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

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

Search for leads 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 bound value for range-based filtering. It is a string.
operator	string	Required within parent	The operator used to compare the property value against the filter criteria. Valid operators 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 by. It is a string.
value	string	Optional	The specific value to filter for the given propertyName. It is a string.
values	array	Optional	An array of string values used for filtering when multiple values are applicable.
values[]	string	Each item

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

Search for leads 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 Search for calls — response body — paging next
prev	Model	Optional	Expand Search for leads using specified criteria — response body — paging prev

Referenced models: Search for calls — response body — paging next, Search for leads using specified criteria — response body — paging prev

Search for leads using specified criteria — 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 that indicates the position of the last item on the previous page, used for pagination.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

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

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInput objects, each containing the properties and identifiers for a CRM object to be updated. This is required for the batch update operation.
inputs[]	Model	Each item	Expand Update a batch of leads by internal ID, or unique property values — request body — body inputs item

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

Update a batch of leads 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 operations on the object.
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, all represented as strings. Additional keys: see wildcard field
properties.*	string	Additional keys