Retrieve all attributes for entity type

GET /V1/categories/attributes

Query parameters

searchCriteria[filterGroups][0][filters][0][field] string

Field
searchCriteria[filterGroups][0][filters][0][value] string

Value
searchCriteria[filterGroups][0][filters][0][conditionType] string

Condition type
searchCriteria[sortOrders][0][field] string

Sorting field.
searchCriteria[sortOrders][0][direction] string

Sorting direction.
searchCriteria[pageSize] integer

Page size.
searchCriteria[currentPage] integer

Current page.

Responses

200

200 Success.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Hide items attributes Show items attributes object
  
  is_wysiwyg_enabled boolean
  
  WYSIWYG flag
  
  is_html_allowed_on_front boolean
  
  The HTML tags are allowed on the frontend
  
  used_for_sort_by boolean
  
  It is used for sorting in product listing
  
  is_filterable boolean
  
  It used in layered navigation
  
  is_filterable_in_search boolean
  
  It is used in search results layered navigation
  
  is_used_in_grid boolean
  
  It is used in catalog product grid
  
  is_visible_in_grid boolean
  
  It is visible in catalog product grid
  
  is_filterable_in_grid boolean
  
  It is filterable in catalog product grid
  
  position integer
  
  Position
  
  apply_to array[string]
  
  Apply to value for the element
  
  is_searchable string
  
  The attribute can be used in Quick Search
  
  is_visible_in_advanced_search string
  
  The attribute can be used in Advanced Search
  
  is_comparable string
  
  The attribute can be compared on the frontend
  
  is_used_for_promo_rules string
  
  The attribute can be used for promo rules
  
  is_visible_on_front string
  
  The attribute is visible on the frontend
  
  used_in_product_listing string
  
  The attribute can be used in product listing
  
  is_visible boolean
  
  Attribute is visible on frontend.
  
  scope string
  
  Attribute scope
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\EavAttributeInterface
  
  attribute_id integer
  
  Id of the attribute.
  
  attribute_code string Required
  
  Code of the attribute.
  
  frontend_input string Required
  
  HTML for input element.
  
  entity_type_id string Required
  
  Entity type id
  
  is_required boolean Required
  
  Attribute is required.
  
  options array[object]
  
  Created from:
  
  Hide options attributes Show options attributes object
  
  Created from:
  
  label string Required
  
  Option label
  
  value string Required
  
  Option value
  
  sort_order integer
  
  Option order
  
  is_default boolean
  
  Default
  
  store_labels array[object]
  
  Interface AttributeOptionLabelInterface
  
  Hide store_labels attributes Show store_labels attributes object
  
  Interface AttributeOptionLabelInterface
  
  store_id integer
  
  Store id
  
  label string
  
  Option label
  
  is_user_defined boolean
  
  Current attribute has been defined by a user.
  
  default_frontend_label string
  
  Frontend label for default store
  
  frontend_labels array[object] Required
  
  Interface AttributeFrontendLabelInterface
  
  Hide frontend_labels attributes Show frontend_labels attributes object
  
  Interface AttributeFrontendLabelInterface
  
  store_id integer
  
  Store id
  
  label string
  
  Option label
  
  note string
  
  The note attribute for the element.
  
  backend_type string
  
  Backend type.
  
  backend_model string
  
  Backend model
  
  source_model string
  
  Source model
  
  default_value string
  
  Default value for the element.
  
  is_unique string
  
  This is a unique attribute
  
  frontend_class string
  
  Frontend class of attribute
  
  validation_rules array[object]
  
  Interface AttributeValidationRuleInterface
  
  Hide validation_rules attributes Show validation_rules attributes object
  
  Interface AttributeValidationRuleInterface
  
  key string Required
  
  Object key
  
  value string Required
  
  Object value
  
  custom_attributes array[object]
  
  Interface for custom attribute value.
  
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  Interface for custom attribute value.
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value
- search_criteria object Required
  
  Search criteria interface.
  
  Hide search_criteria attributes Show search_criteria attributes object
  
  filter_groups array[object] Required
  
  Groups two or more filters together using a logical OR
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  Groups two or more filters together using a logical OR
  
  filters array[object]
  
  Filter which can be used by any methods from service layer.
  
  Hide filters attributes Show filters attributes object
  
  Filter which can be used by any methods from service layer.
  
  field string Required
  
  Field
  
  value string Required
  
  Value
  
  condition_type string
  
  Condition type
  
  sort_orders array[object]
  
  Data object for sort order.
  
  Hide sort_orders attributes Show sort_orders attributes object
  
  Data object for sort order.
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  page_size integer
  
  Page size.
  
  current_page integer
  
  Current page.
- total_count integer Required
  
  Total count.
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/categories/attributes

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/categories/attributes

Response examples (200)

{
  "items": [
    {
      "is_wysiwyg_enabled": true,
      "is_html_allowed_on_front": true,
      "used_for_sort_by": true,
      "is_filterable": true,
      "is_filterable_in_search": true,
      "is_used_in_grid": true,
      "is_visible_in_grid": true,
      "is_filterable_in_grid": true,
      "position": 42,
      "apply_to": [
        "string"
      ],
      "is_searchable": "string",
      "is_visible_in_advanced_search": "string",
      "is_comparable": "string",
      "is_used_for_promo_rules": "string",
      "is_visible_on_front": "string",
      "used_in_product_listing": "string",
      "is_visible": true,
      "scope": "string",
      "extension_attributes": {},
      "attribute_id": 42,
      "attribute_code": "string",
      "frontend_input": "string",
      "entity_type_id": "string",
      "is_required": true,
      "options": [
        {
          "label": "string",
          "value": "string",
          "sort_order": 42,
          "is_default": true,
          "store_labels": [
            {
              "store_id": 42,
              "label": "string"
            }
          ]
        }
      ],
      "is_user_defined": true,
      "default_frontend_label": "string",
      "frontend_labels": [
        {
          "store_id": 42,
          "label": "string"
        }
      ],
      "note": "string",
      "backend_type": "string",
      "backend_model": "string",
      "source_model": "string",
      "default_value": "string",
      "is_unique": "string",
      "frontend_class": "string",
      "validation_rules": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "custom_attributes": [
        {
          "attribute_code": "string",
          "value": "string"
        }
      ]
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 42,
    "current_page": 42
  },
  "total_count": 42
}

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}