List a message's events

GET/api/v2/messages/:id/events

Every open, click and reply, oldest first.

Needs an API key with the read or send scope. Scopes

Parameters

Path

idstringrequired

The message id.

Notes

kind is open, click or reply; a click also has the url.
prefetch: true marks an open that looks like automatic image fetching by a mail provider; those are not counted in open_count.

curl -X GET "https://api.koltrix.com/api/v2/messages/6f1c2a9e-3b7d-4e41-9a52-0c8d1f3e7b20/events" \
  -H "Authorization: Bearer $KOLTRIX_API_KEY"

const res = await fetch("https://api.koltrix.com/api/v2/messages/6f1c2a9e-3b7d-4e41-9a52-0c8d1f3e7b20/events", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.KOLTRIX_API_KEY}`,
  },
});

console.log(res.status, await res.json());

import os, requests

res = requests.get(
    "https://api.koltrix.com/api/v2/messages/6f1c2a9e-3b7d-4e41-9a52-0c8d1f3e7b20/events",
    headers={
        "Authorization": f"Bearer {os.environ['KOLTRIX_API_KEY']}",
    },
)
print(res.status_code, res.json())

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.koltrix.com/api/v2/messages/6f1c2a9e-3b7d-4e41-9a52-0c8d1f3e7b20/events", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KOLTRIX_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

<?php

$ch = curl_init("https://api.koltrix.com/api/v2/messages/6f1c2a9e-3b7d-4e41-9a52-0c8d1f3e7b20/events");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("KOLTRIX_API_KEY"),
    ],
]);

$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response;

Success.

{
  "data": [
    {
      "kind": "open",
      "prefetch": true,
      "ip": "17.58.0.12",
      "user_agent": "Mozilla/5.0",
      "created_at": "2026-10-02T14:00:03Z"
    },
    {
      "kind": "open",
      "prefetch": false,
      "ip": "203.0.113.7",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_5)",
      "created_at": "2026-10-02T14:07:04Z"
    },
    {
      "kind": "reply",
      "prefetch": false,
      "user_agent": "inbound-mail",
      "created_at": "2026-10-02T15:12:40Z"
    }
  ],
  "total": 3
}

The API key is missing, malformed, unknown or revoked.

{
  "error": "invalid or revoked api key"
}

The key is valid but does not have the read scope.

{
  "error": "missing permission: read"
}

No such record in this workspace.

{
  "error": "message not found"
}

More than 60 requests a minute on this key. Wait Retry-After seconds. No code field.

Retry-After: 60

{
  "error": "rate limit exceeded — 60 requests per minute per API key"
}

Try it below with your own key. Every sample reads the key from KOLTRIX_API_KEY.

Try it

Send this request from your browser.

Input

What you send

API key

Stays in this browser tab (sessionStorage) and goes only to api.koltrix.com. Create one under Settings → API keys.

Requests are real. Koltrix has no test mode, so use a dedicated key with only the permissions you need and revoke it when you are done.

idstringrequired

GEThttps://api.koltrix.com/api/v2/messages/6f1c2a9e-3b7d-4e41-9a52-0c8d1f3e7b20/events

Output

What comes back

The response appears here.
Press Send request.