---
title: "Search Custom Fields"
method: GET
path: "/api/v2/custom_fields"
tags: ["Custom Fields"]
---

# Search Custom Fields

`GET /api/v2/custom_fields`

Lists custom fields that can be used in user journeys or forms. Custom fields help capture metadata unique to your organization.

## Query parameters

- `filters` object
  - `id` string — Comma separated list of Custom Field IDs
  - `transition_type` string — Comma separated list of Transition Types
  - `data_type` string — Comma separated list of Data Types
  - `active` string — Comma separated list of Active
- `offset` integer
- `limit` integer
- `order_by` string
- `direction` string

## Response `200`

The request has succeeded.

- ResponsesCustomFieldList[]
  - `id` string, uuid, required
  - `transition_type` 'pre_offer' | 'offer' | 'post_offer' | 'onboarding' | 'offboarding', required
  - `name` string, required
  - `key` string, required
  - `data_type` string, required
  - `mandatory` boolean, required
  - `mapping` string
  - `validation_rule` string
  - `regexp_pattern` string — Required if validation_rule is regexp
  - `allowed_values` string[], required — Required if validation_rule is list
  - `list_of_values_map_id` string, required — Required if validation_rule is list_of_values_map
  - `created_at` string, required
  - `deactivated` boolean
  - `rule_settable` boolean — Used in Assignment Rules
  - `placeholderable` boolean — Used in placeholders
  - `allowed_rule_set_types` string[], required
  - `allowed_placeholder_type` string[], required
  - `workday_organization_type` string — Required if validation_rule is workday_organization

## Changes

- **2026-03-09** `3f638e7bcdd4` — 5 warning
  - added the new `offboarding` enum value to the `items/transition_type` response property for the response status `200`
  - added the new `offer` enum value to the `items/transition_type` response property for the response status `200`
  - added the new `onboarding` enum value to the `items/transition_type` response property for the response status `200`
  - added the new `post_offer` enum value to the `items/transition_type` response property for the response status `200`
  - …1 more
- **2025-07-31** `33c1d5958395` — 1 breaking, 1 info
  - removed the required property `items/journey_type` from the response with the `200` status
  - added the required property `items/transition_type` to the response with the `200` status
- **2025-05-19** `805744a185fa` — 1 info
  - endpoint added
- **2024-06-11** `6cde27481f55` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/xpand-io/apis/xpand-api/changes/api/v2/custom_fields/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)