GET /interaction/v1/eventDefinitions
Retrieve a collection of event definitions.
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. |
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.
The response includes an items
array. Each object in this array contains information about event definitions that match the criteria in the query string.