# OpenProject Work Schedule API

**Canonical:** https://apis.io/apis/openproject/openproject-work-schedule-api/  
**Provider:** OpenProject — https://apis.io/providers/openproject/  
**Base URL:** https://community.openproject.org/api/v3  
**Documentation:** https://www.openproject.org/docs/api/

OpenProject Work Schedule API is one of 62 APIs that [OpenProject](https://apis.io/providers/openproject/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Work Schedule. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

The work schedule defines if days are working days or non-working days. A day can be a non-working day if any of these two conditions are met: - the day is a recurring non-working week day: a weekend day. For instance Sunday is not worked in most countries; - the day has been defined as a non-working day: national bank holidays or other days deemed special. For instance the 1st of January is New Year's day and is a bank holiday in most countries. Endpoints can define which week days are working/non-working days, and which dates are non-working days. To represent the work schedule, `Day`, `WeekDay`, and `NonWorkingDay` models are used. ## Day Actions None ## Day Linked Properties | Link | Description | Type | Constraints | Supported operations | | :---------------: | ---------------------------------------------------------------- | ------------------------- | ----------- | -------------------- | | self | This day | Day | not null | READ | | nonWorkingReasons | A list of resources describing why this day is a non-working day | (WeekDay/NonWorkingDay)[] | | READ | | weekDay | The week day for this day | WeekDay | not null | READ | ## Day Local Properties | Property | Description | Type | Constraints | Supported operations | | :--------: | ------------------------------------------- | ------- | -------------- | -------------------- | | date | The date in ISO8601 format (YYYY-MM-DD) | Date | not null | READ | | name | The name of the day | String | not null | READ | | working | `true` for a working day, `false` otherwise | Boolean | not null | READ | ## WeekDay Actions | Link | Description | Condition | | :----: | -------------------- | ---------------------------------- | | update | Update this week day | **Permission**: edit work schedule | ## WeekDay Linked Properties | Link | Description | Type | Constraints | Supported operations | | :--: | ------------- | ------- | ----------- | -------------------- | | self | This week day | WeekDay | not null | READ | ## WeekDay Local Properties | Property | Description | Type | Constraints | Supported operations | | :------: | --------------------------------------------------- | ------- | -------------- | -------------------- | | day | The week day from 1 to 7. 1 is Monday. 7 is Sunday. | Integer | x >= 1, x <= 7 | READ | | name | The name of the week day | String | not null | READ | | working | `true` for a working week day, `false` otherwise | Boolean | not null | READ/WRITE | ## NonWorkingDay Actions | Link | Description | Condition | | :----: | --------------------------- | ---------------------------------- | | update | Update this non-working day | **Permission**: edit work schedule | ## NonWorkingDay Linked Properties | Link | Description | Type | Constraints | Supported operations | | :--: | -------------------- | ------------- | ----------- | -------------------- | | self | This non-working day | NonWorkingDay | not null | READ | ## NonWorkingDay Local Properties | Property | Description | Type | Constraints | Supported operations | | :------: | --------------------------------------- | ------ | ----------- | -------------------- | | date | The date in ISO8601 format (YYYY-MM-DD) | Date | not null | READ | | name | The name of the non-working day day | String | not null | READ/WRITE |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-work-schedule-api-openapi.yml
- **Documentation** — https://www.openproject.org/docs/api/
- **Introduction** — https://www.openproject.org/docs/api/introduction/
- **Endpoints** — https://www.openproject.org/docs/api/endpoints/
- **GitHub** — https://github.com/opf/openproject

## Other OpenProject APIs (12)

- [OpenProject Actions & Capabilities API](https://apis.io/apis/openproject/openproject-actions-capabilities-api/)
- [OpenProject Activities API](https://apis.io/apis/openproject/openproject-activities-api/)
- [OpenProject Attachments API](https://apis.io/apis/openproject/openproject-attachments-api/)
- [OpenProject Budgets API](https://apis.io/apis/openproject/openproject-budgets-api/)
- [OpenProject Categories API](https://apis.io/apis/openproject/openproject-categories-api/)
- [OpenProject Collections API](https://apis.io/apis/openproject/openproject-collections-api/)
- [OpenProject Configuration API](https://apis.io/apis/openproject/openproject-configuration-api/)
- [OpenProject Custom actions API](https://apis.io/apis/openproject/openproject-custom-actions-api/)
- [OpenProject Custom Field Items API](https://apis.io/apis/openproject/openproject-custom-field-items-api/)
- [OpenProject Custom Fields API](https://apis.io/apis/openproject/openproject-custom-fields-api/)
- [OpenProject Custom Options API](https://apis.io/apis/openproject/openproject-custom-options-api/)
- [OpenProject Documents API](https://apis.io/apis/openproject/openproject-documents-api/)

## Tags

Work Schedule

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/openproject/openproject-work-schedule-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/openproject/.