Skip to main content
GET
/
journeys
/
{journeyId}
Get a journey
curl --request GET \
  --url https://apix.spotzee.com/api/client/journeys/{journeyId} \
  --header 'Authorization: Bearer <token>'
{
  "id": 33,
  "project_id": 123,
  "name": "<string>",
  "status": "draft",
  "created_at": "<string>",
  "updated_at": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "stats": {},
  "stats_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Path Parameters

journeyId
integer | null

Numeric journey identifier.

Example:

33

Response

The requested journey.

A multi-step automation triggered by an event or a contact’s entry into a target list.

id
integer
required

Numeric journey identifier.

Example:

33

project_id
integer
required
name
string
required
status
enum<string>
required

draft is a work-in-progress journey not yet active; live is currently accepting entries; off is paused — no new entrances are processed.

Available options:
draft,
live,
off
created_at
string | null
required
updated_at
string | null
required
description
string | null
tags
string[] | null
stats
object

Aggregated counts by step type. Cached; lags by a few seconds.

stats_at
string | null

Time stats were last refreshed.