> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/partner/es/suggested-search-term-api/suggestedsearchterm/listsuggestedsearchterms.md). # Obtener términos de búsqueda sugeridos ## Retrieve 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. ```json {"openapi":"3.0.0","info":{"title":"Citrus Suggested Search Term API","version":"v3"},"tags":[],"servers":[{"url":"https://campaign..citrusad.com"}],"paths":{"/v3/suggested-search-terms":{"get":{"description":"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.","operationId":"listSuggestedSearchTerms","parameters":[{"description":"Use this token to paginate through the list of suggested terms. Pass it in subsequent requests to continue from where the previous call left off.","in":"query","name":"pageToken","required":false,"schema":{"type":"string"}},{"description":"Specify the number of suggested search terms to be returned per page.","in":"query","name":"pageSize","required":false,"schema":{"default":"20","format":"int64","type":"string"}},{"description":"Filter the suggested search terms by the specified catalog ID.","in":"query","name":"catalogId","required":true,"schema":{"type":"string"}},{"description":"Filter the suggested search terms by the specified product code.","in":"query","name":"productCode","required":false,"schema":{"type":"string"}},{"description":"Filter suggested search terms by selecting a specific search term type. You can choose from the following search term types: SEARCH_TERM_TYPE_ORGANIC, SEARCH_TERM_TYPE_CROSS_SELL, or SEARCH_TERM_TYPE_SUBSTITUTE.","explode":true,"in":"query","name":"searchTermTypes","required":false,"schema":{"items":{"enum":["SEARCH_TERM_TYPE_ORGANIC","SEARCH_TERM_TYPE_CROSS_SELL","SEARCH_TERM_TYPE_SUBSTITUTE"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/campaignv3ListSuggestedSearchTermsResponse"}}},"description":"A list of suggested search terms and a pagination token."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"There was a problem with input."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Login failed or token not valid."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Access denied due to insufficient permissions."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"An unexpected error response."}},"summary":"Retrieve suggested search terms","tags":["SuggestedSearchTerm"]}}},"components":{"schemas":{"campaignv3ListSuggestedSearchTermsResponse":{"properties":{"nextPageToken":{"description":"The page token to request the next page in pagination. Include it as \"pageToken\" in the request.","type":"string"},"suggestedSearchTerms":{"description":"The list of suggested search terms based on provided criteria.","items":{"$ref":"#/components/schemas/campaignv3SuggestedSearchTerm"},"type":"array"},"totalCount":{"description":"The total number of suggested search terms matching the provided criteria.","format":"int64","type":"string"}},"type":"object"},"campaignv3SuggestedSearchTerm":{"properties":{"catalogId":{"description":"The unique identifier of the retailer's catalog.","type":"string"},"collectionName":{"description":"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.","type":"string"},"id":{"readOnly":true,"type":"string"},"phrase":{"description":"The suggested search term for the product.","type":"string"},"productCode":{"description":"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.","type":"string"},"rank":{"description":"The rank of the suggested search term. Retailer defines the rank of the search term for the product, with 1 being the highest rank.","format":"int64","type":"string"},"searchTermType":{"$ref":"#/components/schemas/campaignv3SearchTermType"}},"type":"object"},"campaignv3SearchTermType":{"default":"SEARCH_TERM_TYPE_ORGANIC","enum":["SEARCH_TERM_TYPE_ORGANIC","SEARCH_TERM_TYPE_CROSS_SELL","SEARCH_TERM_TYPE_SUBSTITUTE"],"type":"string"},"rpcStatus":{"properties":{"code":{"format":"int32","type":"integer"},"details":{"items":{"$ref":"#/components/schemas/protobufAny"},"type":"array"},"message":{"type":"string"}},"type":"object"},"protobufAny":{"additionalProperties":{},"properties":{"@type":{"type":"string"}},"type":"object"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.citrusad.com/retail-media-interface/partner/es/suggested-search-term-api/suggestedsearchterm/listsuggestedsearchterms.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.