Skip to main content
GET
/
v1
/
reporting-period-config
/
{reportingPeriodConfigurationId}
Read Reporting Period Configuration
curl --request GET \
  --url https://{tenant}.mindbridge.ai/api/v1/reporting-period-config/{reportingPeriodConfigurationId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "monthlyReportingPeriods": [
    {
      "periodNumber": 123,
      "quarterNumber": 123,
      "yearLabel": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25"
    }
  ],
  "weeklyReportingPeriods": [
    {
      "weekNumber": 123,
      "yearLabel": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
reportingPeriodConfigurationId
string
required

Response

200 - application/json

OK

​
id
string
​
version
integer<int64>
​
creationDate
string<date-time>
​
lastModifiedDate
string<date-time>
​
createdUserInfo
User Info · object
read-only
​
lastModifiedUserInfo
User Info · object
read-only
​
monthlyReportingPeriods
Monthly Reporting Period · object[]

List of monthly reporting periods.

​
weeklyReportingPeriods
Weekly Reporting Period · object[]

List of weekly reporting periods.

​
status
enum<string>
Available options:
UPLOADED,
VALIDATING,
FAILED,
COMPLETED