POpolar
event-types
public

List Event Types

List event types with aggregated statistics.

Scopes: events:read events:write

get/v1/event-types/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/event-types/
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: events:read, events:write)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The organization ID.

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

The customer ID.

OR
string[]
string
OR
string[]
querystring nullable

Query to filter event types by name or label.

root_eventsboolean

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

parent_idstring uuid nullable

Filter by specific parent event ID.

source'system' | 'user'

Filter by event source (system or user).

pageinteger

Page number, defaults to 1.

limitinteger

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.

Response

Successful Response

Changes

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