---
title: "List Custom Fields"
method: GET
path: "/v2/customer-segments/custom-fields"
tags: ["customer-segments"]
---

# List Custom Fields

`GET /v2/customer-segments/custom-fields`

## Request

- Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.stuut.ai/v2/customer-segments/custom-fields`
- Auth: HTTP bearer

Returns custom fields available for the given object type.
Defaults to partner custom fields for backward compatibility.

## Query parameters

- `object_type` string

## Response `200`

Successful Response

- PartnerCustomFieldSchema[]
  - `id` string, required
  - `key` string, required: The unique key for this field.
  - `title` string, nullable, required: The human readable name for this field.
  - `type` string, nullable, required: The data type for this field.
  - `description` string, nullable, required: A description of this field.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/stuut/apis/stuut-api.md) - [All operations](https://skmtc.dev/stuut/apis/stuut-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stuut/apis/stuut-api/revisions/3b5ab941f918?raw)