> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/partner-api-reference/partner-v15/reference/promo-codes/promo-codes.md).

# Promo Codes

Endpoints for listing and retrieving brand-issued promo codes available to your partner account.

## List Promo Codes

> Returns the promo codes available to your partner account. Supports filtering by program, advertiser, deal, credit rule, match mode, and creation date range.

```json
{"openapi":"3.1.0","info":{"title":"Partner Promo Codes API","version":"15"},"tags":[{"name":"Promo Codes","description":"Endpoints for listing and retrieving brand-issued promo codes available to your partner account."}],"servers":[{"url":"https://api.impact.com","description":"Production server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"CreditRule":{"type":"string","enum":["ALWAYS","INVOLVED","WINNER"],"description":"When the partner is credited for a conversion that used this code.\n\n- `ALWAYS`: The partner is always credited.\n- `INVOLVED`: Credited only when involved in the click path leading to the sale.\n- `WINNER`: Credited only when the partner drove the last click before the sale.\n"},"MatchMode":{"type":"string","enum":["LI","RE"],"description":"How the promo code value is matched against codes used at checkout.\n\n- `LI`: Literal — the code must match exactly.\n- `RE`: Regex — the code is interpreted as a regular expression.\n"},"PromoCode":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier assigned to the promo code."},"Code":{"type":"string","description":"The alphanumeric string customers enter at checkout to redeem the offer."},"State":{"type":"string","enum":["ACTIVE","FUTUREDATE","EXPIRED"],"description":"Current state of the promo code."},"Program":{"type":"object","description":"The brand program this promo code belongs to.","properties":{"Id":{"type":"string","description":"Unique identifier for the program."},"Name":{"type":"string","description":"Display name of the program."},"Uri":{"type":"string","description":"API resource path for this program."},"LogoUri":{"type":"string","description":"API resource path to the program's logo image."}}},"Advertiser":{"type":"object","description":"The brand (advertiser) that issued this promo code.","properties":{"Id":{"type":"string","description":"Unique identifier for the advertiser."},"Name":{"type":"string","description":"Display name of the advertiser."},"Uri":{"type":"string","description":"API resource path for this advertiser."},"LogoUri":{"type":"string","description":"API resource path to the advertiser's logo image."}}},"Deal":{"type":"object","description":"The deal this promo code is associated with, if any.","properties":{"Id":{"type":"string","description":"Unique identifier for the deal."},"Name":{"type":"string","description":"Display name of the deal."},"Uri":{"type":"string","description":"API resource path for this deal."}}},"MatchMode":{"$ref":"#/components/schemas/MatchMode"},"CreditRule":{"$ref":"#/components/schemas/CreditRule"},"CreatedDate":{"type":"string","format":"date-time","description":"Date and time the promo code was created (ISO 8601)."},"StartDate":{"type":"string","format":"date-time","description":"Date and time the promo code becomes active (ISO 8601). Only returned when the code is scheduled with a start date."},"EndDate":{"type":"string","format":"date-time","description":"Date and time the promo code expires (ISO 8601). Only returned when the code is scheduled with an end date."},"Uri":{"type":"string","format":"uri","description":"API resource path for this promo code."}}}}},"paths":{"/Mediapartners/{AccountSID}/PromoCodes":{"get":{"summary":"List Promo Codes","description":"Returns the promo codes available to your partner account. Supports filtering by program, advertiser, deal, credit rule, match mode, and creation date range.","operationId":"listPromoCodes","tags":["Promo Codes"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the partner account."},{"name":"SearchString","in":"query","description":"Free-text search across all promo code fields.","schema":{"type":"string"}},{"name":"ProgramId","in":"query","description":"Filter by one or more program IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"AdvertiserId","in":"query","description":"Filter by one or more advertiser (brand) IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"DealId","in":"query","description":"Filter by one or more deal IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"CreditRule","in":"query","description":"Filter by credit policy.","schema":{"type":"array","items":{"$ref":"#/components/schemas/CreditRule"}}},{"name":"MatchMode","in":"query","description":"Filter by code matching type.","schema":{"type":"array","items":{"$ref":"#/components/schemas/MatchMode"}}},{"name":"CreatedDateStart","in":"query","description":"Return only codes created on or after this date/time (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"CreatedDateEnd","in":"query","description":"Return only codes created on or before this date/time (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"StartDateStart","in":"query","description":"Return only promo codes whose `StartDate` is on or after this date/time (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"StartDateEnd","in":"query","description":"Return only promo codes whose `StartDate` is on or before this date/time (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"EndDateStart","in":"query","description":"Return only promo codes whose `EndDate` is on or after this date/time (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"EndDateEnd","in":"query","description":"Return only promo codes whose `EndDate` is on or before this date/time (ISO 8601).","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A list of promo code objects.","content":{"application/json":{"schema":{"type":"object","properties":{"PromoCodes":{"type":"array","items":{"$ref":"#/components/schemas/PromoCode"}}}}}}}}}}}}
```

