v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Event types

Get all event types

Get a list of all event types.

get/event-types

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

namestring

Search record by name or a part of the name.

text_idstring

You can filter resource results depending on his text ID.

event_group_text_idstring

Select by one value or list of event group text IDs from event-groups resource. The list of values is available at GET /event-groups. In case you want to filter multiple options use array syntax : event_group_text_id[]=shopping&event_group_text_id[]=customers Logic OR is used between values.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "event_types": [
      {
        "event_type_id": "82d0f9d976dee39aac13dc7ea",
        "event_group_id": "8bed991c68a470eaaeffbf048",
        "event_group_text_id": "shopping",
        "name": "Voucher activation",
        "text_id": "voucher_activation",
        "icon_name": "check_box",
        "state": 1
      }
    ],
    "total_items": 1
  }
}