List Articles - Placewise API

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:

X-Locale

string

optional

Desired content language. Details

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

articles

array[object (Article) {10}]

required

integer <uint64>

read-onlyrequired

Example:

title

string | null

read-onlyrequired

Localized

Example:

Title

slug

string | null

read-onlyrequired

Localized

Example:

slug

teaser

string | null

read-onlyrequired

Localized

Example:

Teaser

body

string | null

read-onlyrequired

Localized

Example:

Body

headline

string | null

read-onlyrequired

Localized

Example:

Headline

category_ids

array[integer]

required

published_at

string <date-time>

required

Example:

2022-11-09T16:25:58.099512Z

image

object (File) | null

read-onlyrequired

url

string

required

Address of the entity page on website

Example:

path/to/:id

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

{
    "articles": [
        {
            "id": 1,
            "title": "Title",
            "slug": "slug",
            "teaser": "Teaser",
            "body": "Body",
            "headline": "Headline",
            "category_ids": [
                0
            ],
            "published_at": "2022-11-09T16:25:58.099512Z",
            "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"
        }
    ],
    "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
    }
}