Get Calendar

GET /public/v1/projects/{projectId}/calendars/{calendarId}

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required
  • calendarId integer(int64) Required

Responses

  • 500 */*

    Internal Server Error

  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • id integer(int64) Required

      Calendar ID

    • baseCalendarId integer(int64) Required

      Base Calendar ID

    • defaultCalendar boolean Required

      Is Default Calendar

    • name string Required

      Calendar Name

    • type string Required

      Calendar Type

    • hoursPerDay number(double) Required

      Hours Per Day

    • hoursPerMonth number(double) Required

      Hours Per Month

    • hoursPerWeek number(double) Required

      Hours Per Week

    • hoursPerYear number(double) Required

      Hours Per Year

    • worktimeList array[object] Required

      List of Calendar Worktimes

      Hide worktimeList attributes Show worktimeList attributes object
      • id integer(int64)
      • holiday boolean
      • dayOfWeek integer(int32)
      • specificDate string(date)
      • hours number(double)
      • timeStart1 string
      • timeStart2 string
      • timeStart3 string
      • timeStart4 string
      • timeStart5 string
      • timeEnd1 string
      • timeEnd2 string
      • timeEnd3 string
      • timeEnd4 string
      • timeEnd5 string
    • externalId string Required

      External ID

GET /public/v1/projects/{projectId}/calendars/{calendarId}
curl \
 --request GET 'https://live.smartpmtech.com/public/v1/projects/{projectId}/calendars/{calendarId}' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"
Response examples (500)
{}
Response examples (200)
{
  "id": 1,
  "baseCalendarId": 0,
  "defaultCalendar": true,
  "name": "Standard Calendar",
  "type": "STANDARD",
  "hoursPerDay": 8.0,
  "hoursPerMonth": 160.0,
  "hoursPerWeek": 40.0,
  "hoursPerYear": 1920.0,
  "worktimeList": [
    {
      "id": 42,
      "holiday": true,
      "dayOfWeek": 42,
      "specificDate": "2025-05-04",
      "hours": 42.0,
      "timeStart1": "string",
      "timeStart2": "string",
      "timeStart3": "string",
      "timeStart4": "string",
      "timeStart5": "string",
      "timeEnd1": "string",
      "timeEnd2": "string",
      "timeEnd3": "string",
      "timeEnd4": "string",
      "timeEnd5": "string"
    }
  ],
  "externalId": "ext-12345"
}