## Retrieve a Promo Code

> Returns the full details of a single promo code by its unique Id.

```json
{"openapi":"3.1.0","info":{"title":"Partner Promo Codes API","version":"15"},"tags":[{"name":"Promo Codes","description":"Endpoints for listing and retrieving brand-issued promo codes available to your partner account."}],"servers":[{"url":"https://api.impact.com","description":"Production server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"PromoCode":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier assigned to the promo code."},"Code":{"type":"string","description":"The alphanumeric string customers enter at checkout to redeem the offer."},"State":{"type":"string","enum":["ACTIVE","FUTUREDATE","EXPIRED"],"description":"Current state of the promo code."},"Program":{"type":"object","description":"The brand program this promo code belongs to.","properties":{"Id":{"type":"string","description":"Unique identifier for the program."},"Name":{"type":"string","description":"Display name of the program."},"Uri":{"type":"string","description":"API resource path for this program."},"LogoUri":{"type":"string","description":"API resource path to the program's logo image."}}},"Advertiser":{"type":"object","description":"The brand (advertiser) that issued this promo code.","properties":{"Id":{"type":"string","description":"Unique identifier for the advertiser."},"Name":{"type":"string","description":"Display name of the advertiser."},"Uri":{"type":"string","description":"API resource path for this advertiser."},"LogoUri":{"type":"string","description":"API resource path to the advertiser's logo image."}}},"Deal":{"type":"object","description":"The deal this promo code is associated with, if any.","properties":{"Id":{"type":"string","description":"Unique identifier for the deal."},"Name":{"type":"string","description":"Display name of the deal."},"Uri":{"type":"string","description":"API resource path for this deal."}}},"MatchMode":{"$ref":"#/components/schemas/MatchMode"},"CreditRule":{"$ref":"#/components/schemas/CreditRule"},"CreatedDate":{"type":"string","format":"date-time","description":"Date and time the promo code was created (ISO 8601)."},"StartDate":{"type":"string","format":"date-time","description":"Date and time the promo code becomes active (ISO 8601). Only returned when the code is scheduled with a start date."},"EndDate":{"type":"string","format":"date-time","description":"Date and time the promo code expires (ISO 8601). Only returned when the code is scheduled with an end date."},"Uri":{"type":"string","format":"uri","description":"API resource path for this promo code."}}},"MatchMode":{"type":"string","enum":["LI","RE"],"description":"How the promo code value is matched against codes used at checkout.\n\n- `LI`: Literal — the code must match exactly.\n- `RE`: Regex — the code is interpreted as a regular expression.\n"},"CreditRule":{"type":"string","enum":["ALWAYS","INVOLVED","WINNER"],"description":"When the partner is credited for a conversion that used this code.\n\n- `ALWAYS`: The partner is always credited.\n- `INVOLVED`: Credited only when involved in the click path leading to the sale.\n- `WINNER`: Credited only when the partner drove the last click before the sale.\n"}}},"paths":{"/Mediapartners/{AccountSID}/PromoCodes/{Id}":{"get":{"summary":"Retrieve a Promo Code","description":"Returns the full details of a single promo code by its unique Id.","operationId":"retrievePromoCode","tags":["Promo Codes"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the partner account."},{"name":"Id","in":"path","required":true,"description":"The unique identifier assigned to the promo code.","schema":{"type":"string"}}],"responses":{"200":{"description":"A single promo code object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromoCode"}}}},"404":{"description":"No promo code exists with the supplied Id."}}}}}}
```


---

# 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://integrations.impact.com/partner-api-reference/partner-v15/reference/promo-codes/promo-codes.md?ask=<question>&goal=<endgoal>
```

`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.