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.

Supported Operations

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

Fields

Read-Only Fields

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

Lifecycle Stage Read

Retrieve a single lifecycle stage following the conventions described in the Version 5 Overview.

Example request:

GET /api/v5/objects/lifecycle-stages/10003?fields=id,name,position,createdAt,updatedAt
Host: pi.pardot.com
Authorization: Bearer <access-token>

Example response:

HTTP/1.1 200 OK
{
    "id": 10003,
    "createdAt": "2021-05-20T11:13:41-07:00",
    "name": "Prospects",
    "position": 0,
    "updatedAt": "2021-05-20T11:13:41-07:00"
}

Lifecycle Stage Query

Retrieving a collection of lifecycle stages follows the conventions described in Version 5 Overview.

Sortable Fields

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.

id
createdAt
updatedAt

Example request:

GET /api/v5/objects/lifecycle-stages?fields=id,matchType,isLocked,name,position,createdAt,updatedAt,isDeleted&orderBy=id HTTP/1.1
Host: pi.pardot.com
Authorization: Bearer <access-token>

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
   "values": [
        {
            "id": 10001,
            "createdAt": "2021-05-20T11:13:41-07:00",
            "isDeleted": false,
            "isLocked": true,
            "matchType": "match all",
            "name": "Prospects",
            "position": 0,
            "updatedAt": "2021-05-20T11:13:41-07:00"
        },
        {
            "id": 10002,
            "createdAt": "2021-05-20T11:13:41-07:00",
            "isDeleted": false,
            "isLocked": true,
            "matchType": "match all",
            "name": "Opportunities Won",
            "position": 3,
            "updatedAt": "2021-05-20T11:13:41-07:00"
        },
        {
            "id": 10003,
            "createdAt": "2021-05-20T11:13:41-07:00",
            "isDeleted": false,
            "isLocked": true,
            "matchType": "match all",
            "name": "Opportunities Lost",
            "position": 4,
            "updatedAt": "2021-05-20T11:13:41-07:00"
        }
    ]
}

Filtering Results

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:

GET /api/v5/objects/lifecycle-stages?fields=id,matchType,isLocked,name,position,createdAt,updatedAt,isDeleted&orderBy=id&idGreaterThan=10002
Host: pi.pardot.com
Authorization: Bearer <access-token>

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "values": [
        {
            "id": 10003,
            "createdAt": "2021-05-20T11:13:41-07:00",
            "isDeleted": false,
            "isLocked": true,
            "matchType": "match all",
            "name": "Prospects",
            "position": 0,
            "updatedAt": "2021-05-20T11:13:41-07:00"
        }
    ]
}

Lifecycle Stage Object

Supported Operations

Fields

Read-Only Fields

Lifecycle Stage Read

Lifecycle Stage Query

Sortable Fields

Filtering Results

No Results