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

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"
      }
    ]
  }
]

Changes

Changed in 6 of the 19 revisions of this API.62914

Mar 20, 2026f30bd25c50fa1See the full diff
- ●
  added the new voided enum value to the items/state response property for the response status 200
  response-property-enum-value-added
Mar 9, 2026fd9ba80475792See the full diff
- ○
  added Models.OfficeLocation to the items/office_location response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  removed OfficeLocation from the items/office_location response property anyOf list for the response status 200
  response-property-any-of-removed
This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 9, 20263f638e7bcdd452710See the full diff
- ▲
  the items/custom_field_values response's property type/format changed from / to array/ for status 200
  response-property-type-changed
- ▲
  the items/office_location response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the items/state response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  removed the required property items/office_location/external_ids from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property items/office_location/id from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property items/office_location/address1 from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/address2 from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/address3 from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/city from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/country from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/latitude from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/longitude from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/postal_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/region from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/state from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/time_zone from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/office_location/workday from the response with the 200 status
  response-optional-property-removed
- ●
  added the new approved enum value to the items/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new completed enum value to the items/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new declined enum value to the items/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new draft enum value to the items/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new needs_attention enum value to the items/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new offboarding enum value to the items/transition_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new offer enum value to the items/transition_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new onboarding enum value to the items/transition_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new pending_approval enum value to the items/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new post_offer enum value to the items/transition_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new pre_offer enum value to the items/transition_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new rejected enum value to the items/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new rescinded enum value to the items/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new submitted enum value to the items/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new user_pending enum value to the items/state response property for the response status 200
  response-property-enum-value-added
- ○
  removed CustomFieldsValueObject from the items/custom_field_values response property allOf list for the response status 200
  response-property-all-of-removed
- ○
  removed UserJourneyState from the items/state response property allOf list for the response status 200
  response-property-all-of-removed
- ○
  added OfficeLocation subschema #2 to the items/office_location response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  the response property items/created_at became required for the status 200
  response-property-became-required
- ○
  the response property items/custom_field_values became required for the status 200
  response-property-became-required
- ○
  the response property items/office_location became required for the status 200
  response-property-became-required
- ○
  the response property items/state became required for the status 200
  response-property-became-required
- ○
  the response property items/transition_type became required for the status 200
  response-property-became-required
- ○
  the response property items/user_id became required for the status 200
  response-property-became-required
- ○
  added the required property items/expiration_date to the response with the 200 status
  response-required-property-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 202533c1d595839511See the full diff
- ●
  removed the optional property items/journey_type from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property items/transition_type to the response with the 200 status
  response-optional-property-added
May 19, 2025805744a185fa1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 11, 20246cde27481f551See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 68 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history