List Events - Placewise API

Request

Query Params

status

string

optional

When present, only records of given status will be returned

Example:

published

locale

string

optional

Context of the query, used for example in sorting

Example:

publication_status

string

optional

When present, only records of given publication status will be returned

Example:

published

store_id[]

array[string]

optional

Example:

[""]

excluded_publication_status

string

optional

When present, only records with publication status different than given will be returned

Example:

expired

sort_by[]

string

optional

Example:

ends_at

sort_directions[]

string

optional

Example:

ASC

tag_ids[]

array[integer]

optional

When present, only records having one of specified tags are returned

Example:

["1","2"]

category_ids[]

array[integer]

optional

Example:

["1","2"]

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:

with_archived

boolean

optional

When true, also archived record will be treated as accessible

Default:

false

only_archived

boolean

optional

When true, only archived record will be treated as accessible

Default:

false

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-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:

X-Store-Id

integer

required

Store id associated with given user role (e.g. Store Owner).

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

events

array[object (Event) {29}]

required

integer <uint64>

read-onlyrequired

Example:

customer_id

integer <uint64>

read-onlyrequired

Customer the record is assigned to

Example:

447

locales

required

products

required

status

enum<string>

required

Determines visibility in Public API

Allowed values:

draftpublishedunpublished

Example:

published

visible_since

required

visible_until

required

visible_in_list

boolean

required

Should record be returned on lists of CMS Public API

Default:

true

Example:

true

sorting_priority

integer

required

Priority of the record during sorting in CMS Public API. Currently read-only.

Example:

location

object (LocalizedContent) | null

required

Example:

{"en":"Text"}

occurrence_description

required

occurrence_type

enum<string>

required

Determines type of ocurrence

Allowed values:

time_rangedate_rangesingle_day

Default:

time_range

Example:

time_range

occurrence

required

Informs when the Event occurs.
In order to sort by start of the occurence, use "virtual" starts_at attribute which attempts to normalize the kinds of occurrence.

group_id

required

EventsGroup the record belongs to

store_id

required

title

required

slug

required

body

required

teaser

required

headline

required

image

object (File) | null

read-onlyrequired

Must be uploaded as a file of type: cms_event_image

url

string

required

Address of the entity page on website

Example:

path/to/:id

publication_status

enum<string>

read-onlyrequired

Visibility status of the record in CMS Public API that takes into the consideration status, visible_since and visible_until dates

Allowed values:

publisheddraftexpiredscheduled

Example:

published

us_legacy_data

object | null

required

tag_ids

required

created_at

string <date-time>

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

read-onlyrequired

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

archived_at

string <date-time> | null

read-onlyrequired

Time of the record archivization

Example:

2022-11-15T16:25:58.099512Z

category_ids

array[integer]

required

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:

current_page

integer

read-onlyrequired

Example:

next_page

integer | null

read-onlyrequired

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

Example:

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:

Example

{
    "events": [
        {
            "id": 1,
            "customer_id": 447,
            "locales": [
                "en"
            ],
            "products": [
                "website"
            ],
            "status": "draft",
            "visible_since": "2022-11-09T16:25:58.099512Z",
            "visible_until": "2022-11-15T16:25:58.099512Z",
            "visible_in_list": true,
            "sorting_priority": 0,
            "location": {
                "en": "Text"
            },
            "occurrence_description": {
                "en": "Text"
            },
            "occurrence_type": "time_range",
            "occurrence": {
                "starts_at": "2022-11-09T16:25:58.099512Z",
                "ends_at": "2022-11-09T16:25:58.099512Z"
            },
            "group_id": 1,
            "store_id": 1001931,
            "title": {
                "en": "Text"
            },
            "slug": {
                "en": "Text"
            },
            "body": {
                "en": "Text"
            },
            "teaser": {
                "en": "Text"
            },
            "headline": {
                "en": "Text"
            },
            "image": {
                "url": "https://example.com/image.png",
                "identifier": "1",
                "mime_type": "image/jpeg",
                "created_at": "2022-11-09T15:46:00.252860Z",
                "updated_at": "2022-11-09T15:46:00.252860Z",
                "image_details": {
                    "width": 1,
                    "height": 1
                }
            },
            "url": "path/to/:id",
            "publication_status": "published",
            "us_legacy_data": {},
            "tag_ids": [
                1
            ],
            "created_at": "2022-11-05T16:25:58.099512Z",
            "updated_at": "2022-11-15T16:25:58.099512Z",
            "archived_at": "2022-11-15T16:25:58.099512Z",
            "category_ids": [
                0
            ]
        }
    ],
    "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
    }
}