> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getruba.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Event Types
> ### Intent
Reads the available event types as a pageable collection without changing them.
### When to call it
Call this when an interface, sync, or support workflow needs to inspect event types. Use the filters and paging controls shown below to limit the result.
### Access boundary
Authorize the request with a token that carries `events:read` or `events:write`.
### Successful result
A successful request returns `200`. The response schema below defines the body your integration receives.
### Operational notes
List event types with aggregated statistics.
**Scopes**: `events:read` `events:write`
export const RubaSocials = () => {
if (typeof document === "undefined") {
return null;
}
const inject = () => {
const footer = document.getElementById("footer");
if (!footer || document.getElementById("ruba-socials")) {
return false;
}
const isDark = document.querySelector("html.dark") || document.querySelector('html[class*="dark"]');
const lineColor = isDark ? "#383838" : "#e8e8ed";
const iconColor = isDark ? "#8e8e93" : "#86868b";
const markColor = isDark ? "#ffffff" : "#08080c";
const hoverColor = "#0071e3";
const div = document.createElement("div");
div.id = "ruba-socials";
div.style.cssText = `display:flex;align-items:center;gap:20px;padding-top:20px;margin-top:20px;border-top:1px solid ${lineColor};width:100%`;
const logo = `Ruba`;
const spacer = ``;
const ig = ``;
const li = ``;
const github = ``;
div.innerHTML = logo + spacer + ig + li + github;
footer.appendChild(div);
return true;
};
if (!document.documentElement.dataset.rubaSocialsObserver) {
document.documentElement.dataset.rubaSocialsObserver = "true";
const observer = new MutationObserver(() => {
if (!document.getElementById("ruba-socials")) {
inject();
}
});
observer.observe(document.body, {
childList: true,
subtree: true
});
}
setTimeout(() => {
if (!inject()) {
const interval = setInterval(() => {
if (inject()) {
clearInterval(interval);
}
}, 500);
setTimeout(() => clearInterval(interval), 10000);
}
}, 300);
return null;
};
## OpenAPI
````yaml get /v1/event-types/
openapi: 3.1.0
info:
title: Ruba API
summary: Ruba HTTP and Webhooks API
description: Read the docs at https://docs.getruba.com/api-reference
version: 2026-04
servers:
- url: https://api.getruba.com
description: Production environment
x-speakeasy-server-id: production
- url: https://sandbox-api.getruba.com
description: Sandbox environment
x-speakeasy-server-id: sandbox
security: []
tags:
- name: public
description: >-
Endpoints shown and documented in the Ruba API documentation and available
in our SDKs.
paths:
/v1/event-types/:
get:
tags:
- event-types
- public
summary: List Event Types
description: >-
### Intent
Reads the available event types as a pageable collection without
changing them.
### When to call it
Call this when an interface, sync, or support workflow needs to inspect
event types. Use the filters and paging controls shown below to limit
the result.
### Access boundary
Authorize the request with a token that carries `events:read` or
`events:write`.
### Successful result
A successful request returns `200`. The response schema below defines
the body your integration receives.
### Operational notes
List event types with aggregated statistics.
**Scopes**: `events:read` `events:write`
operationId: event-types:list
parameters:
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid4
description: The organization ID.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
- type: array
items:
type: string
format: uuid4
description: The organization ID.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
- type: 'null'
title: OrganizationID Filter
description: Filter by organization ID.
description: Filter by organization ID.
- name: customer_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid4
description: The customer ID.
- type: array
items:
type: string
format: uuid4
description: The customer ID.
- type: 'null'
title: CustomerID Filter
description: Filter by customer ID.
description: Filter by customer ID.
- name: external_customer_id
in: query
required: false
schema:
anyOf:
- type: string
- items:
type: string
type: array
- type: 'null'
title: ExternalCustomerID Filter
description: Filter by external customer ID.
description: Filter by external customer ID.
- name: query
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Query
description: Query to filter event types by name or label.
description: Query to filter event types by name or label.
- name: root_events
in: query
required: false
schema:
type: boolean
title: Root Events Filter
description: >-
When true, only return event types with root events (parent_id IS
NULL).
default: false
description: >-
When true, only return event types with root events (parent_id IS
NULL).
- name: parent_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: ParentID Filter
description: Filter by specific parent event ID.
description: Filter by specific parent event ID.
- name: source
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/EventSource'
- type: 'null'
title: EventSource Filter
description: Filter by event source (system or user).
description: Filter by event source (system or user).
- name: page
in: query
required: false
schema:
type: integer
exclusiveMinimum: 0
description: Page number, defaults to 1.
default: 1
title: Page
description: Page number, defaults to 1.
- name: limit
in: query
required: false
schema:
type: integer
exclusiveMinimum: 0
description: Size of a page, defaults to 10. Maximum is 100.
default: 10
title: Limit
description: Size of a page, defaults to 10. Maximum is 100.
- name: sorting
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/EventTypesSortProperty'
- type: 'null'
description: >-
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.
default:
- '-last_seen'
title: Sorting
description: >-
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.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListResource_EventTypeWithStats_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- oidc:
- events:read
- events:write
- pat:
- events:read
- events:write
- oat:
- events:read
- events:write
components:
schemas:
EventSource:
type: string
enum:
- system
- user
title: EventSource
EventTypesSortProperty:
type: string
enum:
- name
- '-name'
- label
- '-label'
- occurrences
- '-occurrences'
- first_seen
- '-first_seen'
- last_seen
- '-last_seen'
title: EventTypesSortProperty
ListResource_EventTypeWithStats_:
properties:
items:
items:
$ref: '#/components/schemas/EventTypeWithStats'
type: array
title: Items
pagination:
$ref: '#/components/schemas/Pagination'
type: object
required:
- items
- pagination
title: ListResource[EventTypeWithStats]
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
EventTypeWithStats:
properties:
id:
anyOf:
- type: string
format: uuid4
- type: 'null'
title: Id
description: The ID of the event type. Null for system event types.
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Creation timestamp of the event type. Null for system event types.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: >-
Last modification timestamp of the event type. Null for system event
types.
name:
type: string
title: Name
description: The name of the event type.
label:
type: string
title: Label
description: The label for the event type.
label_property_selector:
anyOf:
- type: string
- type: 'null'
title: Label Property Selector
description: Property path to extract dynamic label from event metadata.
organization_id:
type: string
format: uuid4
title: Organization Id
description: The ID of the organization owning the event type.
source:
$ref: '#/components/schemas/EventSource'
description: The source of the events (system or user).
occurrences:
type: integer
title: Occurrences
description: Number of times the event has occurred.
first_seen:
type: string
format: date-time
title: First Seen
description: The first time the event occurred.
last_seen:
type: string
format: date-time
title: Last Seen
description: The last time the event occurred.
type: object
required:
- name
- label
- organization_id
- source
- occurrences
- first_seen
- last_seen
title: EventTypeWithStats
Pagination:
properties:
total_count:
type: integer
title: Total Count
max_page:
type: integer
title: Max Page
type: object
required:
- total_count
- max_page
title: Pagination
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
oidc:
type: openIdConnect
openIdConnectUrl: /.well-known/openid-configuration
pat:
type: http
description: >-
You can generate a **Personal Access Token** from your
[settings](https://getruba.com/settings).
scheme: bearer
oat:
type: http
description: >-
You can generate an **Organization Access Token** from your
organization's settings.
scheme: bearer
````