Lifecycle Stage Resources

Lifecycle stages define the steps on a sales journey. In Pardot, we define the following lifecycle stages:

Note: Include the authentication header with every request. For information on how to authenticate, see Authentication.

Resource Name Operation Description
Lifecycle Stage Query GET Request information for the lifecycle stage records that matches the specified criteria.

Lifecycle Stage Query

Request information for the lifecycle stage records that match the specified criteria. You can specify the lifecycle stage records and fields to request. A maximum of 200 records are returned. To return all lifecycle stage records, specify the output as mobile.

URI

/api/lifecycleStage/version/3/do/query?...

Parameters to Select Lifecycle Stage Records

Use these parameters to specify the lifecycle stage records to return. Parameters can be used in any combination and in any order unless otherwise specified.

Notes:

Parameter Type Possible Values Description
id_greater_than integer Any positive integer Request lifecycle stage records that have an ID greater than the specified number.
id_less_than integer Any positive integer Request lifecycle stage records that have an ID less than the specified number.

Parameters to Specify Which Results Are Returned

Use these parameters to specify the lifecycle stage fields to return, and how the lifecycle stage records are sorted.

Parameter Type Possible Values Description
limit integer Any integer from 1 through 200. The number of lifecycle stage records to return. Default value is 200.
offset integer Any positive integer The number of lifecycle stage records to omit from the response (the number to "skip over"). Example: Retrieve a list of lifecycle stage records, omitting the 50 most recently updated records. Sort the query by the position field and use offset=50: /api/lifecycleStage/version/3/do/query?sort_by=position&offset=50
sort_by string position, id The field by which the results are sorted. See Sort Order.
sort_order string ascending, descending The sort order. The default value depends on which sort_by parameter you specify. See Sort Order.

Sort Order

Use sort_by to specify which field Pardot uses to sort the results. Different fields have different default sort orders.

Value Default Sort Order Description
position descending Sort the results by the lifecycle stage records' position.
id ascending Sort the results by the lifecycle stage records' id fields.

XML Response for a Lifecycle Stage Query

<rsp stat="ok" version="1.0">
    <result>
        <total_results>...</total_results>
        <lifecycleStage>...</lifecycleStage>
        <lifecycleStage>...</lifecycleStage>
        <lifecycleStage>...</lifecycleStage>
    </result>
</rsp>
Tag Description
<result> Parent tag. Contains information about the lifecycle stage records that match the parameters specified in your query.
<total_results> Contains the number of lifecycle stage records selected by the query. Note: The query request returns a maximum of 200 forms. If your query matches more than 200 lifecycle stage records, you can make several requests to retrieve all matching records.
<lifecycleStage> The information about a single lifecycle stage. See Lifecycle Stage in Object Field References for a complete description of fields.