Holiday

Get holidays on a workspace

Changed on
get/v1/workspaces/{workspaceId}/holidays

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/holidays
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:60f91b3ffdaf031696ec61a8

Query parameters

assigned-tostring

If provided, you'll get a filtered list of holidays assigned to user.

Example:60f924bafdaf031696ec6218

Response

OK

automaticTimeEntryCreationboolean

Indicates that time entries will be automatically created for this holiday.

everyoneIncludingNewboolean

Indicates whether the holiday is shown to new users.

idstring

Represents holiday identifier across the system.

namestring

Represents the name of the holiday.

occursAnnuallyboolean

Indicates whether the holiday occurs annually.

projectIdstring

Represents projectId for automatic time entry creation.

taskIdstring

Represents taskId for automatic time entry creation.

userGroupIdsstring[]

Indicates which user groups are included.

userIdsstring[]

Indicates which users are included.

workspaceIdstring

Represents workspace identifier across the system.

Example response

[
  {
    "id": "5b715612b079875110791111",
    "name": "New Year's Day",
    "occursAnnually": true,
    "projectId": "65b36d3c525e243c48f9150f",
    "taskId": "65b36d46fa3df8607e42d21a",
    "userGroupIds": [
      "5b715612b079875110791342",
      "5b715612b079875110791324",
      "5b715612b079875110793142"
    ],
    "userIds": [
      "5b715612b079875110791432",
      "5b715612b079875110791234"
    ],
    "workspaceId": "5b715612b079875110792222"
  }
]

Changes

  • a5b636acbcd8Revision changes
    • breaking

      for the query request parameter assigned-to, default value was added

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status