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

# List custom fields

`GET /v1/custom-fields`

## Request

- Base URL: `https://api.mailrith.com`
- URL: `https://api.mailrith.com/v1/custom-fields`
- Auth: HTTP bearer

Returns a bounded page of custom fields in the authenticated workspace, including each field's exact ready-to-use email personalization token.

## Query parameters

- `search` string
- `limit` integer
- `starting_after` string

## Response `200`

Successful response

- object
  - `data` CustomField[], required
    - `self` string, required: Stable relative Public API path for retrieving this resource.
    - `id` string, required
    - `label` string, required
    - `type` string, required
    - `settings` object, required
      - `options` string[], required
    - `personalization_token` string, required: The exact ready-to-use token for this custom field. Copy it into an email subject or body text node and replace only the fallback text when needed. This value is computed from the current field label and is not stored separately.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `pagination` Pagination, required
    - `has_more` boolean, required
    - `next_cursor` string, nullable, required

## Other responses

- `401`: Authentication is required or invalid

---

[API](https://skmtc.dev/mailrith/apis/mailrith-api.md) · [All operations](https://skmtc.dev/mailrith/apis/mailrith-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mailrith/apis/mailrith-api/revisions/41f09536f2da?raw)