HubSpot: Projects schemas

← Projects operations · All schemas

Batch archive objects — projects batch Delete Projects — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing an ID of a CRM object to be processed. This property is required.
inputs[]	Model	Each item	Expand Read batch objects — carts batch Get Carts — request body — body inputs item

Referenced models: Read batch objects — carts batch Get Carts — request body — body inputs item

Batch create objects — projects batch Create Projects — 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 CRM object.
inputs[]	Model	Each item	Expand Batch create objects — projects batch Create Projects — request body — body inputs item

Referenced models: Batch create objects — projects batch Create Projects — request body — body inputs item

Batch create objects — projects batch Create Projects — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	An input object that contains a collection of objects to be created together in a batch.
associations	array	Required within parent	An array of associations for the objects being created, where each association specifies the related object and the type of association.
associations[]	Model	Each item	Expand Create — projects create Project — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the property values for the CRM objects being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — projects create Project — request body — body associations item

Batch read objects — projects batch Get Projects — 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	A string representing the name of a property whose values are unique for the object type. This property is used to identify objects uniquely.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each representing an object to be read in the batch operation.
inputs[]	Model	Each item	Expand Read batch objects — carts batch Get Carts — request body — body inputs item
properties	array	Required within parent	An array of strings specifying the properties to be returned for each object in the batch. If a specified property is not present on an object, it will be ignored.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings specifying the properties to be returned along with their history of previous values for each object in the batch. If a specified property is not present on an object, it will be ignored.
propertiesWithHistory[]	string	Each item

Referenced models: Read batch objects — carts batch Get Carts — request body — body inputs item

Batch read objects — projects.batchGetProjects — 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 specifying the category of the error.
context	object	Required within parent	An object containing additional context about the error, where each key is a context name and the value is 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, each 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 that describes 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

Batch read objects — projects.batchGetProjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Projects 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 for additional information 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 — projects create Project — 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 — projects create Project — response body

Batch read objects — projects.batchGetProjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Projects 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 Batch read objects — projects.batchGetProjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional context or resources related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors 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 — projects create Project — 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 — projects create Project — response body, Batch read objects — projects.batchGetProjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create — projects create Project — 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 existing objects. Each association is specified by a 'PublicAssociationsForObject' object.
associations[]	Model	Each item	Expand Create — projects create Project — 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 property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — projects create Project — request body — body associations item

Create — projects create Project — 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 Archive a batch of contacts — request body — body inputs item
types	array	Required within parent	An array of association specifications, each defining the type of association between the source and target objects. Each item in the array is an AssociationSpec object.
types[]	Model	Each item	Expand Create meeting — request body — body associations item types item

Referenced models: Archive a batch of contacts — request body — body inputs item, Create meeting — request body — body associations item types item

Create — projects create Project — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
objectWriteTraceId	string	Optional	A string used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their values for this object, 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 their historical values, where each historical value includes a timestamp and the value at that time. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — projects get Project — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL of this object.
warnings	array	Optional	An array of warnings related to this object, where each warning includes a category, message, and context.
warnings[]	Model	Each item	Expand Read — projects get Project — response body — warnings item

Referenced models: Read — projects get Project — response body — warnings item, Read — projects get Project — response body — properties With History value item

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

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

List associations — projects 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 label. These define the types of associations between the objects.
associationTypes[]	Model	Each item	Expand List associations — projects get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the object to which associations are being made. It is a string.

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

List associations — projects 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	A string representing the category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	A string representing the object type ID from which the association originates.
label	string	Optional	A string representing an optional label 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 — projects get Projects — 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 — projects get Projects — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, representing the CRM objects retrieved in the current page.
results[]	Model	Each item	Expand Read — projects get Project — response body

Referenced models: List — projects get Projects — response body — paging, Read — projects get Project — response body

List — projects get Projects — 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 — projects get Projects — response body — paging next

Referenced models: List — projects get Projects — response body — paging next

List — projects get Projects — 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 page of results.
link	string	Optional	A string representing the URL link to the next page of results.

Read — projects get Project — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
associations	object	Optional	A map of associated object types to their associated IDs, providing links to related objects. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — projects get Project — 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 CRM object.
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 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 changes with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — projects get Project — 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 associated with this object, detailing any issues or considerations.
warnings[]	Model	Each item	Expand Read — projects get Project — response body — warnings item

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

Read — projects get Project — 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 — projects search Projects — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an object containing the ID and type. This property is required.
results[]	Model	Each item	Expand Read — projects get Project — response body — associations value results item

Referenced models: Read — projects get Project — response body — associations value results item, Search — projects search Projects — response body — paging

Read — projects get Project — 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 representing the unique identifier of the associated object.
type	string	Required within parent	A string indicating the type of association, which categorizes the relationship between objects.

