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
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
{
"articles": [], // List of articles - see 'Article model'
"pagination_info": {} // Pagination info - see 'Pagination info'
}Request
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/operations/articles' \
--header 'X-User-Agent: ApiDog' \
--header 'X-Product-Name: default' \
--header 'X-Loyalty-Club-Slug: infinity-mall' \
--header 'X-Customer: 447' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json'Response Response Example
{}