HubSpot: Feedback submissions schemas

← Feedback submissions operations · All schemas

List associations — feedback Submissions 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 — feedback Submissions get Feedback Submissions — response body — paging
results	array	Required within parent	An array of objects, each representing a multi-associated object with labels. Each item includes the associated object ID and the types of associations with labels.
results[]	Model	Each item	Expand List associations — feedback Submissions get Associations By To Object Type — response body — results item

Referenced models: List — feedback Submissions get Feedback Submissions — response body — paging, List associations — feedback Submissions get Associations By To Object Type — response body — results item

List associations — feedback Submissions 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 type and label. These define the nature of the association between the objects.
associationTypes[]	Model	Each item	Expand List associations — feedback Submissions 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 being associated. It is a string value.

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

List associations — feedback Submissions 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 indicating the type ID of the source object in the association.
label	string	Optional	A string representing the label for the association, which can be used to describe the nature of the relationship between the objects.
toObjectTypeId	string	Optional	A string indicating 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 association type. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — feedback Submissions get Feedback Submissions — 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 — feedback Submissions get Feedback Submissions — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing a CRM object and its associated data.
results[]	Model	Each item	Expand Read — feedback Submissions get Feedback Submission — response body

Referenced models: List — feedback Submissions get Feedback Submissions — response body — paging, Read — feedback Submissions get Feedback Submission — response body

List — feedback Submissions get Feedback Submissions — 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 — feedback Submissions get Feedback Submissions — response body — paging next

Referenced models: List — feedback Submissions get Feedback Submissions — response body — paging next

List — feedback Submissions get Feedback Submissions — 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 can be used to retrieve the next page of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Read batch objects — feedback Submissions batch Get Feedback Submissions — 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 by its ID.
inputs[]	Model	Each item	Expand Archive a batch of contacts — 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 contacts — request body — body inputs item

Read batch objects — feedbackSubmissions.batchGetFeedbackSubmissions — 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 condition, 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 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 the unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation about the error or recommended remediation steps. 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 details about the error category.

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

Read batch objects — feedbackSubmissions.batchGetFeedbackSubmissions — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Feedback Submissions 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 Search — feedback Submissions search Feedback Submissions — response body — 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: Search — feedback Submissions search Feedback Submissions — response body — results item

Read batch objects — feedbackSubmissions.batchGetFeedbackSubmissions — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Feedback Submissions 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 items detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — feedbackSubmissions.batchGetFeedbackSubmissions — 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 SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Search — feedback Submissions search Feedback Submissions — response body — 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: Read batch objects — feedbackSubmissions.batchGetFeedbackSubmissions — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Search — feedback Submissions search Feedback Submissions — response body — results item

Read — feedback Submissions get Feedback Submission — 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 the object is archived. A boolean value.
archivedAt	string	Optional	The date and time when the 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 Read — feedback Submissions get Feedback Submission — response body — associations value
createdAt	string	Required within parent	The date and time when the object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the CRM object.
objectWriteTraceId	string	Optional	An identifier for tracing the write operations on 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 arrays of historical values, each with a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — feedback Submissions get Feedback Submission — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when the object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL link to access 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 Read — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Read — feedback Submissions get Feedback Submission — response body — associations value, Read — feedback Submissions get Feedback Submission — response body — properties With History value item

Read — feedback Submissions get Feedback Submission — 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 — feedback Submissions search Feedback Submissions — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an 'AssociatedId' object. This property is required.
results[]	Model	Each item	Expand Read — feedback Submissions get Feedback Submission — response body — associations value results item

Referenced models: Read — feedback Submissions get Feedback Submission — response body — associations value results item, Search — feedback Submissions search Feedback Submissions — response body — paging

Read — feedback Submissions get Feedback Submission — response body — associations value results item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the id and type of an association
id	string	Required within parent	The unique identifier for the associated object. It is a string value.
type	string	Required within parent	The type of the associated object. It is a string value.

Read — feedback Submissions get Feedback Submission — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	A string representing the unique identifier of the source.
sourceLabel	string	Optional	A string providing a label or 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	A string representing the value associated with the timestamp.

Search — feedback Submissions search Feedback Submissions — 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 the next set of results in a paginated response.
filterGroups	array	Required within parent	An array of FilterGroup objects that define the filtering criteria for the search. Each FilterGroup contains multiple filters that are combined using logical AND operations.
filterGroups[]	Model	Each item	Expand Search — feedback Submissions search Feedback Submissions — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return in the search response. Format: int32
properties	array	Required within parent	An array of strings specifying the properties to be included in the search results. Only the specified properties will be returned.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against the CRM objects.
sorts	array	Required within parent	An array of strings specifying the properties by which the search results should be sorted. The sorting order is determined by the order of the strings in the array.
sorts[]	string	Each item

Referenced models: Search — feedback Submissions search Feedback Submissions — request body — body filter Groups item

Search — feedback Submissions search Feedback Submissions — 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 — feedback Submissions search Feedback Submissions — request body — body filter Groups item filters item

Referenced models: Search — feedback Submissions search Feedback Submissions — request body — body filter Groups item filters item

Search — feedback Submissions search Feedback Submissions — 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-based filters to specify the upper bound of the range.
operator	string	Required within parent	The operator used to compare the property value with the specified value(s). It is a string and can be one of several predefined operators such as 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', or 'NOT_CONTAINS_TOKEN'. One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyName	string	Required within parent	The name of the property to which the filter is applied. It is a string that identifies the specific property of the object.
value	string	Optional	The value to be compared against the object's property. It is a string used in conjunction with the operator to filter results.
values	array	Optional	An array of strings representing multiple values for comparison. This is used with operators that support multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search — feedback Submissions search Feedback Submissions — 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 — feedback Submissions search Feedback Submissions — response body — paging
results	array	Required within parent	An array containing the simple public objects returned in the current page.
results[]	Model	Each item	Expand Search — feedback Submissions search Feedback Submissions — response body — results item
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 — feedback Submissions search Feedback Submissions — response body — paging, Search — feedback Submissions search Feedback Submissions — response body — results item

Search — feedback Submissions search Feedback Submissions — 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 — feedback Submissions get Feedback Submissions — response body — paging next
prev	Model	Optional	Expand Search objects — services search Services — response body — paging prev

Referenced models: List — feedback Submissions get Feedback Submissions — response body — paging next, Search objects — services search Services — response body — paging prev

Search — feedback Submissions search Feedback Submissions — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
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, 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 timestamp and value. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — feedback Submissions get Feedback Submission — 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 — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Read — feedback Submissions get Feedback Submission — response body — properties With History value item