TAtalon
Events

List event types

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Fetch all event type definitions for your account.

get/v1/event_types

Request

Query parameters

namestring

Filter results to event types with the given name. This parameter implies includeOldVersions.

includeOldVersionsboolean

Include all versions of every event type.

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Response

OK

totalResultSizeinteger required

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "title": "Survey Completed",
      "name": "surveyCompleted",
      "description": "The survey was submitted by the customer."
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.