---
title: "List all deals"
method: GET
path: "/Advertisers/{AccountSID}/Deals"
tags: ["Deals"]
---

# List all deals

`GET /Advertisers/{AccountSID}/Deals`

## Request

- Base URL: `https://api.impact.com`
- URL: `https://api.impact.com/Advertisers/{AccountSID}/Deals`
- Auth: none declared
- TypeScript: <https://skmtc.dev/impact/apis/brand-api-account-information/docs/Advertisers/:AccountSID/Deals/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `AccountSID` string, required

## Query parameters

- `CampaignId` integer
- `Scope` 'PRODUCT' | 'CATEGORY' | 'ENTIRE_STORE'
- `State` 'ACTIVE' | 'EXPIRED' | 'PENDING'
- `Type` 'GENERAL_SALE' | 'FREE_SHIPPING' | 'GIFT_WITH_PURCHASE' | 'REBATE' | 'BOGO'

## Response `200`

OK

- object
  - `Deals` Deal[]: The list of deal objects.
    - `Id` string: The unique identifier for the deal.
    - `Name` string: The display name of the deal.
    - `CampaignId` string: The unique identifier of the campaign the deal belongs to.
    - `State` 'ACTIVE' | 'EXPIRED' | 'PENDING': The current state of the deal.
    - `Type` 'GENERAL_SALE' | 'FREE_SHIPPING' | 'GIFT_WITH_PURCHASE' | 'REBATE' | 'BOGO': The type of deal — what it offers.
    - `Scope` 'CATEGORY' | 'ENTIRE_STORE' | 'PRODUCT': What the deal applies to (a category, the entire store, or a specific product).
    - `Description` string: A description of the deal that may be shown to partners.
    - `StartDate` string, date-time: The date and time the deal becomes active.
    - `EndDate` string, date-time: The date and time the deal expires.
    - `Categories` string: Comma-separated list of categories the deal applies to, when `Scope` is `CATEGORY`.
    - `BogoBuyQuantity` integer: Quantity the customer must buy in a BOGO deal.
    - `BogoBuyScope` string: Whether the "buy" requirement is a specific product or category in a BOGO deal.
    - `BogoBuyName` string: Name of the item the customer must buy in a BOGO deal.
    - `BogoBuyImageUrl` string, uri: If `Type` is `BOGO`, the "buy" product image URL.
    - `BogoGetQuantity` integer: Quantity the customer receives in a BOGO deal.
    - `BogoGetScope` string: Whether the "get" item is a specific product or category in a BOGO deal.
    - `BogoGetDiscountType` string: How the discount on the "get" item is calculated in a BOGO deal.
    - `BogoGetName` string: Name of the item the customer receives in a BOGO deal.
    - `BogoGetImageUrl` string, uri: If `Type` is `BOGO`, the "get" product image URL.
    - `BogoGetDiscountAmount` number: Flat discount amount on the "get" item in a BOGO deal.
    - `BogoGetDiscountCurrency` string: Currency code for the BOGO get discount amount (ISO 4217).
    - `BogoGetDiscountPercent` number, float: Discount percentage on the "get" item in a BOGO deal.
    - `PurchaseLimitQuantity` integer: Maximum number of times the deal can be applied per order.
    - `DateCreated` string, date-time: Date the deal was created.
    - `DateLastUpdated` string, date-time: Date the deal was last updated.
    - `DiscountType` 'FIXED' | 'PERCENT' | 'PERCENT_RANGE' | 'PERCENT_MAXIMUM': How the discount is calculated.
    - `DiscountAmount` string: The flat discount amount, when DiscountType is FIXED.
    - `DiscountMaximumPercent` number, float: Maximum discount percentage, when `DiscountType` is `PERCENT_MAXIMUM`.
    - `DiscountPercentRangeStart` number, float: Lower bound of the discount range, when `DiscountType` is `PERCENT_RANGE`.
    - `DiscountPercentRangeEnd` number, float: Upper bound of the discount range, when `DiscountType` is `PERCENT_RANGE`.
    - `DiscountCurrency` string: Three-letter ISO 4217 currency code for the discount amount.
    - `MinimumPurchaseAmount` number: Minimum amount the consumer needs to spend for the deal to apply.
    - `MinimumPurchaseAmountCurrency` string: Currency of the deal's minimum purchase amount (ISO 4217).
    - `MaximumSavingsAmount` number: Maximum amount a consumer can save when the deal applies.
    - `MaximumSavingsCurrency` string: Currency of the deal's maximum savings (ISO 4217).
    - `DiscountPercent` string: The discount percentage, when DiscountType is PERCENT.
    - `Gift` string: Gift offered, when `Type` is `GIFT_WITH_PURCHASE`.
    - `RebateAmount` number: Rebate amount, when `Type` is `REBATE`.
    - `RebateCurrency` string: Currency of the rebate amount (ISO 4217).
    - `DefaultPromoCode` string: Default promo code partners can promote for this deal.
    - `Products` object[]: The products this deal applies to, when Scope is PRODUCT.
      - `ProductName` string: The name of the product.
      - `ProductImageURL` string: URL of the product image.
      - `ProductBeforePriceAmount` string: The product's price before the deal is applied.
      - `ProductAfterPriceAmount` string: The product's price after the deal is applied.
    - `Uri` string, uri-reference: The unique reference to this deal in the impact.com API.

---

[API](https://skmtc.dev/impact/apis/brand-api-account-information.md) - [All operations](https://skmtc.dev/impact/apis/brand-api-account-information/llms.txt) - [OpenAPI document](https://skmtc.dev/impact/apis/brand-api-account-information/revisions/c53422ebb833?raw)