List Reporting Periods

GET

https://api.mpc.dev.placewise.com/v1/users/me/operations/revenue_reporting/periods

API Permit:Operations:Api:Users:RevenueReports:List

API Context:Loyalty Club

Authorizations:User

Returns list of reporting periods in units defined on current user and store

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/users/me/operations/revenue_reporting/periods' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'Authorization: Bearer ' \
--header 'X-Store-Id: '

Responses

🟢200Success

application/json

Body

Example

{
    "periods": [
        {
            "unit": "week",
            "number": 9,
            "year": 2024,
            "name": "Week 9",
            "policy_id": 81182,
            "starts_at": "2025-06-03T08:29:09.842Z",
            "ends_at": "2025-06-03T08:29:09.843Z",
            "deadline_at": "2025-06-03T08:29:09.843Z",
            "completed": true,
            "current": true,
            "iso8601_number": "9"
        },
        {
            "unit": "quarter",
            "number": 1,
            "year": 2024,
            "name": "Quarter 1",
            "policy_id": 86807,
            "starts_at": "2025-06-03T08:29:09.848Z",
            "ends_at": "2025-06-03T08:29:09.849Z",
            "deadline_at": "2025-06-03T08:29:09.849Z",
            "completed": false,
            "current": false,
            "iso8601_number": 1
        }
    ]
}

Add App Tokens

List Reporting Period Reports