List a push message's deliveriesMenu

List a push message's deliveries

GET/v1/messages/{id}/deliveries

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

Works with integration, agent and partner keys.

Lists what each device reported for one push message: any message whose channel is push, from a campaign, a journey or a transactional send. A push reaches every ready installation of the contact, so a message has one delivery per device. accepted: Apple, Google or the browser's push service took it, which is not proof the device showed it. invalid: the device is gone and its installation was retired. rejected: refused, often the app's key or a payload the provider would not take. retryable: will be tried again. unknown: the provider may have taken it, so it is not resent. skipped: not attempted, as when the app's key was refused for another device of the same app. pending and started are still in flight. Any other message returns 404 NOT_FOUND: a missing one says Message not found, and one on another channel names it in details.channel (an email's delivery events are on the message itself).

Path parameters

idstringrequired

The message's id.

uuid

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

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 PushDelivery 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.

idstringrequired

uuid

installationIdstringrequired

The device the delivery went to.

uuid

platformstringrequired

one of ios, android, web

statusstringrequired

one of pending, started, accepted, invalid, rejected, retryable, unknown, skipped

attemptCountintegerrequired

Times sending was tried.

min 0

startedAtstring | nullrequired

When the first attempt began.

date-time

resolvedAtstring | nullrequired

When it reached a final status.

date-time

createdAtstringrequired

date-time

curl https://api.kirora.io/v1/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/deliveries \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/deliveries', {
  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/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/deliveries",
    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/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/deliveries", 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/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/deliveries");
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": [
    {
      "id": "0192f3b1-5e6f-7071-8c83-9e0f1a2b3c4d",
      "installationId": "0192f3a2-6f70-7182-9d94-0f1a2b3c4d5e",
      "platform": "ios",
      "status": "accepted",
      "attemptCount": 1,
      "startedAt": "2026-10-01T09:30:01.000Z",
      "resolvedAt": "2026-10-01T09:30:02.000Z",
      "createdAt": "2026-10-01T09:30:00.000Z"
    },
    {
      "id": "0192f3b1-6f70-7182-9d94-0f1a2b3c4d5e",
      "installationId": "0192f3a2-7081-7293-8ea5-1a2b3c4d5e6f",
      "platform": "android",
      "status": "invalid",
      "attemptCount": 1,
      "startedAt": "2026-10-01T09:30:01.000Z",
      "resolvedAt": "2026-10-01T09:30:03.000Z",
      "createdAt": "2026-10-01T09:30:00.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 20,
      "nextCursor": null
    }
  }
}