GET /interaction/v1/interactions

Retrieve a list of journeys.

To use this endpoint to search for journeys, you must have the Automation | Journeys | Read scope.

This table lists the URL parameters that you can specify to filter or enhance the search results.

NameTypeDescription
$orderByStringThe field and sort method to use to sort the results. You can sort on these fields:
  • ModifiedDate
  • Name
  • Performance
You can sort these fields in ascending (ASC) or descending (DESC) order. The default value is modifiedDate DESC.
$pageNumberThe page number of results to retrieve. The default value is 1.
$pageSizeNumberThe number of items to return on a page of results. The default and maximum value is 50.
definitionTypeStringThe type of definition to retrieve. The only accepted value is transactional, which retrieves all transactional send definitions.
extrasStringAdditional information to include in the response. Possible values are:
  • activities: Provides configuration details for each activity in the journey.
  • outcome: Provides detailed information about the outcomes of the goals in the journey.
  • stats: Provides detailed statistics related to the population of the journey.
  • all: Provides all the extra details that are available.
When you specify the all value for this parameter, the response includes a large amount of data. The volume of this data has a negative impact on the performance of this query.
keyStringThe external key of a journey to retrieve.
idStringThe ID of a journey to retrieve. When you specify an ID, the API returns all versions of that journey.
mostRecentVersionOnlyBooleanUse this parameter to specify whether to return the most recent version of each journey that matches the filter criteria. The default value is true.
nameOrDescriptionStringA search string to apply to the request. The API searches the name and description of each journey for this string, and returns all matching journeys.
specificApiVersionNumberNumberThe version number of the workflowApiVersion value to retrieve. The default value is 1.
statusStringA journey status value to use to filter the results. Possible values are:
  • Deleted
  • Draft
  • Published
  • ScheduledToPublish
  • Stopped
  • Unpublished
The ScheduledToSend, Sent, and Stopped statuses exist only in single-send journeys.
If you don't specify a status value, the API returns all journeys regardless of their statuses.
tagStringA tag to use to filter the results. When you specify this parameter, the API returns only journeys with the specified tag.
versionNumberNumberThe version number of the journey to retrieve. The default value is the currently published version or the latest version number that meets the other search criteria.

This sample request retrieves all journeys. The request uses the extras parameter to retrieve the activities for each journey.

A successful request returns a 200 OK response that contains data about the journeys that match the search criteria.