getPeriods

READ

Get periods.

POST /api/v1/shared/getPeriods

curl -X POST '<your-host>/api/v1/shared/getPeriods' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "startDate": "string",
    "endDate": "string"
  }'

Response

{
  "results": [
    {
      "createdAt": "string",
      "endDate": "string",
      "id": "string",
      "periodType": "Week",
      "startDate": "string"
    }
  ],
  "count": null
}

Parameters

ParameterType

Input schema

schema

{
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string"
    },
    "endDate": {
      "type": "string"
    }
  },
  "required": [
    "startDate",
    "endDate"
  ]
}