---
title: "Returns a list of promo codes."
method: GET
path: "/rateplan/v0-nsfw/promo-codes/codes"
tags: ["PromoCodes"]
---

# Returns a list of promo codes.

`GET /rateplan/v0-nsfw/promo-codes/codes`

## Request

- Base URL: `https://api.apaleo.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.apaleo.com/rateplan/v0-nsfw/promo-codes/codes`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `rateplans.read-corporate`, `admin`

Returns all existing promo codes that match given criteria.<br>You must have this scope: 'rateplans.read-corporate'.<br>For fine-grained clients, you must have this permission: 'core.promo_codes.read'.

## Query parameters

- `propertyId` string
- `pageNumber` integer
- `pageSize` integer

## Response `200`

A collection of promo codes.

- PromoCodeListModel
  - `promoCodes` PromoCodeModel[], required: List of existing promo codes
    - `code` string, required: The code of special rate or discount or agreement between the hotel and an organization
    - `relatedRateplanIds` string[], required: All rate plan IDs having this code
  - `count` integer, required: Total count of items

## Other responses

- `204`: No codes found.
- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work/revisions/97dec9512a17?raw)