Journeys

List journey definition versions

GET/v1/journeys/{id}/definitions

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

Journeys are versioned: activating a changed journey creates a new definition while contacts already in flight continue on the one they entered. This lists those versions. Results are cursor-paginated: pass meta.pagination.nextCursor back as cursor until it comes back null. The cursor is opaque — do not construct or parse one.

Path parameters

idstringrequired: uuid

Query parameters

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

Returns

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

A hash of the steps; pass it as definitionId to read that version's stats.

stepTypesstring[]required

The type of each step in this version, in order.

at most 50 items

enrollmentCountintegerrequired

Runs that followed this version.

min 0 · max 9007199254740991

firstEnrolledAtstringrequired

When the first run following this version entered.

date-time

lastEnrolledAtstringrequired

When the latest run following this version entered.

date-time

matchesCurrentStepsbooleanrequired

Whether this version is the journey's current steps.

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

const response = await fetch('https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/definitions', {
  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/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/definitions",
    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/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/definitions", 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": "id_example",
      "stepTypes": [
        "wait"
      ],
      "enrollmentCount": 0,
      "firstEnrolledAt": "2030-03-14T09:30:00Z",
      "lastEnrolledAt": "2030-03-14T09:30:00Z",
      "matchesCurrentSteps": true
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.