---
title: "List address free fields"
method: GET
path: "/api/v2/settings/masterdata/addressCustomFields"
tags: ["Setting"]
---

# List address free fields

`GET /api/v2/settings/masterdata/addressCustomFields`

Fetches all configured address custom fields. Pagination is not necessary because of limit of such fields (20).

## Response `200`

List of address custom fields

- object
  - `data` object[], required
    - `id` string, required — Resource identifier.
    - `name` string, required — Name of address custom field
    - `type` 'single_line' | 'multi_line' | 'date' | 'checkbox' | 'select', required — Value type of address custom field
    - `allowedValues` object[], required
      - `label` string, required
      - `value` string, required

## Other responses

- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)