Waffle API

Search game accounts

Developing

Develop Env

https://dev.your-api-server.com

POST

/v1/loyalty/accounts/search

Last modified:2024-04-09 14:30:17

OperationId:search-loyalty-accounts

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Content-Type

string

required

Default:

application/json

Body Params application/json

query

object

optional

filter

object

optional

sort

object

optional

Example

{
  "query": {
    "filter": {
      "fuzzy": "string",
      "createdAt": {
        "startAt": "2019-08-24T14:15:22Z",
        "endAt": "2019-08-24T14:15:22Z"
      },
      "updatedAt": {
        "startAt": "2019-08-24T14:15:22Z",
        "endAt": "2019-08-24T14:15:22Z"
      }
    },
    "sort": {
      "field": "DEFAULT",
      "order": "ASC"
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://dev.your-api-server.com/v1/loyalty/accounts/search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": {
        "filter": {
            "fuzzy": "string",
            "createdAt": {
                "startAt": "2019-08-24T14:15:22Z",
                "endAt": "2019-08-24T14:15:22Z"
            },
            "updatedAt": {
                "startAt": "2019-08-24T14:15:22Z",
                "endAt": "2019-08-24T14:15:22Z"
            }
        },
        "sort": {
            "field": "DEFAULT",
            "order": "ASC"
        }
    }
}'

Responses

🟢200Success

application/json

Body

customers

array [object {7}]

required

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

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

{
  "customers": [
    {
      "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
  }
}

Modified at 2024-04-09 14:30:17

Get game account by ID

Gen Token