Sign in

v7

latestOpenAPI 3.1.02026-08-051856761.1 MB
event-types
public

List Event Types

List event types with aggregated statistics.

Scopes: events:read events:write

get/v1/event-types/

Query parameters

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

string uuid4

The customer ID.

OR
string[]

Filter by customer ID.

string
OR
string[]

Filter by external customer ID.

querystring nullable

Query to filter event types by name or label.

Query to filter event types by name or label.

root_eventsboolean

When true, only return event types with root events (parent_id IS NULL).

When true, only return event types with root events (parent_id IS NULL).

parent_idstring uuid nullable

Filter by specific parent event ID.

Filter by specific parent event ID.

source'system' | 'user'

Filter by event source (system or user).

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Size of a page, defaults to 10. Maximum is 100.

sortingEventTypesSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Response

Successful Response