--- title: "Content Categories" url: "https://developer-qual.migros.ch/apis/content-categories-8/versions/2887ed02-f75a-4870-a2ed-581a33bf287a" --- # Content Categories OpenAPI specification document. ```json {"components":{"parameters":{"Accept-Language":{"description":"Defines the language (de/fr/it/en) for this request as request header. Either use the query param \"lang\" or header \"Accept-Language\", not both.","in":"header","name":"Accept-Language","schema":{"default":"de","enum":["de","fr","it","en"],"type":"string"}},"id":{"description":"Resource ID or slug (if available).","in":"path","name":"id","required":true,"schema":{"type":"string"}},"lang":{"description":"Defines the language (de/fr/it/en) for this request as query parameter. Either use the query param \"lang\" or header \"Accept-Language\", not both.","in":"query","name":"lang","schema":{"default":"de","enum":["de","fr","it","en"],"type":"string"}},"limit":{"description":"Maximum number of results (max 2000).","in":"query","name":"limit","required":false,"schema":{"default":10,"maximum":2000,"minimum":0,"type":"integer"}},"offset":{"description":"Result set offset.","in":"query","name":"offset","required":false,"schema":{"default":0,"minimum":0,"type":"integer"}},"order":{"description":"The ordering direction.","in":"query","name":"order","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},"search":{"description":"Simple search string which is fault-tolerant for user-entered text.","in":"query","name":"search","required":false,"schema":{"type":"string"}}},"responses":{"400":{"description":"If the request parameters are invalid."},"404":{"description":"Returned when the requested resource could not be not found."}},"schemas":{"AbstractCollection":{"description":"A generic collection of elements."},"AbstractSearchResultCollection":{"allOf":[{"$ref":"#/components/schemas/AbstractCollection"},{"properties":{"ids":{"description":"Ids only.\n\nIs filled instead of the usual property for content, with only the ids when a call is made with verbosity=id on a\nroute that supports it.","items":{"type":"string"},"type":"array"},"total_hits":{"description":"The total hits may exceed the actual count of results in the collection.\n\nIt represents the total number of results of a search and not only the\npotentially paginated subset.","nullable":true,"type":"integer"}},"type":"object"}],"description":"A collection of search result instances.","type":"object"},"ContentCategory":{"description":"Represents a content category from Magnolia.","properties":{"display_name":{"nullable":true,"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"parent_id":{"type":"string"},"path":{"type":"string"}},"required":["id","name"],"type":"object"},"ContentCategoryCollection":{"allOf":[{"$ref":"#/components/schemas/AbstractSearchResultCollection"},{"properties":{"content_categories":{"items":{"$ref":"#/components/schemas/ContentCategory"},"type":"array"}},"type":"object"}],"description":"A collection of content category instances.","type":"object"}},"securitySchemes":{"Kong-Api-Key":{"description":"Kong key-auth authentication","in":"header","name":"X-Api-Key","type":"apiKey"},"basicAuth":{"scheme":"basic","type":"http"}}},"info":{"contact":{"email":"arg_mgb-udp-products-services@mgb.ch","name":"MGB-UDP-Products-Services"},"description":"Get content categories/taxonomy. See Wiki","title":"Content Categories","version":"8"},"openapi":"3.0.0","paths":{"/migros/products/v8/content-categories":{"get":{"description":"Returns a paged list of content categories and provides search functionality.","operationId":"get-content-categories","parameters":[{"$ref":"#/components/parameters/search"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"description":"The sorting criteria.","in":"query","name":"sort","schema":{"default":"score","enum":["score","id","name"],"type":"string"}},{"$ref":"#/components/parameters/order"},{"description":"A comma separated list or an array of ids defining the instances and the order in which they should be returned. If the ids parameter is provided all other filtering parameters are ignored.","in":"query","name":"ids","schema":{"type":"string"}},{"description":"Show content categories whose paths begin with the given path, for example '/organisationseinheit/genossenschaft'.","in":"query","name":"path","schema":{"type":"string"}},{"$ref":"#/components/parameters/lang"},{"$ref":"#/components/parameters/Accept-Language"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentCategoryCollection"}}},"description":"Returned when successful"},"400":{"$ref":"#/components/responses/400"}},"summary":"Returns a paged list of content categories and provides search functionality.","tags":["Content Categories"]}},"/migros/products/v8/content-categories/{id}":{"get":{"description":"Returns information about a single content category by ID.","operationId":"get-content-category","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/lang"},{"$ref":"#/components/parameters/Accept-Language"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentCategory"}}},"description":"Returned when successful"},"404":{"$ref":"#/components/responses/404"}},"summary":"Returns information about a single content category by ID.","tags":["Content Categories"]}}},"security":[{"Kong-Api-Key":[],"basicAuth":[]}],"servers":[{"description":"Public Kong Gateway URL","url":"https://api-qual.migros.ch"}],"tags":[{"name":"Content Categories"},{"name":"mapi"}],"x-active-from":"01-01-2024","x-company":"migros","x-edm-domain":"products","x-eol":"31-12-2049","x-headmatter":{"readable_by":"*"},"x-kong-route-defaults":{"protocols":["https"],"strip_path":false},"x-kong-service-defaults":{"connect_timeout":5000,"read_timeout":15000,"retries":1,"write_timeout":5000},"x-leanix-id":"350641a5-55a2-4641-8332-76d32846eb56","x-link-get-access":"https://forms.office.com/e/zhzbEqAQ26","x-link-get-support":"https://teams.microsoft.com/l/channel/19%3Aa7851e50d0194268ba0c7a0d7a63403b%40thread.tacv2/2.%20Support%20%F0%9F%92%A1?groupId=58b919a5-7d36-47f3-a77a-03cfd051098a&tenantId=35aa8c5b-ac0a-4b15-9788-ff6dfa22901f"} ```