Sign in
User Journeys

Fetch User Journey

Fetch a User Journey

get/api/v2/user_journeys/{id}

Path parameters

idstring required

Response

The request has succeeded.

idstring required
journey_idstring required
journey_typestring
user_idstring
state'draft' | 'needs_attention' | 'pending_approval' | 'approved' | 'rejected' | 'rescinded' | 'user_pending' | 'submitted' | 'declined' | 'completed'
created_atstring

Example response

{
  "id": "123456898",
  "journey_id": "123456",
  "journey_type": "pre_offer",
  "user_id": "123456",
  "created_at": "2025-01-01",
  "office_location": {
    "workday": "LOCATION-3-69",
    "id": "LOCATION-3-69",
    "external_ids": {
      "hris_id": "E-1234"
    },
    "address1": "123 Main St",
    "address2": "Suite 200",
    "address3": "Building B",
    "city": "New York",
    "state": "NY",
    "region": "Northeast",
    "country": "USA",
    "postal_code": "10001",
    "time_zone": "NZT",
    "latitude": 3.12332,
    "longitude": 3.12332
  },
  "custom_field_values": {
    "id": "1234",
    "value": "custom field value",
    "name": "custom field name",
    "key": "1234"
  }
}

Changes