# Get list of promo code promotions

Gets the list of promo codes of a project.

Endpoint: GET /v3/project/{project_id}/admin/promocode
Version: 2.0.0
Security: basicAuth

## Path parameters:

  - `project_id` (integer, required)
    Project ID. You can find this parameter in your Publisher Account next to the name of the project.
    Example: 44056

## Query parameters:

  - `limit` (integer)
    Limit for the number of elements on the page.
    Example: 50

  - `offset` (integer)
    Number of the element from which the list is generated (the count starts from 0).

## Response 200 fields (application/json):

  - `items` (array)

  - `items.external_id` (string)
    Unique promotion ID. The external_id may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.
    Example: "coupon_external_id"

  - `items.promotion_periods` (array)
    Promotion validity periods. If multiple periods are specified, both date_from and date_until are required.

  - `items.promotion_periods.date_from` (string, required)
    Start date for the specified promotion.
    Example: "2020-08-11T10:00:00+03:00"

  - `items.promotion_periods.date_until` (string,null)
    End date for the specified promotion. If set to null, the promotion is indefinite. Can be null only if a single validity period is specified.
    Example: "2020-08-11T20:00:00+03:00"

  - `items.name` (object)
    Name of promotion. Should contain key/value pairs
where key is a locale with "^[a-z]{2}-[A-Z]{2}$" format, value is string.
    Example: {"en-US":"Coupon title","de-DE":"Gutscheintitel"}

  - `items.bonus` (array,null)

  - `items.bonus.sku` (string)
    Item SKU.

  - `items.bonus.quantity` (number)
    Item quantity.

  - `items.is_enabled` (boolean)

  - `items.redeem_total_limit` (integer,null)
    Limits total numbers of coupons.
    Example: 10

  - `items.redeem_user_limit` (integer,null)
    Limits total numbers of coupons redeemed by single user.
    Example: 10

  - `items.redeem_code_limit` (integer,null)
    Number of redemptions per code.
    Example: 10

  - `items.discount` (object,null)
    Example: {"discount":{"percent":"10.99"}}

  - `items.discount.percent` (string,null)
    Percent discount.
The price of cart will be decreased using a value calculated by using this percent and then rounded to 2 decimal places.
    Example: "10.00"

  - `items.discounted_items` (array,null)
    List of items that are discounted by a promo code.

  - `items.total_limit_state` (object,null)
    Limits for each unique promo code.

  - `items.total_limit_state.available` (integer)
    The remaining number of times a promo code can be used.
    Example: 3

  - `items.total_limit_state.reserved` (integer)
    The reserved number of a promo code.
    Example: 3

  - `items.total_limit_state.used` (integer)
    The number of times a promo code is used.
    Example: 5

  - `items.attribute_conditions` (array)
    Conditions for validating user attributes.
Determine promotion availability based on whether user attributes match all specified conditions.

  - `items.price_conditions` (array,null)
    Array of objects with conditions that set the price range for applying the promotion to the entire cart.
The total price of all items in the user's cart is compared with the price range specified in the condition. [Bonuses](/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request) and [discounts](/api/shop-builder/operation/create-promo-code/#!path=discount&t=request) are applied to all items in the cart if the price of the cart meets the specified condition.
If you pass this array, set the value of the [discounted_items](/api/shop-builder/operation/create-promo-code/#!path=discounted_items&t=request) array to null.

  - `items.price_conditions.operator` (string, required)
    Comparison operator for setting the price range for applying the promotion.
    Enum: "ge", "gt", "le", "lt", "eq", "ne"

  - `items.price_conditions.value` (string, required)
    Value for determining the price range for applying the promotion.

  - `items.item_price_conditions` (array,null)
    Array of objects with conditions that set the price range for applying the promotion to certain items in the cart.
The price of each item in the user's cart is compared with the price range specified in the condition. [Bonuses](/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request) and [discounts](/api/shop-builder/operation/create-promo-code/#!path=discount&t=request) are applied only to those items in the cart whose price meets the condition.
If you pass this array, set the value of the [discounted_items](/api/shop-builder/operation/create-promo-code/#!path=discounted_items&t=request) array to null.

  - `items.excluded_promotions` (array)
    List of promotion IDs to exclude when applying this promotion. Example: [12, 789]
    Example: [12,789]

  - `total_promotions_count` (integer)
    Total number of promotions.

  - `active_promotions_count` (integer)
    Number of active promotions.

  - `inactive_promotions_count` (integer)
    Number of deactivated promotions.

## Response 401 fields (application/json):

  - `statusCode` (integer)
    Example: 401

  - `errorCode` (integer)
    Example: 1020

  - `errorMessage` (string)
    Example: "[0401-1020]: Error in Authentication method occurred"