List all promo codes

This endpoint retrieves a paginated list of promo codes for the specified partner account, supporting filtering by search string, program ID, sorting options, and pagination controls.

Query Parameters

Parameter	Type	Required	Description	Example
`SearchString`	string	No	Search phrase across all promo codes.	`summer`
`ProgramId`	array[integer]	No	Filter by one or more program IDs.	`[6554, 9786]`
`AdvertiserId`	array[integer]	No	Filter by one or more advertiser IDs.	`[2456, 36646]`
`DealId`	array[integer]	No	Filter by one or more deal IDs.	`[5867, 47834]`
`CreditRule`	array[string]	No	Allowed values: `ALWAYS`, `INVOLVED`, `WINNER`	`["ALWAYS","WINNER"]`
`MatchMode`	array[string]	No	Allowed values: `LI` (Exact match) `RE` (Regex match)	`["RE"]`
`CreatedDateStart`	string (ISO8601)	No	Filter promo codes created after this date/time (inclusive).	`2024-07-19T17:46:44+02:00`
`CreatedDateEnd`	string (ISO8601)	No	Filter promo codes created before this date/time (inclusive).	`2024-08-19T17:46:44+02:00`
`StartDateStart`	string (ISO8601)	No	Filter promo codes that start after this date/time (inclusive).	`2024-07-20T00:00:00+02:00`
`StartDateEnd`	string (ISO8601)	No	Filter promo codes that start before this date/time (inclusive).	`2024-07-19T23:59:59+02:00`
`EndDateStart`	string (ISO8601)	No	Filter promo codes that end after this date/time (inclusive).	`2024-08-20T00:00:00+02:00`
`EndDateEnd`	string (ISO8601)	No	Filter promo codes that end before this date/time (inclusive).	`2024-08-19T23:59:59+02:00`
`PageSize`	int	No	Number of promo codes per page (default 100). Allowed: 50–1000.	`60`
`Page`	int	No	Page number to return (starting at 1).	`2`
`SortBy`	string	No	Field to sort results by (any filter param can be used).	`ProgramId`
`SortOrder`	enum	No	Sort direction. Allowed values: `ASC`, `DESC`.	`ASC`

Match Mode for Promo Codes

Mode	Description
`LI`	Exact match - The promo code must match exactly as entered in the platform to be tracked
`RE`	Regex match - The promo code can match a regular expression, allowing for flexibility with case and spacing

Credit Rules for Promo Codes

Mode	Description
`ALWAYS`	Always credit - The assigned partner will always be credited with the sale.
`INVOLVED`	Credit if involved - The partner will be credited if they were involved in the sale.
`WINNER`	Credit if winner - The partner will be credited only if they drive the last click.

Returns

Returns a list of promo codes according to the specified search, filters, sorting, and pagination parameters.

Example request

curl 'https://api.impact.com/Mediapartners/{AccountSID}/PromoCodes' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -G

Example response

{
  "@page": 1,
  "@numpages": 1,
  "@pagesize": 100,
  "@total": 2,
  "@start": 0,
  "@end": 1,
  "@uri": "/Mediapartners/{AccountSID}/PromoCodes?Page=1&SearchString=summer",
  "@firstpageuri": "/Mediapartners/{AccountSID}/PromoCodes?Page=1",
  "@previouspageuri": "",
  "@nextpageuri": "",
  "@lastpageuri": "/Mediapartners/{AccountSID}/PromoCodes?Page=1",

  "PromoCodes": [
    {
      "Id": 3467,
      "Code": "summer2026",
      "Uri": "/Mediapartners/{AccountSID}/Programs/688",
      "State": "ACTIVE",
      "Program": {
        "Id": 3646,
        "Name": "Summer Savings Program",
        "LogoUri": "/Mediapartners/{AccountSID}/Programs/summer_logo.png",
        "Uri": "/Mediapartners/{AccountSID}/Programs/summer_savings"
      },
      "Advertiser": {
        "Id": 2320,
        "Name": "SummerStyle Co.",
        "Uri": "/Mediapartners/{AccountSID}/Advertisers/summerstyle"
      },
      "MatchMode": "RE",
      "CreditRule": "INVOLVED",
      "CreatedDate": "2025-06-03T10:15:00+02:00",
      "StartDate": "2025-06-05T00:00:00+02:00",
      "EndDate": "2025-09-30T23:59:59+02:00"
    },
    {
      "Id": 3470,
      "Code": "SUMMERDEAL25",
      "Uri": "/Mediapartners/{AccountSID}/Programs/689",
      "State": "ACTIVE",
      "Program": {
        "Id": 3647,
        "Name": "Endless Summer Rewards",
        "LogoUri": "/Mediapartners/{AccountSID}/Programs/endless_summer_logo.png",
        "Uri": "/Mediapartners/{AccountSID}/Programs/endless_summer"
      },
      "Advertiser": {
        "Id": 2321,
        "Name": "SummerSun Apparel",
        "Uri": "/Mediapartners/{AccountSID}/Advertisers/summersun"
      },
      "MatchMode": "RE",
      "CreditRule": "INVOLVED",
      "LI": "TRUE",
      "WINNER": "FALSE",
      "CreatedDate": "2025-07-10T09:00:00+02:00",
      "StartDate": "2025-07-15T00:00:00+02:00",
      "EndDate": "2025-12-20T18:30:00+02:00"
    }
  ]
}