---
title: "List subcategories by category"
method: GET
path: "/v1/workflows/category/{categoryId}"
tags: ["Category & subcategory"]
---

# List subcategories by category

`GET /v1/workflows/category/{categoryId}`

## Request

- Base URL: `https://api.finalpos.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.finalpos.com/v1/workflows/category/{categoryId}`
- Auth: API key in header `x-api-key`

Returns the category and its direct child categories in a single response, scoped to the API key company.

## Path parameters

- `categoryId` string, required

## Response `200`

Returns the parent category and a list of subcategories for the given category, scoped to the API key company.

- object
  - `parentCategory` CategoryResponseDto, required
    - `id` string: Unique identifier for the Category.
    - `createdAt` string, date-time: Timestamp when the Category was created.
    - `updatedAt` string, date-time: Timestamp when the Category was last updated.
    - `companyId` string: Company ID associated with the Category.
    - `externalId` string: External ID of the category.
    - `name` string: Name of the category.
    - `description` string: Description of the category.
    - `image` string: Image of the category.
    - `parentId` string: Parent ID of the category.
    - `menuOrder` number: Menu order of the category.
    - `source` string: Source of the category.
  - `subCategories` CategoryResponseDto[], required
    - `id` string: Unique identifier for the Category.
    - `createdAt` string, date-time: Timestamp when the Category was created.
    - `updatedAt` string, date-time: Timestamp when the Category was last updated.
    - `companyId` string: Company ID associated with the Category.
    - `externalId` string: External ID of the category.
    - `name` string: Name of the category.
    - `description` string: Description of the category.
    - `image` string: Image of the category.
    - `parentId` string: Parent ID of the category.
    - `menuOrder` number: Menu order of the category.
    - `source` string: Source of the category.

## Other responses

- `400`: Bad request. Returns validation errors or other request-related errors.
- `404`: The category was not found.

---

[API](https://skmtc.dev/finalpos/apis/final-pos-public-api.md) · [All operations](https://skmtc.dev/finalpos/apis/final-pos-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/finalpos/apis/final-pos-public-api/revisions/6a6842dcb479?raw)