---
title: "Retrieve minimum bid details for keywords"
method: POST
path: "/v3/min-bid/keywords"
tags: ["CampaignMinbid"]
---

# Retrieve minimum bid details for keywords

`POST /v3/min-bid/keywords`

Retrieve individual minimum bid details and the overall campaign minimum bid for an array of specified keywords in Search and Category & Search placement type campaigns.

## Request body

- V3RetrieveKeywordsMinBidRequest
  - `teamId` string, required — Specifies the unique identifier for the team associated with the campaign.
  - `catalogIds` string[], required — Specifies the unique identifiers for the retailer's catalogs associated with the campaign. You can specify more than one catalog ID, separated by commas. Ensure that all specified catalog IDs meet the following criteria: - They are not empty and contain products. - They use the same currency (e.g., AUD or USD). - They belong to the same namespace.
  - `keywords` string[], required — Specifies the search keywords for Search and Category & Search placement type campaigns. You can specify up to 1000 search keywords.
  - `namespace` string, required — The unique identifier of the namespace.
  - `placementId` string, required — The unique identifier of the campaign's placement.
  - `campaignType` 'CAMPAIGN_TYPE_DISPLAY' | 'CAMPAIGN_TYPE_BANNER' | 'CAMPAIGN_TYPE_BANNERX' | 'CAMPAIGN_TYPE_WILDCARD', required
  - `retailerTeamId` string — The unique identifier for a retailer-managed team. As a retailer, you can retrieve minimum bid details of the supplier team by specifying the retailerTeamId. Ensure that API requests are authenticated with the retailer's bearer token.

## Response `200`

Provides the minimum bid details for the specified keywords in Search and Category & Search placement type campaigns.

- V3RetrieveKeywordsMinBidResponse
  - `resolvedMinBids` V3ResolvedMinBid[] — List of minimum bid values determined through a hierarchical resolution process during the calculation of the min-bid for a campaign. The system sequentially evaluates each defined level of specificity, starting at the keyword level. If no value exists at this level, the system falls back to the catalog level. In the absence of a catalog-level bid, it further falls back to utilize the value defined at the namespace level. This structured approach ensures that the most specific and applicable bid is identified and applied.
    - `keyword` string — The keyword used for the resolved bid.
    - `catalogId` string — The catalog ID associated with the resolved bid.
    - `namespace` string — The namespace in which the bid is resolved in.
    - `minBid` number, double — The minimum bid resolved at this level.
    - `source` 'MIN_BID_SOURCE_LEVEL_WILDCARD' | 'MIN_BID_SOURCE_LEVEL_KEYWORD' | 'MIN_BID_SOURCE_LEVEL_CATEGORY' | 'MIN_BID_SOURCE_LEVEL_CATALOG' | 'MIN_BID_SOURCE_LEVEL_NAMESPACE' | 'MIN_BID_SOURCE_LEVEL_GLOBAL_DEFAULT' | 'MIN_BID_SOURCE_LEVEL_PLACEMENT'
  - `campaignMinBid` V3CampaignMinBid
    - `minBid` number, double — The final min-bid value for the campaign, which is the maximum value among all the resolved min-bid values.

## 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/revisions/a040003c7378/schema)