Skip to main content
GET
/
api
/
v1
/
public
/
journeys
/
runs
/
{runId}
Get journey run status
curl --request GET \
  --url http://localhost:3001/api/v1/public/journeys/runs/{runId} \
  --header 'x-api-key: <api-key>'
{
  "runId": "<string>",
  "journeyId": "<string>",
  "profileId": "<string>",
  "workflowId": "<string>",
  "status": "queued",
  "triggeredAt": "<string>",
  "completedAt": "<string>",
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://segmentflow.ai/docs/llms.txt

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

Authorizations

x-api-key
string
header
required

Path Parameters

runId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

runId
string
required
journeyId
string
required
profileId
string
required
workflowId
string | null
required
status
enum<string>
required
Available options:
queued,
running,
completed,
failed,
exited
triggeredAt
string
required
completedAt
string | null
required
error
string | null
required