---
title: "listCampaignPromoCodes"
method: GET
path: "/campaigns/{campaign}/promo-codes"
tags: ["Promo Code"]
---

# listCampaignPromoCodes

`GET /campaigns/{campaign}/promo-codes`

Retrieves a list of all Promo Codes made for the specified Campaign

## Path parameters

- `campaign` integer, required

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

Success

- object
  - `current_page` integer — Index of current page
  - `data` object[] — Collection of Promo Codes
    - `adjustment_amount` number, double — Value to configure price adjustment when applied against an Item. Can reflect either a percentage or flat amount based on associated adjustment_type
    - `adjustment_type` 'percentage' | 'amount' — Specification of how adjustment_amount is applied
    - `applications_count` integer — Count of the number of times the promo code has been applied to Items still in a Cart or successfully transacted against
    - `code` string — Value of the Promo Code to entered on checkout
    - `ends_at` string, date-time, nullable — Date/time when the Promo Code can no longer be applied to purchases
    - `id` integer — Primary identifier of record
    - `is_active` boolean — Indicates whether Promo Code is active or not regardless of availability or date range
    - `is_general` boolean — Indicates whether Promo Code has a general designation, meaning it applies to all TicketTypes for its Campaign
    - `quantity` integer, nullable — Total number of Items against which the Promo Code can be applied (null implies unlimited applications)
    - `starts_at` string, date-time, nullable — Date/time when record can start being applied to purchase
    - `updated_at` string, date-time — Date/time of last record update
    - `campaign_id` integer
  - `first_page_url` string, nullable — URL of first page of results
  - `from` integer, nullable — Index of first displayed result within total result set
  - `last_page` integer — Index of last page in result set
  - `last_page_url` string, nullable — {host}/campaigns/227362/promo-codes?page=1
  - `next_page_url` string, nullable — URL of next page of results
  - `path` string, nullable — {host}/campaigns/227362/promo-codes
  - `per_page` integer — Maximum number of records returned per page of results
  - `prev_page_url` string, nullable — URL of previous page of results
  - `links` PaginationLink[] — Collection of objects representing pages {label, URL, active} that can be used to request the associated page of records.
    - `label` string — Identifier of the page.
    - `url` string, nullable — URL that can be used to fetch associated page of records.
    - `active` boolean — Identifies whether the previously requested page matches the page this link object references.
  - `to` integer, nullable — Index of last displayed result within total result set
  - `total` integer — Total count of records in result set

## Other responses

- `403` — Requester is not authorized to perform action
- `404` — Campaign not found

---

[API](https://skmtc.net/gofundme/apis/gofundme-pro-api.md) · [All operations](https://skmtc.net/gofundme/apis/gofundme-pro-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gofundme/gofundme-pro-api/revisions/d22bb925eeed/schema)
