GET /interaction/v1/interactions

Overview

Retrieves a collection of all journeys. The journey collection resources are embedded in the items property of the response body. Use both a sort order and paging to minimize the response size and response time. To call this resource, assign your API Integration the Automation | Interactions | Read scope.

URL Parameters

NameTypeDescription
statusstringA status description upon which to filter journeys. Can be one of: Draft, Published, ScheduledToPublish, Stopped, Unpublished, Deleted. The default value is blank, which returns all statuses. ScheduledToSend, Sent, and Stopped are unique to single-send journeys. A single send journey can be 'Cancelled' via the UI, but the API status for this is 'Stopped.'
versionNumbernumberVersion number of the journey to retrieve. The default value is published version or latest available version number which meets other search criteria.
specificApiVersionNumbernumberVersion number of the workflowApiVersion upon which to filter journeys. The default value is 1.
mostRecentVersionOnlybooleanA flag to indicate whether to fetch only the most recent version of matching journeys. The default value is true.
definitionTypeenumType of definition to retrieve. Valid values include: transactional (retrieves all transactional send definitions).
nameOrDescriptionstringA search string inside the journey's name or description properties upon which to match for filtering.
extrasstringA list of additional data to fetch. Available values are: all, activities, outcome and stats. The default value is blank, which returns all extras.
$orderBystringSpecify how to order the journeys. Valid ordering columns are: ModifiedDate (default), Name, Performance. Valid values are: DESC, ASC. The default value is 'ModifiedDate DESC'.
tagstringSpecify a single tag to filter results to only include journeys associated with that tag.
$pagenumberThe number of pages to retrieve. The default value is 1.
$pageSizenumberThe number of results to return on a page. The default and maximum is 50.

JSON Parameters

NameTypeDescription
keystringThe user-defined key for a specific journey to retrieve
idstringThe GUID (UUID) for a specific journey to retrieve. The ID returns all versions of that journey.

Usage

**Example Request 1**

The following request retrieves all journeys and includes activities "extras" (up to 50 per page).

Example Response 1

Example Request 2

The following request retrieves all journeys and includes outcome "extras" (up to 50 per page).

Example Response 2