Retrieve holiday and restricted-day data for a date range

GET /task/v1/calendar/holidays

Operation id: getHolidayInformation

Description

Retrieves holiday and restricted-day information for the authenticated user's domain over an inclusive date range. Corresponds to legacy: POST /service/rtm/getHolidayInformation.

Always-injected from session: domainId is resolved from the validated session. Clients do not send domainId or authToken as query/form fields.

Date format: MM/dd/yyyy (same as the legacy form body and GET /mywork/v1/app-config?config_type=holidays).

An empty range (no holidays in the window) is a successful result — {status: OK, holiday_data: {}} — not E404.


Response Fields — holiday_data

FieldTypeDescription
holidays[]ArrayHoliday entries. Each: date (MM/dd/yyyy), reason
restricted_days[]ArrayRestricted / blackout days. Each: date (MM/dd/yyyy), reason

Error Scenarios

ScenarioHTTPError CodeMessage
Missing X-reflexis-csrf-token-X header400E112X-reflexis-csrf-token-X header is mandatory
Invalid or expired token401E204Invalid or expired token
Missing start_date or end_date400E132start_date and end_date are required for holidays
Unexpected server-side error500E302Internal server error

Error Codes Reference

CodeDescription
E132start_date and end_date are required for holidays
E112X-reflexis-csrf-token-X header is mandatory
E204Invalid or expired token
E302Internal server error

Tags: MyWorkCalendar

Parameters

Query parameters

NameTypeRequiredDescription
end_datestringYesRequired (→ E132 if missing, together with start_date). Range end date. Format: MM/dd/yyyy.
start_datestringYesRequired (→ E132 if missing, together with end_date). Range start date. Format: MM/dd/yyyy.

Security

  • AuthTokenHeader (apiKey)
    • Session authentication token validated server-side against the user session store.

Responses

200 — Success — {status: OK, holiday_data: {holidays[], restricted_days[]}}.

Empty range returns {status: OK, holiday_data: {}}.

Content type: application/json

400 — E132 — start_date and end_date are required for holidays.

Content type: application/json

401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)

Content type: application/json

500 — Unexpected server-side error

Content type: application/json

Response models

200 — Success — {status: OK, holiday_data: {holidays[], restricted_days[]}}.

Empty range returns {status: OK, holiday_data: {}}.

Content type: application/json

Schema

JSON object (structure varies by endpoint).

{
  "type": "object",
  "description": "JSON object (structure varies by endpoint)."
}

Example:

{
  "status": "OK",
  "holiday_data": {
    "holidays": [
      {
        "date": "07/04/2026",
        "reason": "Independence Day"
      },
      {
        "date": "12/25/2026",
        "reason": "Christmas"
      }
    ],
    "restricted_days": [
      {
        "date": "11/28/2026",
        "reason": "BlackOut"
      }
    ]
  }
}

400 — E132 — start_date and end_date are required for holidays.

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "error_code": "E132",
  "response": "start_date and end_date are required for holidays"
}

401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E204",
  "response": "Invalid or expired token"
}

500 — Unexpected server-side error

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E302",
  "response": "Internal server error"
}