HubSpot: Users schemas

← Users operations · All schemas

Archive a batch of users 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 the ID of a CRM object to be processed in the batch operation.
inputs[]	Model	Each item	Expand Archive a batch of users by ID — request body — body inputs item

Referenced models: Archive a batch of users by ID — request body — body inputs item

Archive a batch of users by ID — 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. It is a string that serves as a reference to the specific object within HubSpot's CRM system.

Create a batch of users — 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 to be created, each defined by the SimplePublicObjectBatchInputForCreate schema.
inputs[]	Model	Each item	Expand Create a batch of users — request body — body inputs item

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

Create a batch of users — 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 specify the relationships between the objects being created and other existing objects. Each association includes details about the target object and the type of association.
associations[]	Model	Each item	Expand Create — users create User — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operations for the objects being created. This is 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. These properties define the attributes of the CRM objects being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — users create User — request body — body associations item

Create a batch of users — 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 each key mapping 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 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 the unique identifier for this error.
links	object	Required within parent	An object mapping link names to associated URIs for documentation or remediation steps. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing the error message.
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 users — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Users 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 — users create User — 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 — users create User — response body

Create a batch of users — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Users 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 users — 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 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 operation, each represented as a SimplePublicObject.
results[]	Model	Each item	Expand Create — users create User — 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 — users create User — response body, Create a batch of users — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create or update a batch of users by unique property values — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInputUpsert objects, each containing the properties and identifiers necessary for creating or updating a CRM object. This array is required.
inputs[]	Model	Each item	Expand Create or update a batch of users by unique property values — request body — body inputs item

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

Create or update a batch of users 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 created or updated.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string used for tracing the write operation of the object. This is optional and can be used for 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. These properties define the attributes of the CRM object. Additional keys: see wildcard field
properties.*	string	Additional keys

Create or update a batch of users 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	Indicates whether the 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
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	Indicates whether the object is newly created. A boolean value.
objectWriteTraceId	string	Optional	A trace ID for tracking the write operation of the object.
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 their values, including a history of changes with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — users get User — 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 the object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — users get User — response body — warnings item

Referenced models: Read — users get User — response body — warnings item, Read — users get User — response body — properties With History value item

Create or update a batch of users by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Users 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 contains details of an upserted CRM object.
results[]	Model	Each item	Expand Create or update a batch of users 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 users by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Create or update a batch of users by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Users 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 users — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs that provide additional information about the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The 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 users 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 users by unique property values — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Create a batch of users — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create — users create User — 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 define the associations between the new CRM object and other objects. Each association specifies the target object and the types of relationships.
associations[]	Model	Each item	Expand Create — users create User — 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. The properties define the attributes of the CRM object being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — users create User — request body — body associations item

Create — users create User — 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 — users create User — 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 an AssociationSpec object.
types[]	Model	Each item	Expand Create — users create User — request body — body associations item types item

Referenced models: Create — users create User — request body — body associations item types item, Create — users create User — request body — body associations item to

Create — users create User — 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 CRM object. It is a string value that is required for identifying the object in API operations.

Create — users create User — 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. 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	The unique identifier for the type of association. It is an integer value. Format: int32

Create — users create User — 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 the object write operation.
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 — users get User — 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 the object.
warnings	array	Optional	An array of warnings associated with this object, each represented by a PublicObjectWarning.
warnings[]	Model	Each item	Expand Read — users get User — response body — warnings item

Referenced models: Read — users get User — response body — warnings item, Read — users get User — response body — properties With History value item

List associations — users 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 — users get Users — response body — paging
results	array	Required within parent	An array of objects, each representing an association with a label. Each object includes details about the associated object and the types of associations.
results[]	Model	Each item	Expand List associations — users get Associations By To Object Type — response body — results item

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

List associations — users 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 including a category, type ID, and label. These specify the types of associations between objects.
associationTypes[]	Model	Each item	Expand List associations — users get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the object that is associated with another object. It is a string.

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

List associations — users 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 object type ID from which the association originates.
label	string	Optional	A string label that provides a human-readable name for the association.
toObjectTypeId	string	Optional	A string representing the object type ID to which the association is directed.
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 — users get Users — 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 — users get Users — 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 Read — users get User — response body

Referenced models: List — users get Users — response body — paging, Read — users get User — response body

List — users get Users — 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 — users get Users — response body — paging next

Referenced models: List — users get Users — response body — paging next

List — users get Users — 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 used as a cursor to fetch the next set of results in a paginated response.
link	string	Optional	A URL string that provides a direct link to the next page of results.

Read a batch of users 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 representing an object to be read.
inputs[]	Model	Each item	Expand Archive a batch of users by ID — request body — body inputs item
properties	array	Required within parent	An array of strings specifying the properties to be returned in the response. If any specified properties are not present on the requested objects, they will be ignored.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings specifying the properties to be returned along with their history of previous values. If any specified properties are not present on the requested objects, they will be ignored.
propertiesWithHistory[]	string	Each item

Referenced models: Archive a batch of users by ID — request body — body inputs item

Read — users get User — 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 has been 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 collection of associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — users get User — 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 unique identifier 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 an array of their historical values, each with a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — users get User — 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 — users get User — response body — warnings item

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

Read — users get User — 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 users based on specified criteria — response body — paging
results	array	Required within parent	An array of associated IDs, where each item represents an association with a unique identifier and type.
results[]	Model	Each item	Expand Read — users get User — response body — associations value results item

Referenced models: Read — users get User — response body — associations value results item, Search for users based on specified criteria — response body — paging

Read — users get User — 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 association. It is a string that distinguishes this association from others.
type	string	Required within parent	The type of the association, represented as a string. It specifies the nature or category of the association.

Read — users get User — 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 that uniquely identifies the 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 obtained.
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	A string representing the value at a specific point in time.

Read — users get User — 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 containing additional context about 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.

Search for users based on specified criteria — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string used as a paging cursor token to retrieve results after a specific point.
filterGroups	array	Required within parent	An array of FilterGroup objects that define the criteria for filtering the search results.
filterGroups[]	Model	Each item	Expand Search for users based on 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 properties to be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be applied.
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 users based on specified criteria — request body — body filter Groups item

Search for users based on 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 match against.
filters[]	Model	Each item	Expand Search for users based on specified criteria — request body — body filter Groups item filters item

Referenced models: Search for users based on specified criteria — request body — body filter Groups item filters item

Search for users based on 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	An optional string value used in range comparisons to specify the upper bound.
operator	string	Required within parent	The operator used to compare the property value with the specified value(s). It is a string and 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 be filtered. This is a string value.
value	string	Optional	The value to compare against the property specified by propertyName. This is a string value.
values	array	Optional	An array of string values used for comparison when the operator involves multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

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

Search for users based on 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 — users get Users — response body — paging next
prev	Model	Optional	Expand Search for users based on specified criteria — response body — paging prev

Referenced models: List — users get Users — response body — paging next, Search for users based on specified criteria — response body — paging prev

Search for users based on 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. It is used to retrieve the previous set of results 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 users 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 representing a single CRM object input to be processed in the batch operation.
inputs[]	Model	Each item	Expand Update a batch of users by internal ID, or unique property values — request body — body inputs item

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

Update a batch of users 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 used to trace the write operations for the object, useful for debugging and tracking changes.
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 its value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — users update User — 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 new value for that property. All properties are expected to be strings. Additional keys: see wildcard field
properties.*	string	Additional keys