---
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

---

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