GET /api/v2/categories
List categories

Supported Formats

json

Errors

Code	Description
401	Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403	Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404	Not Found. The requested resource could not be found.
422	Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500	Internal Server Error. An unexpected condition was encountered.

Examples

Response:
  {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_entries": 2,
    "entries": [
      {
        "id": 1,
        "name": "Engine Oil",
        "description": null,
        "parent_id": null,
        "category_set_id": 1,
        "path": "default: Engine Oil",
        "category_set": {
          "id": 1,
          "name": "default"
        },
        "attribute_values": [
          {
              "attribute_definition_id": 25,
              "attribute_definition_code": "colour_hex",
              "data": "#000"
          },
          {
              "attribute_definition_id": 1,
              "attribute_definition_code": "colour",
              "data": "Green"
          }
        ],
        "media_items": [
          {
              "id": 255,
              "media_item_type": "ImageMediaItem",
              "url": "http://example.com/image-1",
              "description": "Sample description",
              "sort_order": 0,
              "is_primary": false,
              "is_uploaded": null,
              "asset_file_name": "photo-1513002749550-c59d786b8e6c",
              "public_url": "",
              "etag": "",
              "position": 0,
              "tag_list": [
                  "beautiful",
                  "t-shirt"
              ]
          }
        ]
      },
      {
        "id": 2,
        "name": "Transmission Oil",
        "description": null,
        "parent_id": null,
        "category_set_id": 1,
        "path": "default: Transmission Oil",
        "category_set": {
          "id": 1,
          "name": "default"
        },
        "attribute_values": [
          {
              "attribute_definition_id": 25,
              "attribute_definition_code": "colour_hex",
              "data": "#001"
          },
          {
              "attribute_definition_id": 1,
              "attribute_definition_code": "colour",
              "data": "Red"
          }
        ],
        "media_items": [
          {
              "id": 255,
              "media_item_type": "ImageMediaItem",
              "url": "http://example.com/image-2",
              "description": "Sample description",
              "sort_order": 0,
              "is_primary": false,
              "is_uploaded": null,
              "asset_file_name": "photo-1513002433fd4-c59d786b8e6c",
              "public_url": "",
              "etag": "",
              "position": 0,
              "tag_list": []
          }
        ]
      }
    ]
  }

Params

Param name	Description
per_page optional	Number of objects in one response. Default is 50 Validations: Must be a number.
page optional	Page number. Default is 1 Validations: Must be a number.
lang optional	Language code for translated value Validations: Must be a String
response_associated_fields optional	One of ‘attribute_values’, ‘association_attribute_values’, ‘media_items’. The information related to the category to be included in the category data response. Use comma to join multiple fields. Validations: Must be a String