List games - Waffle API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

limit

integer

optional

The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 100, Square returns a 400 VALUE_TOO_LOW or 400 VALUE_TOO_HIGH error. The default value is 100.

sortField

enum<string>

optional

Use the default sort key.

Allowed values:

DEFAULTCREATED_AT

sortOrder

enum<string>

optional

Indicates whether customers should be sorted in ascending (ASC) or descending (DESC) order.

Allowed values:

ASCDESC

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

programs

array [object {7}]

required

The list of program for workspace, sorted by ascending name.

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.

terminology

object

optional

A cosmetic name for the “points” currency.

createdAt

string <date-time>

read-onlyoptional

updatedAt

string <date-time>

read-onlyoptional

pagination

object

required

totalRecords

integer

required

currentPage

integer

required

totalPage

integer

required

Example

{
    "programs": [
        {
            "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"
        }
    ],
    "pagination": {
        "totalRecords": 0,
        "currentPage": 0,
        "totalPage": 0
    }
}