---
title: "PM11 - Get the product attribute configuration"
method: GET
path: "/api/products/attributes"
tags: ["Products"]
---

# PM11 - Get the product attribute configuration

`GET /api/products/attributes`

## Request

- Base URL: `https://your-instance.mirakl.net`
- URL: `https://your-instance.mirakl.net/api/products/attributes`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://auth.mirakl.net/authorize`
    - Token URL: `https://auth.mirakl.net/oauth/token`
- TypeScript: <https://skmtc.dev/mirakl/apis/mirakl-catalog-manager-apis/docs/api/products/attributes/get.ts> (a function with typed inputs; its response is checked against the schema)

<div class="extension-title">Description</div>

Retrieves all attributes for parents and children of the requested hierarchy

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

<div class="recommended-call-frequency">Recommended usage: Every hour</div>
<div class="max-call-frequency">Maximum usage: Every hour</div>
</div>

## Query parameters

- `hierarchy` string
- `max_level` integer
- `channels` string[]
- `with_roles` boolean

## Response `200`

Export success

- PM11Response200: JSON output
  - `attributes` PM11Response200Attributes[], required: List of attributes
    - `channels` PM11Response200AttributesChannels[]: Channels
      - `code` string, required: Channel code
    - `code` string, required: Attribute code
    - `default_value` string: <p>Default value for value list type attributes</p><p>Use the "type_parameters" field for "LIST" attribute types to retrieve the default value.</p>
    - `description` string: Attribute description
    - `description_translations` PM11Response200AttributesDescriptionTranslations[], required: Translations of the attribute description
      - `locale` string, required: Locale
      - `value` string, required: Translation
    - `example` string: Attribute example to help sellers when they fill the product creation form
    - `hierarchy_code` string: The code of the hierarchy (category) this attribute belongs to. If this field is empty, the attribute is shared among all hierarchies.
    - `label` string: Attribute label
    - `label_translations` PM11Response200AttributesLabelTranslations[], required: Translations of the attribute label
      - `locale` string, required: Locale
      - `value` string, required: Translation
    - `locale` string: Attribute localization. The language format can either be: - ISO-639 (E.g. "en") - ISO-639_ISO-3166 (E.g. "en_US")
    - `required` boolean, required: <p>Whether or not the attribute is required</p><p>This field is deprecated. Use the "requirement_level" field instead.</p>
    - `requirement_level` string, required: Requirement level of the attribute Enum: `"OPTIONAL"`, `"REQUIRED"`, `"RECOMMENDED"`, `"DISABLED"`
    - `roles` PM11Response200AttributesRoles[], required: Attribute roles
      - `parameters` PM11Response200AttributesRolesParameters[], required: Attribute role parameters
        - `name` string, required: Name of the parameter
        - `value` string, required: Value of the parameter
      - `type` string, required: Role type of the attribute
    - `transformations` string: Transformations applied to the attribute (a list of transformations separated by commas)
    - `type` string, required: Attribute type
    - `type_parameter` string, required: <p>Type parameter</p><p>This field is deprecated. Use the "type_parameters" field instead.</p>
    - `type_parameters` PM11Response200AttributesTypeParameters[]: Specificities of the attribute type, for example the date format, or the maximum size of a media
      - `name` string, required: Name of the parameter
      - `value` string, required: Value of the parameter
    - `unique_code` string: Unique code of the attribute
    - `validations` string: Validations applied to the attribute (a list of validations separated by commas)
    - `values` PM11Response200AttributesValues[]: A list of authorized values for this attribute
      - `code` string, required: <p>Value code</p><p>This API is deprecated. Use the "type_parameter" field for "LIST" attribute types to retrieve the value list code.</p>
    - `values_list` string: <p>This code points to the list defining the authorized values for this attribute.</p><p>This API is deprecated. Use the "type_parameter" field for "LIST" attribute types to retrieve the value list code.</p>
    - `variant` boolean, required: Whether or not the attribute is a variation axis. Possible values: <code>true</code> or <code>false</code>

---

[API](https://skmtc.dev/mirakl/apis/mirakl-catalog-manager-apis.md) - [All operations](https://skmtc.dev/mirakl/apis/mirakl-catalog-manager-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/mirakl/apis/mirakl-catalog-manager-apis/revisions/dd54ccb6550e?raw)