List Events Groups

Query Parameters

Parameter	Type	Default	Description
per_page	integer	100	Number of results to be returned per request (100 is the maximum)
page_no	integer	1	Number of results page
sort_by	string[]	`["title"]`	See: Sorting params
sort_directions	string[]	`["ASC"]`	See: Sorting params

Example

When successful, returns object containing Events Groups and PaginationInfo

{
  "events_groups": [], // List of Events Groups - see 'Events Group model'
  "pagination_info": {} // Pagination info - see 'Pagination info'
}

Request

Query Params

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:

sort_by[]

string

optional

See: Sorting params

Default:

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:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

events_groups

array[object (EventGroup) {4}]

required

integer

required

title

object (LocalizedContent) | null

required

Example:

{"en":"Text"}

slug

object (LocalizedContent) | null

required

Value taken from custom slug or auto-generated from title

Example:

{"en":"Text"}

body

object (LocalizedContent) | null

required

Value taken from custom slug or auto-generated from title

Example:

{"en":"Text"}

Example

{
    "events_groups": [
        {
            "id": 0,
            "title": {
                "en": "Text"
            },
            "slug": {
                "en": "Text"
            },
            "body": {
                "en": "Text"
            }
        }
    ]
}

Query Parameters#

Example#

Request

Request samples

Responses

Query Parameters

Example