Skip to main content
GET
List person steps

Authorizations

Authorization
string
header
required

Path Parameters

person_id
string
required

The Extole unique profile identifier of this user at Extole.

Query Parameters

names
string[]

Optional step name filter. Will include steps that match at least one of the names.

containers
string[]

Optional container filter, defaults to all containers. Will include steps that match at least one of the containers.

campaign_ids
string[]

Optional campaign id filter. Will include steps that match at least one of the campaign ids.

programs
string[]

Optional program label filter. Will include steps that match at least one of the programs.

journey_names
string[]

Optional journey names filter. Will include steps that match at least one of the journey names.

is_primary
boolean

Optional filter for primary steps. Defaults to all steps.

data_keys
string[]

Optional filter for existence of a specific data keys with non-empty values. Will include steps that have at least one of the data keys.

event_ids
string[]

Optional event IDs filter. Will include steps that match at least one of the event IDs.

cause_event_ids
string[]

Optional cause event IDs filter. Will include steps that match at least one of the cause event IDs.

root_event_ids
string[]

Optional root event IDs filter. Will include steps that match at least one of the root event IDs.

offset
integer<int32>
default:0

Optional offset filter, defaults to 0.

limit
integer<int32>
default:20

Optional limit filter, defaults to 20.

journey_key_names
string[]

Optional journey key names filter. Will include steps, whose journey key matches one of the journey key names.

journey_key_values
string[]

Optional journey key values filter. Will include steps that have one of the specified journey keys. Valid format is name:value.

Response

Successful response

campaign_id
string
required

Extole campaign id associated with this step. Absent when no campaign is linked.

cause_event_id
string
required

Id of the direct cause event for this step.

container
string
required

Campaign container the step belongs to.

created_date
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

data
object
required

Named data parameters attached to this step.

event_date
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

event_id
string
required

Extole event id that triggered this step.

id
string
required
read-only

Extole-assigned unique identifier for this step.

is_primary
boolean
required

Whether this is the primary (first qualifying) step for this event type in the journey.

journey_key
object
required
journey_name
string
required

Journey name associated with this step. Absent for global-scope steps.

name
string
required

Name of the event type that created this step (e.g. purchase, signup).

program
string
required

Program key associated with this step. Absent when no program context exists.

quality
enum<string>
required

Quality classification of the step (HIGH, LOW, or NONE).

Available options:
HIGH,
LOW,
NONE
root_event_id
string
required

Id of the root event that initiated the chain leading to this step.

scope
enum<string>
required

Scope of the step (PUBLIC, PRIVATE, or CLIENT).

Available options:
CLIENT,
PRIVATE,
PUBLIC
updated_date
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"