v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Persons

List person journeys

Returns campaign journeys for the specified person, sorted by start date in descending order. A journey represents a person's participation lifecycle in a specific campaign (e.g. share, refer-a-friend, purchase).

get/v5/persons/{person_id}/journeys

Path parameters

person_idstring required

The Extole unique profile identifier of this user at Extole.

Query parameters

idsstring[]

namesstring[]

programsstring[]

campaign_idsstring[]

containersstring[]

data_keysstring[]

data_valuesstring[]

offsetinteger

limitinteger

key_namesstring[]

key_valuesstring[]

Response

Successful response

campaign_idstring required

Extole campaign id associated with this journey.

containerstring required

Campaign container the journey belongs to.

created_datestring 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.

dataobject required

Named data parameters attached to this journey entry.

idstring required

Extole-assigned unique identifier for this journey entry.

namestring required

Name of the journey (program step) the person is on.

programstring required

Program key associated with this journey.

updated_datestring 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.

Example response

[
  {
    "created_date": "2025-10-24T02:00:00-07:00",
    "updated_date": "2025-10-24T02:00:00-07:00"
  }
]