Sign in

v19

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-012366102.8 KB
User Journeys

Search User Journeys

Search User Journeys - User Journeys are the journeys that are assigned to a user.

get/api/v2/user_journeys

Query parameters

user_idstring

Comma separated list of User IDs

journey_idstring

Comma separated list of Journey IDs

office_location_idstring

Comma separated list of Office Location IDs

transition_typestring

Comma separated list of transition types

statestring

Comma separated list of states

{
  "user_id": "64891c74d5ee1bb16dfdafd8,64891e2ad5ee1bb16dfdafd9",
  "journey_id": "64891c74d5ee1bb16dfdafd8,64891e2ad5ee1bb16dfdafd9",
  "office_location_id": "64891c74d5ee1bb16dfdafd8,64891e2ad5ee1bb16dfdafd9",
  "transition_type": "pre_offer, offer, post_offer, onboarding, offboarding",
  "state": "draft, needs_attention, pending_approval, approved, rejected, rescinded, user_pending, submitted, declined, completed, voided"
}
offsetinteger
limitinteger
order_bystring
directionstring

Response

The request has succeeded.

idstring uuid required
journey_idstring uuid required
user_idstring uuid required
transition_type'pre_offer' | 'offer' | 'post_offer' | 'onboarding' | 'offboarding' required
state'draft' | 'needs_attention' | 'pending_approval' | 'approved' | 'rejected' | 'rescinded' | 'user_pending' | 'submitted' | 'declined' | 'completed' | 'voided' required
created_atstring YYYY-MM-DD required
expiration_datestring YYYY-MM-DD required

Example response

[
  {
    "id": "69ae0e64b02bfe73a44ca479",
    "journey_id": "69ae0e64b02bfe73a44ca479",
    "user_id": "69ae0e64b02bfe73a44ca479",
    "transition_type": "pre_offer",
    "state": "approved",
    "created_at": "2026-01-01",
    "expiration_date": "2026-01-01",
    "office_location": {
      "id": "69ae0e64b02bfe73a44ca479",
      "external_ids": {
        "workday": "LOCATION-3-69"
      },
      "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"
      }
    ]
  }
]