Get Redeemable List

get-api2-redeemable-list

Get Redeemable List

Pulls a list of offers available and defined on Punchh, allowing for browsing/selecting of Punchh offers natively in an external platform. Redeemable search is on a business level, and the request can:

Set search limits and order by desc search
Search based on name or segment type filter
Filter based on name or description For more information, see Headless Offers Management - Distribution

To call this API, the option to distribute offers from an external system must be enabled for the business on the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration.

Headers

Content-Type
Type: string
required

application/json
Accept
Type: string
required

application/json
Authorization
Type: string
required

Bearer token for admin authorization, who is making a call on behalf of the customer

Body

application/json

page
Type: integer

Number of pages
per_page
Type: integer

Number of records per page
query
Type: string

Define the search string on the redeemable name and description column

Responses

200
Type: object
description
Type: string

Description of the redeemable

name
Type: string

Name of the redeemable

redeemable_id
Type: integer

ID of the redeemable

redeemable_image_url
Type: string

Image URL for the redeemable

redeemable_uuid
Type: string

UUID of the redeemable
400
Type: object
422
Type: object
errors
Type: object

get/api2/dashboard/redeemables

Show Schema

{
  "redeemable_id": 1,
  "redeemable_uuid": "string",
  "name": "string",
  "description": "string",
  "redeemable_image_url": "string"
}

Success