---
updatedAt: 2026-08-13T23:51:37.000Z
---

# Get a bid modifier by ID

Get a bid modifier by ID.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Core API Resources",
    "version": "2.0.0",
    "description": "Buzz API v2"
  },
  "paths": {
    "/bid-modifiers/{id}": {
      "get": {
        "operationId": "bid_modifiers_retrieve",
        "description": "Get a bid modifier by ID.",
        "summary": "Get a bid modifier by ID",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "string"
            },
            "description": "Bid Modifier ID",
            "required": true
          }
        ],
        "tags": [
          "Bid Modifiers"
        ],
        "security": [
          {
            "nestSessionAuth": []
          },
          {
            "nestBasicAuth": []
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BidModifier"
                }
              }
            },
            "description": ""
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "BidModifier": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "readOnly": true,
            "description": "The ID of the Bid Modifier to GET"
          },
          "terms": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BidModifierTermV2"
            },
            "description": "Refer to the [Bid Modifiers guide](https://docs.beeswax.com/v2.0/docs/bid-modifiers) for more information on Bid Modifier Terms."
          },
          "create_date": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "The date and time the object was first created",
            "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
            "example": "2025-09-29 00:00:00"
          },
          "update_date": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "The date and time the object was last updated",
            "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
            "example": "2025-09-29 00:00:00"
          },
          "active": {
            "type": "boolean",
            "default": true
          },
          "alternative_id": {
            "type": "string",
            "nullable": true,
            "description": "An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.",
            "maxLength": 200
          },
          "notes": {
            "type": "string",
            "nullable": true,
            "description": "Free-form notes of up to 255 characters.",
            "maxLength": 255
          },
          "name": {
            "type": "string",
            "description": "Name of the Bid Modifier, e.g. \"Video complete modifier\"",
            "maxLength": 191
          },
          "account_id": {
            "type": "integer",
            "description": "Defaults to the account in the active session"
          },
          "advertiser_id": {
            "type": "integer",
            "nullable": true,
            "description": "The ID of the Advertiser, if set"
          },
          "bid_model_id": {
            "type": "integer",
            "description": "The ID of the Bid Model associated with this Bid Modifier",
            "nullable": true
          }
        },
        "required": [
          "account_id",
          "create_date",
          "id",
          "name",
          "terms",
          "update_date"
        ]
      },
      "BidModifierTermV2": {
        "type": "object",
        "properties": {
          "recency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TargetingRecency"
              }
            ],
            "nullable": true
          },
          "comparator": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ComparatorEnum"
              }
            ],
            "description": "The method for comparing the defined value against the incoming bid request to determine a match (i.e. equals, in_range, boolean)\n\n* `equals` - Equals\n* `in_range` - In Range\n* `boolean_expression` - Boolean"
          },
          "multiplier": {
            "type": "string",
            "format": "decimal",
            "pattern": "^-?\\d{0,3}(?:\\.\\d{0,2})?$",
            "description": "The amount to multiply the bid price by."
          },
          "override_multiplier": {
            "type": "boolean"
          },
          "targeting_key": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TargetingKeyEnum"
              }
            ],
            "description": "The targeting key e.g. country\n\n* `ad_position` - Ad Position\n* `ad_size` - Ad Size\n* `ads_txt` - Ads Txt\n* `app_bundle_list` - App Bundle List\n* `app_id_list` - App ID List\n* `app_name` - App Name\n* `auction_type` - Auction Type\n* `audio_companion_required` - Audio Companion Required\n* `audio_content_genre` - Audio Content Genre\n* `audio_start_delay` - Audio Start Delay\n* `bandwidth` - Bandwidth\n* `browser` - Browser\n* `browser_version` - Browser Version\n* `carrier` - Carrier\n* `city` - City\n* `companion_required` - Companion Required\n* `congressional_district` - Congressional District\n* `content_category` - Content Category\n* `content_genre` - Content Genre\n* `content_rating` - Content Rating\n* `country` - Country\n* `deal_id` - Deal ID\n* `deal_id_list` - Deal ID List\n* `delivery` - Delivery\n* `device_make` - Device Make\n* `device_model` - Device Model\n* `device_screen_size` - Device Screen Size\n* `device_type` - Device Type\n* `domain_list` - Domain List ID\n* `environment_type` - Environment Type\n* `feed` - Feed\n* `interstitial` - Interstitial\n* `interstitial_type` - Interstitial Type\n* `inventory_source` - Inventory Source\n* `ip_address` - IP Address\n* `ipv4_address` - IPv4 address\n* `language` - Language\n* `lat_long_list` - Latitude & Longitude List\n* `lat_long_present` - Latitude & Longitude Present\n* `location_type` - Location Type\n* `metro` - Metro\n* `native_layout` - Native Layout\n* `operating_system` - Operating System\n* `operating_system_version` - Operating System Version\n* `placement` - Placement ID\n* `placement_list` - Placement ID List\n* `playback_method` - Playback Method\n* `player_size` - Player Size\n* `publisher_id` - Publisher ID\n* `publisher_id_list` - Publisher ID List\n* `region` - Region\n* `rewarded` - Rewarded\n* `segment` - Segment\n* `site` - Site ID\n* `site_list` - Site ID List\n* `start_delay` - Video Start Delay\n* `state_house_district` - State House District\n* `state_senate_district` - State Senate District\n* `time_of_week` - Time Of Week\n* `topframe` - Topframe\n* `user_id` - User ID\n* `user_time_of_week` - User Time Of Week\n* `video_api` - Video API\n* `video_placement_type` - Video Placement Type\n* `zip` - Zip\n* `zip_code_list` - Zip Code List"
          },
          "value": {
            "type": "string",
            "description": "The value to match, e.g. USA",
            "maxLength": 1024
          }
        },
        "required": [
          "comparator",
          "multiplier",
          "targeting_key",
          "value"
        ]
      },
      "ComparatorEnum": {
        "enum": [
          "equals",
          "in_range",
          "boolean_expression"
        ],
        "type": "string",
        "description": "* `equals` - Equals\n* `in_range` - In Range\n* `boolean_expression` - Boolean"
      },
      "TargetingKeyEnum": {
        "enum": [
          "ad_position",
          "ad_size",
          "ads_txt",
          "app_bundle_list",
          "app_id_list",
          "app_name",
          "auction_type",
          "audio_companion_required",
          "audio_content_genre",
          "audio_start_delay",
          "bandwidth",
          "browser",
          "browser_version",
          "carrier",
          "city",
          "companion_required",
          "congressional_district",
          "content_category",
          "content_genre",
          "content_rating",
          "country",
          "deal_id",
          "deal_id_list",
          "delivery",
          "device_make",
          "device_model",
          "device_screen_size",
          "device_type",
          "domain_list",
          "environment_type",
          "feed",
          "interstitial",
          "interstitial_type",
          "inventory_source",
          "ip_address",
          "ipv4_address",
          "language",
          "lat_long_list",
          "lat_long_present",
          "location_type",
          "metro",
          "native_layout",
          "operating_system",
          "operating_system_version",
          "placement",
          "placement_list",
          "playback_method",
          "player_size",
          "publisher_id",
          "publisher_id_list",
          "region",
          "rewarded",
          "segment",
          "site",
          "site_list",
          "start_delay",
          "state_house_district",
          "state_senate_district",
          "time_of_week",
          "topframe",
          "user_id",
          "user_time_of_week",
          "video_api",
          "video_placement_type",
          "zip",
          "zip_code_list"
        ],
        "type": "string",
        "description": "* `ad_position` - Ad Position\n* `ad_size` - Ad Size\n* `ads_txt` - Ads Txt\n* `app_bundle_list` - App Bundle List\n* `app_id_list` - App ID List\n* `app_name` - App Name\n* `auction_type` - Auction Type\n* `audio_companion_required` - Audio Companion Required\n* `audio_content_genre` - Audio Content Genre\n* `audio_start_delay` - Audio Start Delay\n* `bandwidth` - Bandwidth\n* `browser` - Browser\n* `browser_version` - Browser Version\n* `carrier` - Carrier\n* `city` - City\n* `companion_required` - Companion Required\n* `congressional_district` - Congressional District\n* `content_category` - Content Category\n* `content_genre` - Content Genre\n* `content_rating` - Content Rating\n* `country` - Country\n* `deal_id` - Deal ID\n* `deal_id_list` - Deal ID List\n* `delivery` - Delivery\n* `device_make` - Device Make\n* `device_model` - Device Model\n* `device_screen_size` - Device Screen Size\n* `device_type` - Device Type\n* `domain_list` - Domain List ID\n* `environment_type` - Environment Type\n* `feed` - Feed\n* `interstitial` - Interstitial\n* `interstitial_type` - Interstitial Type\n* `inventory_source` - Inventory Source\n* `ip_address` - IP Address\n* `ipv4_address` - IPv4 address\n* `language` - Language\n* `lat_long_list` - Latitude & Longitude List\n* `lat_long_present` - Latitude & Longitude Present\n* `location_type` - Location Type\n* `metro` - Metro\n* `native_layout` - Native Layout\n* `operating_system` - Operating System\n* `operating_system_version` - Operating System Version\n* `placement` - Placement ID\n* `placement_list` - Placement ID List\n* `playback_method` - Playback Method\n* `player_size` - Player Size\n* `publisher_id` - Publisher ID\n* `publisher_id_list` - Publisher ID List\n* `region` - Region\n* `rewarded` - Rewarded\n* `segment` - Segment\n* `site` - Site ID\n* `site_list` - Site ID List\n* `start_delay` - Video Start Delay\n* `state_house_district` - State House District\n* `state_senate_district` - State Senate District\n* `time_of_week` - Time Of Week\n* `topframe` - Topframe\n* `user_id` - User ID\n* `user_time_of_week` - User Time Of Week\n* `video_api` - Video API\n* `video_placement_type` - Video Placement Type\n* `zip` - Zip\n* `zip_code_list` - Zip Code List"
      },
      "TargetingRecency": {
        "type": "object",
        "properties": {
          "start": {
            "type": "integer",
            "maximum": 129600,
            "minimum": 0,
            "nullable": true
          },
          "end": {
            "type": "integer",
            "maximum": 129600,
            "minimum": 0,
            "nullable": true
          }
        }
      }
    },
    "securitySchemes": {
      "nestBasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Form-based Basic Authentication"
      },
      "nestSessionAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Form-based Basic Authentication"
      }
    }
  },
  "x-explorer-enabled": false,
  "x-samples-languages": [
    "curl",
    "node",
    "ruby",
    "javascript",
    "python",
    "php",
    "java"
  ],
  "servers": [
    {
      "url": "https://{buzz_key}.api.beeswax.com/rest/v2",
      "variables": {
        "buzz_key": {
          "default": "stingersbx",
          "description": "Unique customer ID assigned by the Beeswax"
        }
      }
    }
  ],
  "x-readme": {
    "apply-endpoint-order": true,
    "apply-tag-changes": true
  }
}
```