Skip to main content
GET
/
v2
/
journeys
/
{id}
Get Journey
curl --request GET \
  --url https://public.api.serval.com/v2/journeys/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "friendlyIdentifier": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "requesterUserId": "<string>",
    "requesterManagerUserId": "<string>",
    "progressPercent": 123,
    "currentTaskIndex": 123,
    "archivedAt": "2023-11-07T05:31:56Z",
    "dueDate": {
      "year": 123,
      "month": 123,
      "day": 123
    },
    "metadata": {
      "onboarding": {
        "startDate": {
          "year": 123,
          "month": 123,
          "day": 123
        },
        "welcomeMessage": "<string>"
      }
    },
    "createdByWorkflow": {
      "id": "<string>",
      "name": "<string>"
    },
    "tasks": [
      {
        "id": "<string>",
        "parentTaskId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "dependsOnIds": [
          "<string>"
        ],
        "assignedToUserId": "<string>",
        "dueDate": {
          "year": 123,
          "month": 123,
          "day": 123
        },
        "isOverdue": true,
        "isStatusCheck": true,
        "pollingIntervalMs": "<unknown>",
        "latestWorkflowCall": {
          "id": "<string>",
          "workflowId": "<string>",
          "workflowName": "<string>",
          "runId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "formConfirmationRequired": true,
          "formConfirmationResponse": true
        }
      }
    ],
    "healthChecks": [
      {
        "id": "<string>",
        "taskId": "<string>",
        "subtaskId": "<string>",
        "workflowId": "<string>",
        "workflowName": "<string>",
        "workflowCallId": "<string>",
        "runId": "<string>",
        "dueDate": {
          "year": 123,
          "month": 123,
          "day": 123
        }
      }
    ],
    "healthCheckCounts": {
      "totalCount": 123,
      "failingCount": 123,
      "warningCount": 123,
      "passingCount": 123,
      "runningCount": 123,
      "noDataCount": 123,
      "canceledCount": 123
    },
    "workflowFailures": [
      {
        "workflowCallId": "<string>",
        "runId": "<string>",
        "workflowId": "<string>",
        "workflowName": "<string>",
        "taskId": "<string>",
        "subtaskId": "<string>",
        "validationErrors": {
          "displayMessage": "<string>",
          "fieldErrors": {},
          "translations": {}
        },
        "statusCheckResult": {
          "isComplete": true,
          "message": "<string>",
          "messageTranslations": {}
        },
        "runResult": "<string>"
      }
    ]
  }
}

Documentation Index

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

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

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Journey root ticket UUID.

Response

Success

data
data · object

A full journey snapshot returned by GetJourney.