HubSpot: Pipelines schemas

← Pipelines operations · All schemas

Create Stage — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
displayOrder	integer	Required within parent	An integer indicating the position of this stage within the pipeline. Lower numbers indicate earlier stages. Format: int32
label	string	Required within parent	The name of the pipeline stage. It is a string that provides a human-readable identifier for the stage.
metadata	object	Required within parent	An object containing additional properties for the stage. Each property is a key-value pair where both key and value are strings. Additional keys: see wildcard field
metadata.*	string	Additional keys
stageId	string	Optional	A string that uniquely identifies the stage within the pipeline.

Create Stage — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether the stage is archived.
archivedAt	string	Optional	The date and time when the stage was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the stage was created, in ISO 8601 format. Format: date-time
displayOrder	JSON	Required within parent
displayOrder (anyOf 1)	integer	Alternative	An integer indicating the position of this stage within the pipeline, determining its order relative to other stages. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	A unique string identifier for the pipeline stage.
label	string	Required within parent	The name or title of the pipeline stage, represented as a string.
metadata	object	Required within parent	An object containing additional metadata for the stage, with string values for each property. Additional keys: see wildcard field
metadata.*	string	Additional keys
updatedAt	string	Required within parent	The date and time when the stage was last updated, in ISO 8601 format. Format: date-time
writePermissions	string	Required within parent	A string indicating the write permissions for the stage. Valid values include 'CRM_PERMISSIONS_ENFORCEMENT', 'READ_ONLY', and 'INTERNAL_ONLY'. Known values: CRM_PERMISSIONS_ENFORCEMENT, INTERNAL_ONLY, READ_ONLY

Create pipeline — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
displayOrder	integer	Required within parent	An integer indicating the order in which the pipeline appears relative to other pipelines. Format: int32
label	string	Required within parent	A string representing the name or title of the pipeline.
pipelineId	string	Optional	A string that uniquely identifies the pipeline. This property is optional when creating a new pipeline.
stages	array	Required within parent	An array of PipelineStageInput objects, each representing a stage within the pipeline.
stages[]	Model	Each item	Expand Create Stage — request body — body

Referenced models: Create Stage — request body — body

Create pipeline — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	A boolean indicating whether the pipeline is archived.
archivedAt	string	Optional	The date and time when the pipeline was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the pipeline was created, in ISO 8601 format. Format: date-time
displayOrder	JSON	Required within parent
displayOrder (anyOf 1)	integer	Alternative	An integer indicating the order in which the pipeline appears relative to other pipelines. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	A unique string identifier for the pipeline.
label	string	Required within parent	The name or title of the pipeline, represented as a string.
stages	array	Required within parent	An array of PipelineStage objects that define the stages within this pipeline.
stages[]	Model	Each item	Expand Create Stage — response body
updatedAt	string	Required within parent	The date and time when the pipeline was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create Stage — response body

List stages — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of pipeline stages, each represented by a PipelineStage object.
results[]	Model	Each item	Expand Create Stage — response body

Referenced models: Create Stage — response body

Retrieve pipelines — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of Pipeline objects, each representing a specific pipeline within the collection.
results[]	Model	Each item	Expand Create pipeline — response body

Referenced models: Create pipeline — response body

Retrieve stage audit — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of PublicAuditInfo objects, each representing an individual audit log entry. These entries contain details about actions performed, identifiers, portal IDs, and other relevant audit information.
results[]	Model	Each item	Expand Retrieve stage audit — response body — results item

Referenced models: Retrieve stage audit — response body — results item

Retrieve stage audit — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	A string describing the action that was performed, such as 'create', 'update', or 'delete'.
fromUserId	JSON	Optional
fromUserId (anyOf 1)	integer	Alternative	The unique identifier of the user who performed the action, represented as an integer. Format: int32
fromUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
identifier	string	Required within parent	A string that uniquely identifies the specific audit entry.
message	string	Optional	A string providing additional information or context about the action taken.
portalId	JSON	Required within parent
portalId (anyOf 1)	integer	Alternative	The unique identifier for the HubSpot account (portal) where the action took place. It is an integer. Format: int32
portalId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rawObject	object	Optional	An object containing the raw data associated with the action. This can include detailed information about the state before and after the action.
timestamp	string	Optional	The date and time when the action occurred, in ISO 8601 format. Format: date-time

Update pipeline (Partial) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	A boolean value that indicates whether the pipeline is archived.
displayOrder	integer	Optional	An integer indicating the position of the pipeline in a list, which determines its display order. Format: int32
label	string	Optional	The name of the pipeline, represented as a string.

Update pipeline (Replace) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
displayOrder	integer	Required within parent	An integer indicating the order in which the pipeline appears relative to other pipelines. Format: int32
label	string	Required within parent	A string representing the name of the pipeline.
stages	array	Required within parent	An array of PipelineStageInput objects, each representing a stage within the pipeline.
stages[]	Model	Each item	Expand Create Stage — request body — body

Referenced models: Create Stage — request body — body

Update stage (Partial) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	A boolean indicating whether the pipeline stage is archived.
displayOrder	integer	Optional	An integer specifying the order in which the stage appears relative to other stages. Format: int32
label	string	Optional	A string representing the name or title of the pipeline stage.
metadata	object	Required within parent	An object containing additional properties related to the pipeline stage, where each property is a string. Additional keys: see wildcard field
metadata.*	string	Additional keys

Update stage — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
displayOrder	integer	Required within parent	An integer indicating the position of the stage within the pipeline. Format: int32
label	string	Required within parent	The name of the pipeline stage, represented as a string.
metadata	object	Required within parent	An object containing additional properties related to the stage, where each property is a string. Additional keys: see wildcard field
metadata.*	string	Additional keys