GET /interaction/v1/interactions

Retrieve a list of journeys.

Required Permission Scope

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

URL Parameters

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

Name	Type	Description
`$orderBy`	String	The 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`.
`$page`	Number	The page number of results to retrieve. The default value is `1`.
`$pageSize`	Number	The number of items to return on a page of results. The default and maximum value is `50`.
`definitionType`	String	The type of definition to retrieve. The only accepted value is `transactional`, which retrieves all transactional send definitions.
`extras`	String	Additional 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.
`key`	String	The external key of a journey to retrieve.
`id`	String	The ID of a journey to retrieve. When you specify an ID, the API returns all versions of that journey.
`mostRecentVersionOnly`	Boolean	Use this parameter to specify whether to return the most recent version of each journey that matches the filter criteria. The default value is `true`.
`nameOrDescription`	String	A 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.
`specificApiVersionNumber`	Number	The version number of the `workflowApiVersion` value to retrieve. The default value is `1`.
`status`	String	A journey status value to use to filter the results. Possible values are: `Deleted` `Draft` `Paused` `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.
`tag`	String	A tag to use to filter the results. When you specify this parameter, the API returns only journeys with the specified tag.
`versionNumber`	Number	The 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.

Example Request

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

1Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
2GET /interaction/v1/interactions?$page=2&$pageSize=2&extras=activities
3Content-Type: application/json
4Authorization: Bearer YOUR_ACCESS_TOKEN

Example Response

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

1{
2  "count": 1,
3  "page": 1,
4  "pageSize": 50,
5  "links": {},
6  "items": [
7    {
8      "id": "40308698-7581-4b2a-855b-0f8231c6478e",
9      "key": "2c25c791-4e6e-4e7e-844e-ed098fc3a8ba",
10      "name": "5 Day Follow-Up",
11      "lastPublishedDate": "0001-01-01T00:00:00",
12      "description": "",
13      "version": 1,
14      "workflowApiVersion": 1,
15      "createdDate": "2024-08-17T10:21:38.98",
16      "modifiedDate": "2024-08-17T10:22:22.01",
17      "activities": [
18        {
19          "id": "cc1996c1-473d-4bcd-9ea7-27ad8adcd11f",
20          "key": "WAIT-2",
21          "name": "",
22          "description": "",
23          "type": "WAIT",
24          "arguments": {},
25          "configurationArguments": {
26            "waitDuration": 1,
27            "waitUnit": "DAYS"
28          },
29          "metaData": {
30            "waitType": "duration"
31          },
32          "schema": {
33            "arguments": {
34              "endDate": {
35                "dataType": "Date",
36                "isNullable": false,
37                "direction": "Out",
38                "readOnly": false,
39                "access": "Hidden"
40              },
41              "waitDefinitionId": {
42                "dataType": "Text",
43                "isNullable": false,
44                "direction": "In",
45                "readOnly": false,
46                "access": "Hidden"
47              },
48              "waitForEventId": {
49                "dataType": "Text",
50                "isNullable": true,
51                "direction": "In",
52                "readOnly": false,
53                "access": "Hidden"
54              },
55              "executionMode": {
56                "dataType": "Text",
57                "isNullable": false,
58                "direction": "In",
59                "readOnly": false,
60                "access": "Hidden"
61              },
62              "startActivityKey": {
63                "dataType": "Text",
64                "isNullable": true,
65                "direction": "In",
66                "readOnly": false,
67                "access": "Hidden"
68              },
69              "waitQueueId": {
70                "dataType": "LongNumber",
71                "isNullable": true,
72                "direction": "In",
73                "readOnly": false,
74                "access": "Hidden"
75              }
76            }
77          }
78        },
79        {
80          "id": "394097d6-c3a3-4820-b9e3-8788b548da80",
81          "key": "EMAILV2-1",
82          "name": "",
83          "description": "",
84          "type": "EMAILV2",
85          "arguments": {},
86          "configurationArguments": {},
87          "metaData": {},
88          "schema": {
89            "arguments": {
90              "emailSubjectDataBound": {
91                "dataType": "Text",
92                "isNullable": true,
93                "direction": "In",
94                "readOnly": true,
95                "access": "Hidden"
96              },
97              "contactId": {
98                "dataType": "Number",
99                "isNullable": true,
100                "direction": "In",
101                "readOnly": false,
102                "access": "Hidden"
103              },
104              "contactKey": {
105                "dataType": "Text",
106                "isNullable": false,
107                "direction": "In",
108                "readOnly": false,
109                "access": "Hidden"
110              },
111              "emailAddress": {
112                "dataType": "Text",
113                "isNullable": false,
114                "direction": "In",
115                "readOnly": false,
116                "access": "Hidden"
117              },
118              "sourceCustomObjectId": {
119                "dataType": "Text",
120                "isNullable": true,
121                "direction": "In",
122                "readOnly": false,
123                "access": "Hidden"
124              },
125              "sourceCustomObjectKey": {
126                "dataType": "LongNumber",
127                "isNullable": true,
128                "direction": "In",
129                "readOnly": false,
130                "access": "Hidden"
131              },
132              "fieldType": {
133                "dataType": "Text",
134                "isNullable": true,
135                "direction": "In",
136                "readOnly": false,
137                "access": "Hidden"
138              },
139              "eventData": {
140                "dataType": "Text",
141                "isNullable": true,
142                "direction": "In",
143                "readOnly": false,
144                "access": "Hidden"
145              },
146              "customObjectKey": {
147                "dataType": "LongNumber",
148                "isNullable": true,
149                "direction": "In",
150                "readOnly": true,
151                "access": "Hidden"
152              }
153            }
154          }
155        }
156      ],
157      "triggers": [],
158      "goals": [],
159      "tags": [{ "name": "Fun Run" }, { "name": "5K" }],
160      "stats": {
161        "currentPopulation": 0,
162        "cumulativePopulation": 0,
163        "metGoal": 0,
164        "goalPerformance": 0
165      },
166      "entryMode": "SingleEntryAcrossAllVersions",
167      "defaults": {
168        "email": [""]
169      },
170      "executionMode": "Production",
171      "status": "Draft",
172      "definitionId": "e6c045e9-ecf6-4336-8e64-d691974e9908"
173    }
174  ]
175}

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!