List Member Benefits - Placewise API

Request

Query Params

active

boolean

optional

When true, it returns only active Benefits. When false, only inactive.

Example:

true

type

enum<string>

optional

Allowed values:

genericbenefit

per_page

integer

optional

Number of results to be returned per request. See: API Pagination

page_no

integer

optional

Number of results page. See: API Pagination

>= 1

Default:

1

sort_by[]

string

optional

See: Sorting params

Default:

id

sort_directions[]

enum<string>

optional

See: Sorting params

Allowed values:

ASCDESC

Default:

DESC

Examples:

ASCDESC

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

X-Locale

string

optional

Desired content language. Details

Default:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://api.mpc.dev.placewise.com/v1/members/me/benefits?active=true&type&per_page=&page_no=1&sort_by[]=id&sort_directions[]=DESC' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: ' \
--header 'X-Locale: pl'

Responses

🟢200Success

application/json

Body

benefits

array[object (MemberBenefit) {7}]

required

id

integer <uint64>

read-onlyrequired

Example:

1

type

enum<string>

required

Allowed values:

genericparking

Examples:

genericparking

identifier

string

required

Example:

my_program_1

name

string | null

required

Depends on X-Locale header

Example:

Name

description

string | null

required

Depends on X-Locale header

Example:

Description

conditions

string | null

required

Describes conditions of the benefit. May contain HTML. Depends on X-Locale header

Example:

Conditions

active

boolean

required

True when benefit is active for member (its conditions are fulfilled)

pagination_info

object (PaginationInfo) | null

read-onlyrequired

count

integer

read-onlyrequired

Actual number of results returned in request

Example:

1000

total_count

integer

required

Number of all available results

>= 1

Example:

2050

per_page

integer

read-onlyrequired

Number of results returned per request

Example:

1000

total_pages

integer

read-onlyrequired

Number of all available pages

Example:

3

current_page

integer

read-onlyrequired

Example:

1

next_page

integer | null

read-onlyrequired

Next available page (null when it's a last page)

Example:

2

prev_page

integer | null

read-onlyrequired

Next available page (null when it's a first page)

Example:

null

is_first_page

boolean

read-onlyrequired

Example:

true

is_last_page

boolean

read-onlyrequired

Example:

false

is_out_of_range

boolean

read-onlyrequired

Is given per_page param out of range?

Example:

false

offset

integer

read-onlyrequired

Example:

0

Example

{
    "benefits": [
        {
            "id": 1,
            "type": "generic",
            "identifier": "my_program_1",
            "name": "Name",
            "description": "Description",
            "conditions": "Conditions",
            "active": true
        }
    ],
    "pagination_info": {
        "count": 1000,
        "total_count": 2050,
        "per_page": 1000,
        "total_pages": 3,
        "current_page": 1,
        "next_page": 2,
        "prev_page": null,
        "is_first_page": true,
        "is_last_page": false,
        "is_out_of_range": false,
        "offset": 0
    }
}