---
title: "POST /v3/mods/highlights"
method: POST
path: "/v3/mods/highlights"
tags: ["Mods"]
---

# POST /v3/mods/highlights

`POST /v3/mods/highlights`

## Request body

- GetHighlightsFeaturedRequest
  - `gameId` integer
  - `excludedModIds` integer[]
  - `filters` HighlightsFilters
    - `carousel` boolean
    - `banners` boolean
    - `categories` boolean
    - `themePages` boolean
    - `latest` boolean
    - `mostDownloaded` boolean
    - `premium` boolean
    - `trending` boolean
    - `modSquadPicksModIds` boolean
    - `communityPicksModIds` boolean

## Response `200`

- ApiResponseOfHomepageHighlightsResponse2
  - `data` HomepageHighlightsResponse2
    - `carousel` CarouselItem[]
      - `mainTitle` string
      - `subTitle` string
      - `mainImageUrl` string
      - `tileImageUrl` string
      - `customTag` string
      - `destination` Destination
        - `type` 1 | 2 — 1 = Mod 2 = Themepage
        - `value` integer
      - `ctaText` string
      - `layout` 0 | 1 | 2 — 0 = Default 1 = SaleView 2 = SmallSaleView
    - `shelves` Shelf[]
      - `displayIndex` integer
      - `type` 0 | 1 | 2 | 3 — 0 = Category 1 = Generated 2 = Custom 3 = Banner
      - `name` string
      - `queryParams` QueryParams
        - `classId` integer, nullable
        - `premiumStatus` 0 | 1 | 2 — 0 = All 1 = Premium 2 = Free
        - `categoryIds` integer[]
        - `sortingOption` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — 1 = Featured 2 = Popularity 3 = LastUpdated 4 = Name 5 = Author 6 = TotalDownloads 7 = Category 8 = GameVersion 9 = EarlyAccess 10 = FeaturedReleased 11 = ReleasedDate 12 = Rating 13 = Relevancy
        - `sortingOrder` 'asc' | 'desc'
      - `content` ShelfContent
        - `mods` HighlightsModDto[]
          - `id` integer
          - `logo` ModAsset
            - `id` integer
            - `modId` integer
            - `title` string
            - `description` string
            - `thumbnailUrl` string
            - `url` string
          - `name` string
          - `authors` ModAuthor[]
            - `id` integer
            - `name` string
            - `url` string
            - `avatarUrl` string
          - `ratingDetails` RatingDetails
            - `rating` number, nullable
            - `totalRatings` integer, nullable
            - `positiveRatings` integer, nullable
            - `score` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 — 0 = NotEnoughReviews 1 = OverwhelminglyPositive 2 = VeryPositive 3 = Positive 4 = MostlyPositive 5 = Mixed 6 = MostlyNegative 7 = Negative 8 = VeryNegative 9 = OverwhelminglyNegative
          - `downloadCount` integer
          - `fileSize` integer, nullable
        - `categories` Category[]
          - `id` integer — The category id
          - `gameId` integer — The game id related to the category
          - `name` string — Category name
          - `slug` string — The category slug as it appear in the URL
          - `url` string — The category URL
          - `iconUrl` string — URL for the category icon
          - `dateModified` string, date-time — Last modified date of the category
          - `isClass` boolean, nullable — A top level category for other categories
          - `classId` integer, nullable — The class id of the category, meaning - the class of which this category is under
          - `parentCategoryId` integer, nullable — The parent category for this category
          - `displayIndex` integer, nullable — The display index for this category
        - `banner` CarouselItem
          - `mainTitle` string
          - `subTitle` string
          - `mainImageUrl` string
          - `tileImageUrl` string
          - `customTag` string
          - `destination` Destination
            - `type` 1 | 2 — 1 = Mod 2 = Themepage
            - `value` integer
          - `ctaText` string
          - `layout` 0 | 1 | 2 — 0 = Default 1 = SaleView 2 = SmallSaleView
      - `destination` Destination
        - `type` 1 | 2 — 1 = Mod 2 = Themepage
        - `value` integer
      - `seeAllButton` boolean
    - `themePages` ThemePage[]
      - `id` integer
      - `mainTitle` string
      - `subTitle` string
      - `bannerUrl` string
      - `modIds` integer[]

## Other responses

- `500`

---

[API](https://skmtc.dev/curseforge/apis/curseforge-core-api.md) · [All operations](https://skmtc.dev/curseforge/apis/curseforge-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/curseforge/curseforge-core-api/revisions/7c05a23c8394/schema)