Get loyalty program by ID

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

game-id

string

required

Header Params

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

id

string <uuid>

read-onlyrequired

The assigned ID of the loyalty program. Updates to the loyalty program do not modify the identifier.

<= 36 characters

status

enum<string>

optional

Whether the program is currently active.

Allowed values:

ACTIVEINACTIVE

name

string

optional

availableTime

object

optional

The scheduling information that defines when transaction can qualify to earn points from an ACTIVE program.

startDate

string <date-time>

optional

endDate

string <date-time>

optional

timePeriods

string

required

A list of iCalendar (RFC 5545) events (VEVENT).

Example:

BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;UNTIL=20221001T000000;BYDAY=TU\nEND:VEVENT

terminology

object

optional

A cosmetic name for the “points” currency.

one

string

required

A singular unit for a point (for example, 1 point is called 1 star).

>= 1 characters

other

string

required

A plural unit for point (for example, 10 points is called 10 stars).

>= 1 characters

createdAt

string <date-time>

read-onlyoptional

updatedAt

string <date-time>

read-onlyoptional

Example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "ACTIVE",
  "name": "string",
  "availableTime": {
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "timePeriods": "BEGIN:VEVENT\\nDTSTART:20220816T160000\\nDURATION:PT2H\\nRRULE:FREQ=WEEKLY;UNTIL=20221001T000000;BYDAY=TU\\nEND:VEVENT"
  },
  "terminology": {
    "one": "string",
    "other": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}