List subcategories by category

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

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

Path parameters

categoryIdstring required

Category ID

Response

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

Example response

{
  "parentCategory": {
    "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "createdAt": "2025-12-07T19:31:48.436+00:00",
    "updatedAt": "2025-12-07T19:35:48.436+00:00",
    "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "externalId": "1234567890",
    "name": "Beverages",
    "description": "Beverages are drinks that are not alcoholic.",
    "image": "https://example.com/image.jpg",
    "parentId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "menuOrder": 1,
    "source": "manual"
  },
  "subCategories": [
    {
      "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "createdAt": "2025-12-07T19:31:48.436+00:00",
      "updatedAt": "2025-12-07T19:35:48.436+00:00",
      "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "externalId": "1234567890",
      "name": "Beverages",
      "description": "Beverages are drinks that are not alcoholic.",
      "image": "https://example.com/image.jpg",
      "parentId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "menuOrder": 1,
      "source": "manual"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.