---
title: "Returns a category by key"
method: GET
path: "/category/getbykey/{key}"
tags: ["Category"]
---

# Returns a category by key

`GET /category/getbykey/{key}`

## Request

- The document declares no server URL.
- Auth: API key in header `TWN-InstanceKey` and API key in header `TWN-Authentication`

## Path parameters

- `key` string, required

## Response `200`

OK

- CategoryApiModel
  - `CategoryId` integer, nullable
  - `Key` string, nullable
  - `Name` string, nullable
  - `Rank` integer
  - `Status` 'Active' | 'InActive'
  - `LandingPage` LandingPageApiModel
    - `FilterTemplateId` integer, nullable
    - `MerchandisingTemplateId` integer, nullable
    - `MerchandisingBuilderId` integer, nullable
  - `Parents` integer[], nullable
  - `Url` string, nullable
  - `LanguageId` integer, nullable

## Other responses

- `404`: Not Found

---

[API](https://skmtc.dev/tweakwise/apis/app-api.md) - [All operations](https://skmtc.dev/tweakwise/apis/app-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tweakwise/apis/app-api/revisions/dc936bf76941?raw)