VIvibes
Incentive Pool API

Get code pool info

get/companies/{company_key}/incentives/pools/{incentive_pool_id}

Request

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

Path parameters

company_keystring required
incentive_pool_idstring required

Headers

X-API-Versionstring
Content-Typestring required

Response

Successful response

idinteger

Vibes unique identifier for each incentive pool.

namestring

The name of the incentive pool.

issuance_allowedboolean

Indicates whether codes are currently allowed to be issued from this code pool.

redemption_allowedboolean

Indicates whether codes from this code pool are currently allowed to be redeemed.

notification_email_addressstring

The email address you'd like notifications about this code pool to be send to.

created_atstring

The date this pool was created in ISO-8601 format.

updated_atstring

The date this pool was last updated in ISO-8601 format.

urlstring

Changes

No recorded changes to this operation across all 2 revisions of this API.