GET /interaction/v1/interactions/{id}

Overview

Retrieves a single journey by ID or key. To call this resource, assign your API Integration the Automation | Interactions | Read scope.

URL Parameters

NameTypeDescription
idstringRequiredID of version 1 of the journey in the form of a GUID (UUID). Required if not using a key.
keystringRequiredThe key of the journey. Required if not using ID. Prefix the parameter with key:. For example, /interactions/key:{key}.
versionNumbernumberVersion number of the journey to retrieve. If not provided, version 1 is returned.
extrasstringA list of additional data to fetch. Available values are: all, activities, outcomes and stats. Default is ''.

Usage

Example Request

This request retrieves a single journey object for version 2 of the journey specified by the ID.

Example Response