GET /interaction/v1/eventDefinitions

Retrieve a collection of event definitions.

URL Parameters

Name	Type	Description
`$page`	Number	The page number of results to retrieve. The default value is 1.
`$pageSize`	Number	The number of results to return on a page. The default and maximum is 50. This value is only honored if the query string also specifies the `$page` parameter.
`name`	String	Filter results by the name of the event definition. The API searches the entire name of the event definition for the value that you specify here.

Usage

To retrieve event definitions, issue a GET request to the /interaction/v1/eventDefinitions endpoint. You can optionally filter and paginate the results by using query string parameters.

1GET /interaction/v1/eventDefinitions?$pageSize=2&$page=2&name=welcome HTTP/1.1
2Host: YOUR_DOMAIN.rest.marketingcloudapis.com
3Authorization: Bearer YOUR_BEARER_TOKEN
4Content-Type: application/json

The response includes an items array. Each object in this array contains information about event definitions that match the criteria in the query string.

1{
2  "count": 4,
3  "page": 2,
4  "pageSize": 1,
5  "links": {},
6  "items": [
7    {
8      "id": "858f98c7-7d0c-4c42-95ee-a142852e96c9",
9      "type": "DateEvent",
10      "name": "Welcome Series",
11      "description": "Welcome Series",
12      "createdDate": "2025-06-12T12:33:41.82",
13      "createdBy": 998877665,
14      "modifiedDate": "2025-06-12T12:55:34.033",
15      "modifiedBy": 998877665,
16      "mode": "Production",
17      "eventDefinitionKey": "DateEvent",
18      "dataExtensionId": "a94b1dd1-b5c3-e211-abdb-1cc1de75f674",
19      "dataExtensionName": "_PushAddress",
20      "sourceApplicationExtensionId": "1169744d-c5c2-4ebd-869a-7f897db61112",
21      "filterDefinitionId": "00000000-0000-0000-0000-000000000000",
22      "filterDefinitionTemplate": "",
23      "iconUrl": "/events/images/icon_journeyBuilder-event-DateBased-blue.svg",
24      "arguments": {
25        "serializedObjectType": 1,
26        "contactAttributeGroup": "PushDemographics",
27        "contactAttributeName": "CreatedDate",
28        "dataExtensionId": "a94b1dd1-b5c3-e211-abdb-1cc1de75f674",
29        "eid": 987654,
30        "mid": 987654,
31        "eventDefinitionId": "858f98c7-7d0c-4c42-95ee-a142852e96c9",
32        "eventDefinitionKey": "DateEvent",
33        "criteria": "",
34        "useHighWatermark": false,
35        "contactAttributeId": "18f35cd5-f1c1-e311-a1e0-e83935a85380",
36        "dateType": "yearly",
37        "dateOffset": 0,
38        "dateOffsetUnit": "days",
39        "automationId": "845441e4-ac9f-4400-9ba6-c1a6ede6ff59"
40      },
41      "metaData": {
42        "criteriaDescription": "",
43        "attributeName": "Created Date",
44        "customAttributeName": "Created Date",
45        "formattedDate": "on Created Date",
46        "formattedTime": "12:00 AM",
47        "timeZone": "(GMT-06:00) Central Time (US & Canada)",
48        "automationData": {
49          "id": "NUVGVWhKLXNBRVNicHNHbTdlYl9XUToyNTow",
50          "key": "07b9ab2e-1f24-4ddd-aee3-93705737304b",
51          "createdDate": "2025-06-12T18:33:43Z",
52          "updateInProgress": false,
53          "name": "JB Event Welcome Series",
54          "description": "Event Definition Automation",
55          "createdBy": {
56            "id": "MTA5NzcxNjU6NDow",
57            "name": "D'Angelo Cunningham",
58            "email": "dcunningham@example.com"
59          },
60          "modifiedDate": "2025-06-12T18:33:52Z",
61          "status": "Scheduled",
62          "memberId": 987654,
63          "processes": [
64            {
65              "id": "UDJjRURNY3BZRUMySXhWekpUb1JXUToyNzow",
66              "name": "",
67              "description": "",
68              "sequence": 0,
69              "workers": [
70                {
71                  "id": "Vkd5MWdEaDRSa0tFTUhuc0pDakpaUToyOTow",
72                  "key": "faf2d852-4ad6-467d-a002-8837092794d5",
73                  "sequence": 0,
74                  "name": "InteractionStudio",
75                  "description": "",
76                  "activityObjectId": "858f98c7-7d0c-4c42-95ee-a142852e96c9",
77                  "objectTypeId": 733,
78                  "serializedObject": "{\"SerializedObjectType\":1,\"criteria\":null,\"useHighWatermark\":false,\"contactAttributeId\":\"18f35cd5-f1c1-e311-a1e0-e83935a85380\",\"dateType\":\"yearly\",\"dateOffset\":0,\"dateOffsetUnit\":\"days\",\"ContactAttributeGroup\":\"PushDemographics\",\"ContactAttributeName\":\"CreatedDate\",\"DataExtensionId\":\"a94b1dd1-b5c3-e211-abdb-1cc1de75f674\",\"Eid\":987654,\"Mid\":987654,\"EventDefinitionId\":\"858f98c7-7d0c-4c42-95ee-a142852e96c9\",\"EventDefinitionKey\":\"DateEvent\"}",
79                  "selectedObject": [
80                    {
81                      "categoryId": -1
82                    }
83                  ],
84                  "guidId": "80b56c54-7838-4246-8430-79ec2428c965"
85                }
86              ],
87              "guidId": "0c04673f-29c7-4060-b623-1573253a1159"
88            }
89          ],
90          "scheduledTime": "2025-06-13T05:00:00Z",
91          "schedule": "http://rest.s1.exacttarget.com/rest//beta/automations/schedule/R19KM1hjUWhMVUN2WjcybEhOdkNXQTozNjow",
92          "isPlatformObject": true,
93          "notifications": "http://rest.s1.exacttarget.com/rest//beta/hub/notifications/NUVGVWhKLXNBRVNicHNHbTdlYl9XUToxMjow",
94          "automationType": "scheduled",
95          "categoryId": 1157180,
96          "folderPath": "my automations",
97          "lastSaveDate": "2025-06-12T18:33:43Z",
98          "lastSavedBy": {
99            "id": "MTA5NzcxNjU6NDow",
100            "name": "D'Angelo Cunningham",
101            "email": "dcunningham@example.com"
102          },
103          "selectedCategoryId": [
104            {
105              "categoryId": 11335577
106            }
107          ],
108          "scheduleObject": {
109            "id": "R19KM1hjUWhMVUN2WjcybEhOdkNXQTozNjow",
110            "key": "7d13dd40-2be0-4dfe-a3aa-9ef66e100d78",
111            "createdDate": "2025-06-12T18:34:00Z",
112            "createdBy": "http://rest.s1.exacttarget.com/rest//beta/organization/user/MTA5NzcxNjU6NDow",
113            "lastUpdated": "2025-06-12T18:34:00Z",
114            "lastUpdatedBy": "http://rest.s1.exacttarget.com/rest//beta/organization/user/MTA5NzcxNjU6NDow",
115            "name": "",
116            "description": "Will run every day, effective 6/13/2025 at 12:00 AM through Monday, June 13, 2027",
117            "startDate": "2025-06-13T06:00:00Z",
118            "iCalRecur": "FREQ=DAILY;UNTIL=20270613T050000;INTERVAL=1",
119            "timeZone": "Central Standard Time",
120            "timeZoneId": 79,
121            "scheduleStatus": "active"
122          },
123          "guidId": "845441e4-ac9f-4400-9ba6-c1a6ede6ff59"
124        }
125      },
126      "schedule": {
127        "startDateTime": "2025-06-13T00:00:00",
128        "endDateTime": "2027-06-13T05:00:00",
129        "timeZone": "Central Standard Time",
130        "occurrences": 18263,
131        "endType": "EndDate",
132        "frequency": "Daily",
133        "recurrencePattern": "Interval",
134        "interval": 1
135      },
136      "interactionCount": 0,
137      "isVisibleInPicker": true,
138      "isPlatformObject": false,
139      "category": "Event",
140      "publishedInteractionCount": 0,
141      "automationId": "5860e177-b030-4674-9084-3de5444ff839",
142      "disableDEDataLogging": false
143    }
144  ]
145}

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