---
title: "AF01 - List all custom fields"
method: GET
path: "/api/additional_fields"
tags: ["Platform Settings"]
---

# AF01 - List all custom fields

`GET /api/additional_fields`

<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>

<div class="recommended-call-frequency">Recommended usage: Once per day</div>
<div class="max-call-frequency">Maximum usage: Once per day</div>
<div class="extension-title">Read More</div>

<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/mmp/Operator/config_custom_fields/config_custom_fields.html">More context</a></li></ul><div class="extension-title">Localization</div>

<p>This resource supports <code>locale</code> parameter (<a href="#section/Locale">see documentation</a>)</p><p>Localized output fields will be highlighted with an icon: <span class="flag"></span></p></div>

## Query parameters

- `entities` string

## Response `200`

OK

- AF01Response200
  - `additional_fields` AF01Response200AdditionalFields[], required
    - `accepted_values` string[] — The list of accepted values for this additional field. This field is only present for additional fields of type 'LIST'
    - `channels` string[] — The list of channels using this additional field. This field is only present for additional fields linked to a 'SHOP' entity.
    - `code` string, required — Additional field code
    - `default_value` string
    - `description` string — The description of the additional field.
    - `entity` string — The object on which the additional field applies Enum: `"SHOP"`, `"OFFER"`, `"ORDER_LINE"`, `"ORDER"`
    - `label` string, required — <span>Additional field label </span><span title="This field is localized: its value uses the locale provided in the parameters" class="flag"></span>
    - `models` string[] — The list of platform models using this additional field. This field is only present for additional fields linked to a 'SHOP' entity.
    - `regex` string — The regular expression that is used to validate the value value of this field.<br/>This field is only present for additional fields of type 'REGEX'.
    - `required` boolean, required — Whether or not this additionnal field will be required
    - `shop_permission` string, required — The shop permission field determines how Shops are allowed to use a Custom field.<ul><li><strong>INVISIBLE</strong>: the field is visible only for the operator and front users. Shops cannot update its value.</li><li><strong>READ_WRITE</strong>: all users can see and update the value of the field, provided they have access to the entity associated with the field.</li></ul> Enum: `"INVISIBLE"`, `"READ_ONLY"`, `"READ_WRITE"`
    - `type` string, required — Additional field type:<ul><li><strong>STRING</strong> chain of characters (up to 2000 characters)</li><li><strong>DATE</strong> date in yyyy-mm-dd format</li><li><strong>NUMERIC</strong> decimal value (eg 52.63)</li><li><strong>BOOLEAN</strong> true or false</li><li><strong>LINK</strong> valid URL</li><li><strong>LIST</strong> list of values. Valid values are specified in accepted_values field</li><li><strong>REGEX</strong> regular expression. The regex that is used to validate the value of this field is specified in the regex field</li><li><strong>TEXTAREA</strong> long chain of characters (up to 5000 characters). May have multiple lines</li></ul> Enum: `"STRING"`, `"DATE"`, `"NUMERIC"`, `"BOOLEAN"`, `"LINK"`, `"REGEX"`, `"TEXTAREA"`, `"LIST"`, `"MULTIPLE_VALUES_LIST"`
  - `total_count` integer, required

---

[API](https://skmtc.net/mirakl/apis/mirakl-catalog-manager-apis.md) · [All operations](https://skmtc.net/mirakl/apis/mirakl-catalog-manager-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mirakl/mirakl-catalog-manager-apis/revisions/9dfb063e9782/schema)