v1

latestSwagger 2.02026-07-13137761.0 MB
Attribute

Get list of attributes

This endpoint allows you to get a list of attributes. Attributes are paginated and sorted by code.

get/api/rest/v1/attributes

Query parameters

searchstring

Filter attributes, for more details see the <a href="/documentation/filter.html#filter-attributes">Filters</a> section.

pageinteger

Number of the page to retrieve when using the page pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html#pagination">Pagination</a> section

limitinteger

Number of results by page, see <a href="/documentation/pagination.html">Pagination</a> section

with_countboolean

Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

with_table_select_optionsboolean

Return the options of 'select' column types (of a table attribute) in the response. (Only available since the 7.0 version)

Response

Return attributes paginated

current_pageinteger

Current page number

Example response

{
  "_embedded": {
    "items": [
      {
        "code": "release_date",
        "type": "pim_catalog_date",
        "group": "marketing",
        "group_labels": {
          "en_US": "Marketing",
          "fr_FR": "Marketing"
        },
        "unique": false,
        "useable_as_grid_filter": true,
        "allowed_extensions": [],
        "metric_family": null,
        "default_metric_unit": null,
        "reference_data_name": null,
        "available_locales": [],
        "max_characters": null,
        "validation_rule": null,
        "validation_regexp": null,
        "wysiwyg_enabled": null,
        "number_min": null,
        "number_max": null,
        "decimals_allowed": null,
        "negative_allowed": null,
        "date_min": "2017-06-28T08:00:00",
        "date_max": "2017-08-08T22:00:00",
        "max_file_size": null,
        "minimum_input_length": null,
        "sort_order": 1,
        "localizable": false,
        "scopable": false,
        "default_value": null,
        "labels": {
          "en_US": "Sale date",
          "fr_FR": "Date des soldes"
        },
        "is_mandatory": false,
        "decimal_places_strategy": null,
        "decimal_places": null
      }
    ]
  }
}