---
title: "Returns all recommendations"
method: GET
path: "/recommendation"
tags: ["Recommendation"]
---

# Returns all recommendations

`GET /recommendation`

## Request

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

## Query parameters

- `limit` integer
- `offset` integer
- `types` RecommendationTypeApiModel[]
- `searchTerm` string
- `groupKeys` string[]
- `isBuilderComponent` boolean

## Response `200`

OK

- RecommendationListApiModel: Paginated collection of recommendations.
  - `Total` integer, nullable, required: The total number of records which can be retrieved. Note that this field is not available for all paginated endpoints.
  - `Records` RecommendationSummaryApiModel[], required: The retrieved records.
    - `RecommendationId` integer: Recommendation identifier.
    - `Type` 'Featured' | 'Manual' | 'UpCrossSelling' | 'FrequentlyBoughtTogether': Enum representing the types of Recommendation.
    - `Name` string: Name of the recommendation.
    - `GroupKeys` string[]: Group keys associated with the recommendation.
    - `IsBuilderComponent` boolean: Indicates whether the recommendation is enabled for the builder.

## Other responses

- `400`: Bad Request

---

[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)