---
title: "Search User Journeys"
method: GET
path: "/api/v2/user_journeys"
tags: ["User Journeys"]
---

# Search User Journeys

`GET /api/v2/user_journeys`

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

## Query parameters

- `filters` object
  - `user_id` string — Comma separated list of User IDs
  - `journey_id` string — Comma separated list of Journey IDs
  - `office_location_id` string — Comma separated list of Office Location IDs
  - `transition_type` string — Comma separated list of transition types
  - `state` string — Comma separated list of states
  - `custom_fields` object
    - `key1` string
    - `key2` string
- `offset` integer
- `limit` integer
- `order_by` string
- `direction` string

## Response `200`

The request has succeeded.

- ResponsesUserJourneyList[]
  - `id` string, uuid, required
  - `journey_id` string, uuid, required
  - `user_id` string, 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_at` string, YYYY-MM-DD, required
  - `expiration_date` string, YYYY-MM-DD, required
  - `office_location` ModelsOfficeLocation, required
    - `id` string, uuid, required
    - `external_ids` object
      - `workday` string
    - `address1` string
    - `address2` string
    - `address3` string
    - `city` string, required
    - `state` string
    - `region` string
    - `country` string, required
    - `postal_code` string
    - `time_zone` string
    - `latitude` number, float
    - `longitude` number, float
  - `custom_field_values` object[], required
    - `id` string
    - `value` string
    - `name` string
    - `key` string

## Changes

- **2026-03-20** `f30bd25c50fa` — 1 warning
  - added the new `voided` enum value to the `items/state` response property for the response status `200`
- **2026-03-09** `fd9ba8047579` — 2 info
  - added `#/components/schemas/Models.OfficeLocation` to the `items/office_location` response property `anyOf` list for the response status `200`
  - removed `#/components/schemas/OfficeLocation` from the `items/office_location` response property `anyOf` list for the response status `200`
- **2026-03-09** `3f638e7bcdd4` — 5 breaking, 27 warning, 10 info
  - the `items/custom_field_values` response's property type/format changed from ``/`` to `array`/`` for status `200`
  - the `items/office_location` response's property type/format changed from `object`/`` to ``/`` for status `200`
  - the `items/state` response's property type/format changed from ``/`` to `string`/`` for status `200`
  - removed the required property `items/office_location/external_ids` from the response with the `200` status
  - …38 more
- **2025-07-31** `33c1d5958395` — 1 warning, 1 info
  - removed the optional property `items/journey_type` from the response with the `200` status
  - added the optional property `items/transition_type` to the response with the `200` status
- **2025-05-19** `805744a185fa` — 1 info
  - endpoint added

[Full history](https://skmtc.dev/xpand-io/apis/xpand-api/changes/api/v2/user_journeys/get.md)

---

[API](https://skmtc.dev/xpand-io/apis/xpand-api.md) · [All operations](https://skmtc.dev/xpand-io/apis/xpand-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xpand-io/xpand-api/revisions/85bece7875fd/schema)