Skip to main content
List Journeys

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Query Parameters

id
string

Journey ID

name
string

Journey name

organisation_id
string

Organisation ID

key
string

Journey key

status
string

Journey status

latest_published_version_id
string

Latest published version ID

select
string

Filtering Columns

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

200 - application/json

OK

id
string<uuid>
default:random uuid

Journey ID

name
string<text>

Journey name

organisation_id
string<uuid> | null

Organisation ID

key
string<text> | null

Journey key

status
enum<string>
default:draft

Journey status

Available options:
active,
inactive,
draft
latest_published_version_id
string<uuid> | null

Latest published version ID