Contacts

List a contact's journey runs

GET/v1/contacts/{id}/journeys

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

Every run of a journey this contact entered, newest first: active while it is still moving through the steps, completed at the end, exited when it left early, with exitReason saying why.

Path parameters

idstringrequired: uuid

Query parameters

limitintegeroptional

min > 0 · max 100 · default 20

cursorstringoptional

1–2048 characters

emailstringoptional

Exact match on the address, trimmed, without case.

qstringoptional

Searches any part of the email address or name, ignoring case.

1–100 characters

Returns

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

enrollmentIdstringrequired

uuid

journeyIdstringrequired

uuid

journeyNamestringrequired

journeyStatusstringrequired

one of draft, active, paused, ended

statusstringrequired

one of active, completed, exited

currentStepIndexinteger | nullrequired

Zero-based step the run is at; null once it has ended.

min 0 · max 9007199254740991

enteredAtstringrequired

date-time

endedAtstring | nullrequired

date-time

exitReasonstring | nullrequired

Why an exited run ended: filter_mismatch, exit_event, manual or journey_ended.

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

const response = await fetch('https://api.kirora.io/v1/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/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/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/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/contacts/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/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": [
    {
      "enrollmentId": "018f2a4e-6b1c-7d3e-9f40-8b76f3d85a6b",
      "journeyId": "018f2a4e-6b1c-7d3e-9f40-7cf2bf7e5a6b",
      "journeyName": "journeyName_example",
      "journeyStatus": "draft",
      "status": "active",
      "currentStepIndex": 0,
      "enteredAt": "2030-03-14T09:30:00Z",
      "endedAt": "2030-03-14T09:30:00Z",
      "exitReason": "exitReason_example"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.