# AF01 - List all custom fields

Call FrequencyRecommended usage: Once per dayMaximum usage: Once per dayRead MoreMore contextLocalizationThis resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: 

Endpoint: GET /api/additional_fields

## Query parameters:

  - `entities` (string)
    A comma separated list of entities on which the additional fields must apply. Accepted values are OFFER, SHOP, ORDER and ORDER_LINE. Ex: OFFER,SHOP.

## Response 200 fields (application/json):

  - `additional_fields` (array, required)

  - `additional_fields.accepted_values` (array)
    The list of accepted values for this additional field. This field is only present for additional fields of type 'LIST'

  - `additional_fields.channels` (array)
    The list of channels using this additional field. This field is only present for additional fields linked to a 'SHOP' entity.

  - `additional_fields.code` (string, required)
    Additional field code

  - `additional_fields.description` (string)
    The description of the additional field.

  - `additional_fields.entity` (string)
    The object on which the additional field applies
    Enum: "SHOP", "OFFER", "ORDER_LINE", "ORDER"

  - `additional_fields.label` (string, required)
    Additional field label

  - `additional_fields.models` (array)
    The list of platform models using this additional field. This field is only present for additional fields linked to a 'SHOP' entity.
    Enum: "MARKETPLACE", "DROPSHIP", "ONE_CREDITOR"

  - `additional_fields.regex` (string)
    The regular expression that is used to validate the value value of this field.This field is only present for additional fields of type 'REGEX'.

  - `additional_fields.required` (boolean, required)
    Whether or not this additionnal field will be required

  - `additional_fields.shop_permission` (string, required)
    The shop permission field determines how Shops are allowed to use a Custom field.INVISIBLE: the field is visible only for the operator and front users. Shops cannot update its value.READ_WRITE: all users can see and update the value of the field, provided they have access to the entity associated with the field.
    Enum: "INVISIBLE", "READ_ONLY", "READ_WRITE"

  - `additional_fields.type` (string, required)
    Additional field type:STRING chain of characters (up to 2000 characters)DATE date in yyyy-mm-dd formatNUMERIC decimal value (eg 52.63)BOOLEAN true or falseLINK valid URLLIST list of values. Valid values are specified in accepted_values fieldREGEX regular expression. The regex that is used to validate the value of this field is specified in the regex fieldTEXTAREA long chain of characters (up to 5000 characters). May have multiple lines
    Enum: "STRING", "DATE", "NUMERIC", "BOOLEAN", "LINK", "REGEX", "TEXTAREA", "LIST", "MULTIPLE_VALUES_LIST"

  - `additional_fields.default_value` (string)

  - `total_count` (integer, required)