Journeys

List journeys

GET/v1/journeys

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

Returns journeys in this organization. Pass status to list only journeys in that state. 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.

Query parameters

limitintegeroptional

min > 0 · max 100 · default 20

cursorstringoptional

1–2048 characters

qstringoptional

1–200 characters

statusstringoptional

Only journeys in this status.

one of draft, active, paused, ended

Returns

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

triggerEventstringrequired

The event that starts a run.

dateTriggerobject | nullrequired

The contact date that starts runs, for a date journey; otherwise null.

5 child attributes

fieldstringrequired

The contact date field the journey runs from.

recurrencestringrequired

once runs on the date a single time; annual repeats every year.

one of once, annual

offsetDaysintegerrequired

Days from the date to start: negative before it, positive after. Defaults to 0.

min -365 · max 365 · default 0

timestringrequired

Time of day to start, as HH:MM in the contact's timezone, else the workspace's.

leapDaystringrequired

For an annual 29 February date in a common year: run on 28 Feb, on 1 Mar, or skip.

one of feb28, mar1, skip · default "feb28"

enrolledCountintegerrequired

Runs ever started.

min 0 · max 9007199254740991

statusstringrequired

ended: nobody enters and runs in progress were exited; it cannot restart.

one of draft, active, paused, ended

createdAtstringrequired

date-time

updatedAtstringrequired

date-time

activeCountintegerrequired

Runs in progress now.

min 0 · max 9007199254740991

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

const response = await fetch('https://api.kirora.io/v1/journeys', {
  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",
    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", 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",
      "triggerEvent": "triggerEvent_example",
      "dateTrigger": {
        "field": "field_example",
        "recurrence": "once",
        "offsetDays": 0,
        "time": "time_example",
        "leapDay": "feb28"
      },
      "enrolledCount": 0,
      "status": "draft",
      "createdAt": "2030-03-14T09:30:00Z",
      "updatedAt": "2030-03-14T09:30:00Z",
      "activeCount": 0
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.