List Notifications - Placewise API

Request

Query Params

seen

boolean

optional

When true, returns only notifications seen by user. When false, returns only not seen. When not present, returns all of them.

Example:

true

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

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Locale

string

optional

Desired content language. Details

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

not_seen_notifications_count

integer

required

Total number of not seen Notifications

>= 0

Example:

notifications

array[object (UserNotification) {9}]

required

integer <uint64>

read-onlyrequired

Example:

app_module

string

required

Name of app module the Notification is related to. Localized

Example:

operations_documents

type

enum<string>

required

!!TODO!! Types should be documented somewhere

Allowed value:

operations_alert_accepted

Example:

operations_alert_accepted

body

string

required

Content of the Notification. Localized

Example:

APPROVED: Holiday promo coupon 10% discount

url

string

required

Relative URL to a MPC page related to the event

Example:

447;type=customer/resources/details/23

occurred_at

string <date-time>

required

When the Event that triggered the Notification occurred

Example:

2022-11-09T16:25:58.099512Z

created_at

string <date-time>

read-onlyrequired

When the Notification has been created

Example:

2022-11-05T16:25:58.099512Z

received_at

required

When the Notification has been received by the user

seen_at

required

When the Notification has been seen by user for the last time

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

{
  "not_seen_notifications_count": 5,
  "notifications": [
    {
      "id": 1,
      "app_module": "operations_documents",
      "type": "operations_alert_accepted",
      "body": "APPROVED: Holiday promo coupon 10% discount",
      "url": "447;type=customer/resources/details/23",
      "occurred_at": "2022-11-09T16:25:58.099512Z",
      "created_at": "2022-11-05T16:25:58.099512Z",
      "received_at": "2022-11-09T16:25:58.099512Z",
      "seen_at": "2022-11-09T16:25:58.099512Z"
    }
  ],
  "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
  }
}