List Articles

Pending

GET

https://api.mpc.dev.placewise.com/v1/operations/articles

API Permit:Operations:Api:Articles:List

API Context:Loyalty Club

Authorizations:UserToken

Returns list of Articles.

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
status	enum `['draft', 'published']`	null	When present, returns only Articles having given status
search	string	null	When true, returns only Articles with titles that match the given string
currently_published	bool	null	When present, returns only published articles (visible for tenants)
pinned	bool	null	When present, returns only pinned articles
sort_by	string	created_at	Property on which list is sorted (created_at, published_at, title, position, positioned)
sort_direction	string	asc	Sort direction (asc, desc)

Example

When successful, returns object containing article and PaginationInfo

{
  "articles": [], // List of articles - see 'Article model'
  "pagination_info": {} // Pagination info - see 'Pagination info'
}

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/operations/articles' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

Example

{}

Introduction

Show Article

List Articles

Query Parameters#

Example#

Request

Request Code Samples

Responses

Query Parameters

Example