Lifecycle Stage Object
Lifecycle stages define the steps on a sales journey. In Account Engagement, we define the following lifecycle stages:
- Visitor
- Prospect
- Marketing qualified lead (MQL)
- Sales qualified lead (SQL)
- Won opportunity Use lifecycle stage resources to learn about a prospect's current lifecycle stage, including the stage name and position. Learn more about prospect lifecycles in Salesforce Help.
| Operation | HTTP Verb | URL Format | Ability Requirements |
|---|---|---|---|
| Read | GET | https://pi.pardot.com/api/v5/objects/lifecycle-stages/<id>?<params> | Prospect > Lifecycle > View Report ability |
| Query | GET | https://pi.pardot.com/api/v5/objects/lifecycle-stages?<params> | Prospect > Lifecycle > View Report ability |
| Field | Type | Description |
|---|---|---|
id | Integer | ID of the lifecycle stage. |
name | String | Account Engagement ID of this lifecycle stage. |
isDeleted | Boolean | True if the lifecycle stage is in the recycle bin in Account Engagement. |
createdAt | DateTime | Creation time of the lifecycle stage. |
updatedAt | DateTime | Last updated time for the lifecycle stage. |
isLocked | Boolean | When true, lifecycle stage is locked. |
position | Integer | Lifcycle stage's position in lifecycle. |
matchType | Enum | Match all is returned when a prospect must match all rules in order to be in this stage. Match any is returned when a prospect can match 1 or more rules |
Retrieve a single lifecycle stage following the conventions described in the Version 5 Overview.
Example request:
Example response:
Retrieving a collection of lifecycle stages follows the conventions described in Version 5 Overview.
When executing a query, the following fields can be specified in the orderBy parameter. See the conventions for query described in the Version 5 Overview.
idcreatedAtupdatedAt
Example request:
Example response:
When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.
| Parameter | Description |
|---|---|
id | Returns any lifecycle stage where ID is equal to the given integer value. |
idList | Returns any lifecycle stage where ID is included in the given list of values. |
idGreaterThan | Returns any lifecycle stages where ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any lifecycle stages where ID is greater than or equal to the specified value. |
idLessThan | Returns any lifecycle stages where ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any lifecycle stages where ID is less than or equal to the specified value. |
createdAt | Returns any lifecycle stage where CreatedAt is equal to the given datetime value. |
createdAtAfter | Returns any lifecycle stage where CreatedAt is after the given datetime value, non-inclusive. |
createdAtAfterOrEqualTo | Returns any lifecycle stage where CreatedAt is after or equal to the given datetime value. |
createdAtBefore | Returns any lifecycle stage where CreatedAt is before the given datetime value, non-inclusive. |
createdAtBeforeOrEqualTo | Returns any lifecycle stage where CreatedAt is before or equal to the given datetime value. |
updatedAt | Returns any lifecycle stage where UpdatedAt is equal to the given datetime value. |
updatedAtAfter | Returns any lifecycle stage where UpdatedAt is after the given datetime value, non-inclusive. |
updatedAtAfterOrEqualTo | Returns any lifecycle stage where UpdatedAt is after or equal to the given datetime value. |
updatedAtBefore | Returns any lifecycle stage where UpdatedAt is before the given datetime value, non-inclusive. |
updatedAtBeforeOrEqualTo | Returns any lifecycle stage where UpdatedAt is before or equal to the given datetime value. |
Example request:
Example response: