Push projects

List push projects

GET/v1/push-projects

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

Each project groups the iOS, Android and web apps of one product, with whether any can send (ready). Rules that ask whether a contact is reachable by push name a project. Credentials are described, never returned.

Query parameters

limitintegeroptional: min > 0 · max 100 · default 20
cursorstringoptional: 1–2048 characters

Returns

Returns 200 OK with a list of PushProject 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

namestringrequired

environmentstringrequired

one of sandbox, production

readybooleanrequired

At least one app can send; the others' devices are skipped until they can.

installationCountintegerrequired

Across its apps: devices that can receive now.

min -9007199254740991 · max 9007199254740991

lastRegisteredAtstring | nullrequired

Across its apps: when a device last registered; null until the first one.

date-time

appsPushApp[]required

13 child attributes

idstringrequired

uuid

pushProjectIdstringrequired

The project the app belongs to.

uuid

namestringrequired

platformstringrequired

one of ios, android, web

environmentstringrequired

one of sandbox, production

readybooleanrequired

Whether the app can send: web apps, and native apps with a credential Apple or Google has not refused.

credentialobject | nullrequired

A native app's credential, without its key. Null until an admin uploads one.

One of 2 shapes

APNs (iOS)

4 child attributes

kind"apns"required
keyIdstringrequired
teamIdstringrequired
bundleIdstringrequired

FCM (Android)

3 child attributes

kind"fcm"required
projectIdstringrequired: The Firebase project ID.
clientEmailstringrequired: The service account's email.

credentialRefusalobject | nullrequired

Set when Apple or Google refused the credential while sending (a revoked key, a wrong team ID, a service account that lost permission). Sends stop until a new credential is uploaded.

2 child attributes

reasonstringrequired: The provider's own explanation.
refusedAtstringrequired: date-time

vapidPublicKeystring | nullrequired

A web app's public key, passed to the browser when it subscribes; null for native apps.

createdAtstringrequired

date-time

installationCountintegerrequired

Devices that can receive now: registered, active, permission granted.

min -9007199254740991 · max 9007199254740991

lastRegisteredAtstring | nullrequired

When a device that can receive last registered or refreshed; null until then.

date-time

updatedAtstringrequired

date-time

createdAtstringrequired

date-time

updatedAtstringrequired

date-time

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

const response = await fetch('https://api.kirora.io/v1/push-projects', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/push-projects",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
data = response.json()["data"]

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/push-projects", 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()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": [
    {
      "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
      "name": "Weekend specials",
      "environment": "sandbox",
      "ready": true,
      "installationCount": -9007199254740991,
      "lastRegisteredAt": "2030-03-14T09:30:00Z",
      "apps": [
        {
          "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
          "pushProjectId": "018f2a4e-6b1c-7d3e-9f40-bc637fbb5a6b",
          "name": "Weekend specials",
          "platform": "ios",
          "environment": "sandbox",
          "ready": true,
          "credential": {
            "kind": null,
            "keyId": null,
            "teamId": null,
            "bundleId": null
          },
          "credentialRefusal": {
            "reason": null,
            "refusedAt": null
          },
          "vapidPublicKey": "vapidPublicKey_example",
          "createdAt": "2030-03-14T09:30:00Z",
          "installationCount": -9007199254740991,
          "lastRegisteredAt": "2030-03-14T09:30:00Z",
          "updatedAt": "2030-03-14T09:30:00Z"
        }
      ],
      "createdAt": "2030-03-14T09:30:00Z",
      "updatedAt": "2030-03-14T09:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.