Read — projects get Project — 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 identifier of the source from which the value was obtained.
sourceLabel	string	Optional	A string providing a label or name for the source of the value.
sourceType	string	Required within parent	A string specifying the type of source from which the value was obtained.
timestamp	string	Required within parent	A string in date-time format indicating when the value was recorded. 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 of the property at the given timestamp.

Read — projects get Project — response body — warnings item

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

Search — projects search Projects — 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 the next set of results in a paginated response.
filterGroups	array	Required within parent	An array of filter groups used to specify the criteria for searching objects. Each filter group contains filters that define the conditions objects must meet.
filterGroups[]	Model	Each item	Expand Search — projects search Projects — 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 objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be applied to the objects.
sorts	array	Required within parent	An array of strings specifying the properties by which the search results should be sorted.
sorts[]	string	Each item

Referenced models: Search — projects search Projects — request body — body filter Groups item

Search — projects search Projects — 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. Each filter specifies a condition to be applied in the search query. This property is required.
filters[]	Model	Each item	Expand Search — projects search Projects — request body — body filter Groups item filters item

Referenced models: Search — projects search Projects — request body — body filter Groups item filters item

Search — projects search Projects — 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 upper bound value used in range-based filters. It is a string.
operator	string	Required within parent	The operator that defines the type of comparison to be made. Valid values include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and 'NOT_CONTAINS_TOKEN'. One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyName	string	Required within parent	The name of the property to apply the filter on. It is a string.
value	string	Optional	The specific value to compare against the property. It is a string.
values	array	Optional	An array of string values used for filters that operate on multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search — projects search Projects — 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 — projects search Projects — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing a public object with its properties.
results[]	Model	Each item	Expand Create — projects create Project — 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 — projects search Projects — response body — paging, Create — projects create Project — response body

Search — projects search Projects — 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 — projects get Projects — response body — paging next
prev	Model	Optional	Expand Search — projects search Projects — response body — paging prev

Referenced models: Search — projects search Projects — response body — paging prev, List — projects get Projects — response body — paging next

Search — projects search Projects — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token used to identify the position before the current page in the pagination sequence.
link	string	Optional	A URL string that provides a direct link to the previous page of results.

Update batch objects — projects batch Update Projects — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInput items, each representing a single object to be updated. Each item includes the object's properties and optional metadata.
inputs[]	Model	Each item	Expand Update batch objects — projects batch Update Projects — request body — body inputs item

Referenced models: Update batch objects — projects batch Update Projects — request body — body inputs item

Update batch objects — projects batch Update Projects — 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	A string representing the unique identifier of the object.
idProperty	string	Optional	A string indicating the name of a property whose values are unique for this object type.
objectWriteTraceId	string	Optional	A string that serves as a trace identifier for the object write operation.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values. Each value is expected to be a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — projects update Project — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the input required to update a CRM object, containing an object with property names and their corresponding values.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and the value is the property's value. All properties are represented as strings. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — projects batch Upsert Projects — 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 for a CRM object to be created or updated. This array is required.
inputs[]	Model	Each item	Expand Upsert batch objects — projects batch Upsert Projects — request body — body inputs item

Referenced models: Upsert batch objects — projects batch Upsert Projects — request body — body inputs item

Upsert batch objects — projects batch Upsert Projects — 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 object to be upserted.
idProperty	string	Optional	A string indicating the name of the property whose values are unique for this object type.
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and the value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — projects.batchUpsertProjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object that has either been created or updated (upserted)
archived	boolean	Required within parent	A boolean indicating whether the object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
new	boolean	Required within parent	A boolean indicating whether this object is newly created.
objectWriteTraceId	string	Optional	A string used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their values, where each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	An object containing property names mapped to arrays of their historical values, each represented by a ValueWithTimestamp object. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — projects get Project — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL of this object.
warnings	array	Optional	An array of warnings related to this object, each represented by a PublicObjectWarning object.
warnings[]	Model	Each item	Expand Read — projects get Project — response body — warnings item

Referenced models: Read — projects get Project — response body — warnings item, Read — projects get Project — response body — properties With History value item

Upsert batch objects — projects.batchUpsertProjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Projects Batch Response Simple Public Upsert Object

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional context or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch upsert operation, each represented as a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Upsert batch objects — projects.batchUpsertProjects — 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: Upsert batch objects — projects.batchUpsertProjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — projects.batchUpsertProjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Projects Batch Response Simple Public Upsert Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError items detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Batch read objects — projects.batchGetProjects — 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 SimplePublicUpsertObject items representing the results of the upsert operation.
results[]	Model	Each item	Expand Upsert batch objects — projects.batchUpsertProjects — 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: Upsert batch objects — projects.batchUpsertProjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Batch read objects — projects.batchGetProjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item