Topics

List topics

GET/v1/topics

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

Any member, or a key with topics:read. Topics let contacts choose what marketing they get, separately from groups. A campaign or journey send step with a topicId reaches a contact only if they have email or push consent and the topic reaches them: an opt_out topic reaches everyone who has not left it, an opt_in topic only those who joined. A contact leaves a topic from the unsubscribe link of any message sent on it; every change is recorded in consent history.

Query parameters

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

Returns

Returns 200 OK. Otherwise returns an error; Errors lists every code and which to retry.

idstringrequired

uuid

namestringrequired

descriptionstring | nullrequired

modestringrequired

opt_out reaches everyone who has not left; opt_in only those who joined.

one of opt_out, opt_in

createdAtstringrequired

date-time

updatedAtstringrequired

date-time

subscribedCountintegerrequired

Contacts who joined explicitly: the whole audience of an opt_in topic.

min -9007199254740991 · max 9007199254740991

unsubscribedCountintegerrequired

Contacts who left explicitly: who an opt_out topic no longer reaches.

min -9007199254740991 · max 9007199254740991

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

const response = await fetch('https://api.kirora.io/v1/topics', {
  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/topics",
    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/topics", 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",
      "description": "description_example",
      "mode": "opt_out",
      "createdAt": "2030-03-14T09:30:00Z",
      "updatedAt": "2030-03-14T09:30:00Z",
      "subscribedCount": -9007199254740991,
      "unsubscribedCount": -9007199254740991
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.