Push installations

List a contact's push installations

GET/v1/contacts/{id}/installations

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

Lists the devices and browsers registered against a contact, newest first, including inactive ones (active: false after a sign-out, a refused permission, or a provider reporting the device gone). The device token or browser subscription is never returned.

Path parameters

idstringrequired: uuid

Query parameters

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

Returns

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

contactIdstringrequired

uuid

pushAppIdstringrequired

uuid

externalInstallationIdstringrequired

Your own id for the device, as registered.

platformstringrequired

one of ios, android, web

environmentstringrequired

one of sandbox, production

permissionstringrequired

one of granted, denied

activebooleanrequired

False once the device is disabled or its token is refused.

invalidatedAtstring | nullrequired

When the provider refused the token or the device was disabled.

date-time

lastSeenAtstringrequired

When the device last registered or refreshed.

date-time

sdkstring | nullrequired

The Kirora SDK and version that last registered it; null from a server.

createdAtstringrequired

date-time

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

const response = await fetch('https://api.kirora.io/v1/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/installations', {
  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/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/installations",
    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/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/installations", 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",
      "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b",
      "pushAppId": "018f2a4e-6b1c-7d3e-9f40-7967f0395a6b",
      "externalInstallationId": "externalInstallationId_example",
      "platform": "ios",
      "environment": "sandbox",
      "permission": "granted",
      "active": true,
      "invalidatedAt": "2030-03-14T09:30:00Z",
      "lastSeenAt": "2030-03-14T09:30:00Z",
      "sdk": "sdk_example",
      "createdAt": "2030-03-14T09:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.