Query events metadata

Returns event metadata entries for the given category, optionally filtered by event names and/or origins.

Supported categories: automations, segments

Event name filtering: When events are provided, only events whose system name matches one of the given values are returned (exact, case-sensitive match).

Origin filtering: By default the response includes Omnisend events together with events from every origin the brand has data for. When the brand is connected to a specific origin, that origin's events are included as well. The optional origins filter narrows the response to the requested origins (OR-combined) within what the brand can already see; an origin the brand is not entitled to is never returned, even if requested.

Property inclusion: When includeProperties is true, each event item includes the flat dot-path property list. When omitted or false, only event-level metadata (name, displayName, origins) is returned.

Custom event exclusion: When excludeCustomEvents is true, brand-custom events are omitted. When omitted or false, custom events are included. Set this to true when only well-known standard events are needed, for a more predictable response size.

Body Params

Query parameters

Request body for the POST /event-metadata query endpoint.

string
required

Event category (e.g. automations, segments)

events
array of strings

Optional list of event names to filter by

events
boolean

When true, brand-custom events are omitted. When false or omitted, custom events are included. Set this to true when only well-known events are needed, for a more predictable response size.

boolean

When true, response items include the full flat property list. When false or omitted, only event-level metadata is returned.

origins
array of strings

Optional list of origins to filter by (OR-combined)

origins
Headers
string
required
Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json