---
title: "Get incentive pools"
method: GET
path: "/companies/{company_key}/incentives/pools"
tags: ["Incentive Pool API"]
---

# Get incentive pools

`GET /companies/{company_key}/incentives/pools`

## Request

- Base URL: `https://public-api.vibescm.com`
- URL: `https://public-api.vibescm.com/companies/{company_key}/incentives/pools`
- Auth: HTTP basic

## Path parameters

- `company_key` string, required

## Response `200`

Successful response

- IncentivePoolResponse[]
  - `id` integer: Vibes unique identifier for each incentive pool.
  - `name` string: The name of the incentive pool.
  - `issuance_allowed` boolean: Indicates whether codes are currently allowed to be issued from this code pool.
  - `redemption_allowed` boolean: Indicates whether codes from this code pool are currently allowed to be redeemed.
  - `incentive_codes` object
    - `total` integer: Total number of incentive codes in the pool.
    - `issued` integer: Total number of incentive codes from the pool that have been issued.
    - `remaining` integer: Number of incentive codes in the pool that are still available to be issued.
    - `low_threshold` integer: Set a number at which you'd like to be notified to add more codes to your pool.
    - `max_charachters` integer: The maximum number of characters allowed in an incentive code in this pool.
  - `distribution` object
    - `method` string: The method of distribution (unique|multi).
  - `notification_email_address` string: The email address you'd like notifications about this code pool to be send to.
  - `created_at` string: The date this pool was created in ISO-8601 format.
  - `updated_at` string: The date this pool was last updated in ISO-8601 format.
  - `url` string

---

[API](https://skmtc.dev/vibes/apis/vibes-platform-api.md) - [All operations](https://skmtc.dev/vibes/apis/vibes-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vibes/apis/vibes-platform-api/revisions/e235838f2e50?raw)