Skip to main content
GET
/
loyalty
/
programs
List Loyalty Programs
curl --request GET \
  --url https://webmaster.zupers.com.br/api/loyalty/v1/loyalty/programs/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "1474884f79a5ec42bc017be2aac",
    "name": "Clube do Miola",
    "description": "Os Melhores Hamburguers da sua Vida!",
    "company": {
      "id": "1474883d96603e4914ef43bb135",
      "name": "Miola Smash Burger"
    },
    "active": true,
    "points_name": "Smashes",
    "is_public": true,
    "has_welcome_reward": false,
    "welcome_reward_description": null,
    "logo": "https://cdn.zupy.com/media/loyalty/program/logos/4603621878005760_logo_iQ5HYT9.png",
    "icon_image": null,
    "rewards_count": 20,
    "customers_count": 1022
  }
]

Authorizations

​
Authorization
string
header
required

Use format: Bearer ZsCUqECc9aCQtN5z9z9sTs81933YnklP

Response

Loyalty programs retrieved successfully

​
id
string
Example:

"1474884f79a5ec42bc017be2aac"

​
name
string
Example:

"Clube do Miola"

​
description
string
Example:

"Os Melhores Hamburguers da sua Vida!"

​
company
object
​
active
boolean
Example:

true

​
points_name
string
Example:

"Smashes"

​
is_public
boolean
Example:

true

​
has_welcome_reward
boolean
Example:

false

​
welcome_reward_description
string | null
Example:

null

Example:

"https://cdn.zupy.com/media/loyalty/program/logos/4603621878005760_logo_iQ5HYT9.png"

​
icon_image
string<uri> | null
Example:

null

​
rewards_count
integer
Example:

20

​
customers_count
integer
Example:

1022