Retrieve stage
Retrieve details of a specific stage within a pipeline for a given object type in HubSpot. This endpoint is useful for accessing information about a particular stage, such as its label, display order, and metadata, which can be used for managing or analyzing pipeline stages.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The type of object for which the pipeline stage is being retrieved.
The unique identifier of the pipeline that contains the stage.
The unique identifier of the stage to retrieve within the pipeline.
Response
successful operation
A boolean indicating whether the stage is archived.
The date and time when the stage was created, in ISO 8601 format.
An integer indicating the position of this stage within the pipeline, determining its order relative to other stages.
A unique string identifier for the pipeline stage.
The name or title of the pipeline stage, represented as a string.
An object containing additional metadata for the stage, with string values for each property.
The date and time when the stage was last updated, in ISO 8601 format.
A string indicating the write permissions for the stage. Valid values include 'CRM_PERMISSIONS_ENFORCEMENT', 'READ_ONLY', and 'INTERNAL_ONLY'.
CRM_PERMISSIONS_ENFORCEMENT, INTERNAL_ONLY, READ_ONLY The date and time when the stage was archived, in ISO 8601 format.