Skip to content
Leadtime
English
Esc
↑↓navigate↵open⌘Jpreview

Get holiday settings

Retrieves the workspace holiday configuration, including the default holiday country/region and all available holiday sources.

What are Holiday Settings? Holiday settings determine which regional holiday rules the system uses for capacity planning. Leadtime needs to know when employees are not available due to regional holidays, which is essential for accurate capacity management.

What is returned:

  • defaultHolidayCode: The default holiday country/region code for the workspace (e.g., “US”, “DE”, “US-CA”)
  • availableCountries: List of all available holiday countries and states with their codes and localized names

How it works:

  • The default holiday code is automatically applied to all new employees
  • Individual employees can have different holiday rules set in their profile
  • Holidays are displayed in the team calendar and used for capacity calculations
  • Use the language query parameter to get country names in a specific language (default: “en”)

Note: This endpoint requires the manageSettings permission.

GET/holidays/settings
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Query parameters
languagestringrequired
Responses
200

Holiday settings retrieved successfully

availableCountriesHolidayCountryDto[]required

Complete list of all available holiday countries and states that can be used for holiday configurations. Use these codes when setting default holiday settings or individual employee holiday rules.

Show properties
Array of HolidayCountryDto
codestringrequired

Country or region code in ISO 3166-1 alpha-2 format. For states/provinces, uses format "COUNTRY-STATE" (e.g., "US-CA" for California).

namestringrequired

Localized country or region name in the requested language. Names are provided in the language specified by the language query parameter.

defaultHolidayCodestringrequired

The default holiday country/region code for the workspace. This code is automatically applied to all new employees. Individual employees can override this in their profile settings.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it
Server
Authorization
Parameters
Request
curl -X GET "https://leadtime.app/api/public/holidays/settings?language=string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
  "availableCountries": [
    {
      "code": "US",
      "name": "United States"
    }
  ],
  "defaultHolidayCode": "US"
}