---
title: "Retrieve suggested search terms"
method: GET
path: "/v3/suggested-search-terms"
tags: ["SuggestedSearchTerm"]
---

# Retrieve suggested search terms

`GET /v3/suggested-search-terms`

This endpoint retrieves suggested search terms with options to filter by catalog, product code, and search term type. Results are shown in pages to make them easier to view and manage.

## Query parameters

- `pageToken` string
- `pageSize` string, int64
- `catalogId` string, required
- `productCode` string
- `searchTermTypes` string[]

## Response `200`

A list of suggested search terms and a pagination token.

- Campaignv3ListSuggestedSearchTermsResponse
  - `suggestedSearchTerms` Campaignv3SuggestedSearchTerm[] — The list of suggested search terms based on provided criteria.
    - `id` string
    - `catalogId` string — The unique identifier of the retailer's catalog.
    - `productCode` string — A unique code identifies the product in the retailer's system. This code serves as the product code for which the search term is suggested.
    - `phrase` string — The suggested search term for the product.
    - `rank` string, int64 — The rank of the suggested search term. Retailer defines the rank of the search term for the product, with 1 being the highest rank.
    - `collectionName` string — The collectionName identifies the grouping of suggested search terms. It organizes terms by categories or themes, such as product types or yearly trends. Advertisers can choose collections to access relevant search terms, thereby improving targeting. You maintain full control over the contents of each collection.
    - `searchTermType` 'SEARCH_TERM_TYPE_ORGANIC' | 'SEARCH_TERM_TYPE_CROSS_SELL' | 'SEARCH_TERM_TYPE_SUBSTITUTE'
  - `nextPageToken` string — The page token to request the next page in pagination. Include it as "pageToken" in the request.
  - `totalCount` string, int64 — The total number of suggested search terms matching the provided criteria.

## Other responses

- `400` — There was a problem with input.
- `401` — Login failed or token not valid.
- `403` — Access denied due to insufficient permissions.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/citrusad/apis/citrus-auth-api.md) · [All operations](https://skmtc.net/citrusad/apis/citrus-auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/citrusad/citrus-auth-api/versions/a040003c7378/schema)