List the event catalogueMenu

List the event catalogue

GET/v1/events/catalog

Requires an API key with the events:read scope. About keys and scopes

Works with integration, agent and partner keys. Also available to embed sessions.

The workspace's event names, for the data index and for trigger, rule and goal pickers: Kirora's system names, each name the workspace has sent, and each one a person defined before sending it. Each has its origin (system, standard or custom), whether it has events (recorded), its description, when it was last seen, its last 30 days and how many journeys, segments, campaigns and goals read it. The figures are counted at most 15 minutes before meta.countedAt; a name sent for the first time is listed at once. query, origin and recorded filter, and sort orders, across every page. Standard names not yet sent are in GET /events/standard-names. Only the first page has meta.nameUsage: the names counted against the workspace's limit of 1,000, defined ones included; past it a new name is refused with EVENT_NAME_LIMIT_REACHED.

Query parameters

limitintegeroptional

How many items a page holds: 1 to 100, 20 by default.

min > 0 · max 100 · default 20

cursorstringoptional

Where the page starts: the previous page's meta.pagination.nextCursor. Omit it for the first page, and send the same filters with it.

1–2,048 characters

querystringoptional

Only names containing this, ignoring case.

1–128 characters

originstringoptional

Only names of this origin.

one of system, standard, custom

recordedstringoptional

true: only names with events; false: only names without, such as one defined before it was sent.

one of true, false

sortstringoptional

A field ascending, or -field descending; ties go by name. A name with no events sorts last by lastSeenAt either way.

one of -lastSeenAt, lastSeenAt, -last30DaysCount, last30DaysCount, name, -name · default "-lastSeenAt"

Header parameters

Kirora-Workspacestringoptional

Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.

pattern ^[A-Za-z0-9._:-]{1,128}$

Returns

Returns 200 OK with a list of EventName objects in data, and the next page's cursor in meta (see pagination). Otherwise returns an error; Errors lists every code and which to retry.

namestringrequired

originstringrequired

one of system, standard, custom

recordedbooleanrequired

Whether the workspace has events of it. False for a name defined before it was sent, and for a system name Kirora has not recorded yet.

descriptionstring | nullrequired

The workspace's description, else Kirora's meaning for a system or standard name; null when neither. Plain text.

lastSeenAtstring | nullrequired

When its latest event happened; null when it has none.

date-time

last30DaysCountintegerrequired

Events of it that happened in the last 30 days.

min 0

usedByCountintegerrequired

Journeys, segments, campaigns, conversion goals and active workspace goals that read it; the summary names them.

min 0

curl https://api.kirora.io/v1/events/catalog \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/events/catalog', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
if (!response.ok) throw new Error(`Kirora API ${response.status}: ${await response.text()}`);
const { data, meta } = await response.json();
// meta.pagination.nextCursor is the next page's `cursor`, and null on the last page.

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/events/catalog",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
response.raise_for_status()
body = response.json()
data = body["data"]
next_cursor = body["meta"]["pagination"]["nextCursor"]
# next_cursor is the next page's `cursor`, and None on the last page.

package main

import (
	"encoding/json"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/events/catalog", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	if res.StatusCode >= 300 {
		msg, _ := io.ReadAll(res.Body)
		panic(fmt.Sprintf("Kirora API %d: %s", res.StatusCode, msg))
	}

	var out struct {
		Data json.RawMessage `json:"data"`
		Meta struct {
			Pagination struct {
				NextCursor *string `json:"nextCursor"`
			} `json:"pagination"`
		} `json:"meta"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
	// out.Meta.Pagination.NextCursor is the next page's `cursor`, and nil on the last page.
}

using System.Net.Http.Headers;
using System.Text.Json;

using var http = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.kirora.io/v1/events/catalog");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("KIRORA_API_KEY"));

using var response = await http.SendAsync(request);
if (!response.IsSuccessStatusCode)
    throw new HttpRequestException($"Kirora API {(int)response.StatusCode}: {await response.Content.ReadAsStringAsync()}");

using var document = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
var data = document.RootElement.GetProperty("data");
var nextCursor = document.RootElement.GetProperty("meta").GetProperty("pagination").GetProperty("nextCursor");
// nextCursor is the next page's `cursor`, and null on the last page.

Response · 200

{
  "data": [
    {
      "name": "Order Completed",
      "origin": "standard",
      "recorded": true,
      "description": "A contact paid for an order: order_id, total, currency, products[].",
      "lastSeenAt": "2026-10-25T18:42:07.000Z",
      "last30DaysCount": 412,
      "usedByCount": 3
    },
    {
      "name": "Webinar Registered",
      "origin": "custom",
      "recorded": true,
      "description": "A contact signed up for a live webinar.",
      "lastSeenAt": "2026-10-24T09:15:00.000Z",
      "last30DaysCount": 58,
      "usedByCount": 1
    },
    {
      "name": "Plan Upgraded",
      "origin": "custom",
      "recorded": false,
      "description": "A contact moved to a paid plan. Defined ahead of the app sending it.",
      "lastSeenAt": null,
      "last30DaysCount": 0,
      "usedByCount": 1
    }
  ],
  "meta": {
    "pagination": {
      "limit": 3,
      "nextCursor": "eyJsYXN0U2VlbkF0IjpudWxsLCJsYXN0MzBEYXlzQ291bnQiOjAsIm5hbWUiOiJQbGFuIFVwZ3JhZGVkIn0"
    },
    "countedAt": "2026-10-26T08:00:00.000Z",
    "nameUsage": {
      "count": 37,
      "limit": 1000
    }
  }
}