How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenProject Work Schedule API

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 whichdates are non-working days.To represent the work schedule, `Day`, `WeekDay`, and `NonWorkingDay` models are used.## Day ActionsNone## 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 |

OpenProject Work Schedule API is one of 62 APIs that OpenProject publishes on the 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.

This API exposes 11 operations across 6 paths, and defines 13 schemas. It is described by OpenAPI 3.1.2, at version 3.

Requests are made against 3 base URLs: https://qa.openproject-edge.com, https://qa.openproject-stage.com, https://community.openproject.org.

11 operations 6 paths 13 schemas 1 DELETE6 GET3 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
3
Base URL
https://community.openproject.org/api/v3
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

OpenProject Work Schedule API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 3 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Work Schedule 11

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…

GET
/api/v3/days/non_working
Lists all non working days
list_non_working_days 1 param → 200400406415
POST
/api/v3/days/non_working
Creates a non-working day (NOT IMPLEMENTED)
create_non_working_day body → 201400403406415
GET
/api/v3/days/non_working/{date}
View a non-working day
view_non_working_day 1 param → 200400404
PATCH
/api/v3/days/non_working/{date}
Update a non-working day attributes (NOT IMPLEMENTED)
update_non_working_day 1 param body → 200400404406415
DELETE
/api/v3/days/non_working/{date}
Removes a non-working day (NOT IMPLEMENTED)
delete_non_working_day 1 param → 204400404406415
GET
/api/v3/days/week
Lists week days
list_week_days → 200400
PATCH
/api/v3/days/week
Update week days (NOT IMPLEMENTED)
update_week_days body → 200400404406415
GET
/api/v3/days/week/{day}
View a week day
view_week_day 1 param → 200400404
PATCH
/api/v3/days/week/{day}
Update a week day attributes (NOT IMPLEMENTED)
update_week_day 1 param body → 200400403404406415
GET
/api/v3/days
Lists days
list_days 1 param → 200400406415
GET
/api/v3/days/{date}
View day
view_day 1 param → 200400

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Link (7 properties), DayModel (5 properties), WeekDayModel (5 properties), NonWorkingDayModel (4 properties). Each schema is shown below with its type and property counts.

DayModel
object
5 properties 4 required
CollectionModel
object
4 properties 4 required
DayCollectionModel
WeekDayCollectionModel
NonWorkingDayModel
object
4 properties 3 required
CollectionLinks
object
1 property 1 required
WeekDayModel
object
5 properties 4 required
WeekDayWriteModel
object
Describes a week day as a working day or a non-working day (weekend).
2 properties 2 required
Link
object
7 properties 1 required
WeekDaySelfLinkModel
object
Identify a particular week day by its href.
1 property
ErrorResponse
object
4 properties 3 required
NonWorkingDayCollectionModel
WeekDayCollectionWriteModel
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openproject-work-schedule-api-openapi.yml Raw ↑

Other APIs OpenProject publishes across the network.

OpenProject Actions & Capabilities API
OpenProject Activities API
OpenProject Attachments API
OpenProject Budgets API
OpenProject Categories API
OpenProject Collections API
OpenProject Configuration API
OpenProject Custom actions API
OpenProject Custom Field Items API
OpenProject Custom Fields API
OpenProject Custom Options API
OpenProject Documents API
Where this information came from

This is an independent, third-party profile of OpenProject Work Schedule API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.