Skip to main content
GET
List event definitions

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

behavioral_events.event_definitions.read_write

Query Parameters

after
string

A cursor token for pagination. Use the value from the previous response's paging.next.after field to retrieve the next set of results.

includeProperties
boolean

A boolean indicating whether to include event properties in the response.

limit
integer<int32>

The maximum number of results to return per page.

searchString
string

A string to filter event definitions by name or description.

sortOrder
string

The order in which to sort the results. Accepts values like 'asc' or 'desc'.

Response

successful operation

results
object[]
required

An array containing the external behavioral event type definitions returned in the current page.

total
integer<int32>
required

The total number of external behavioral event type definitions available.

paging
object

Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.

Last modified on November 16, 2026