When I Work Annotations API
Annotations convey important information to all staff for the given schedules (locations) and date range.Any or none of the following tags may apply to an Annotation:* Time Off Not Allowed* Business Closed* AnnouncementThe "Time Off Not Allowed" tag is the only tag that affects the behavior of another API. Time Off requests will be considered invalid if the request's date range overlaps an Annotation of the "Time Off Not Allowed" type for the user's location(s).For more on using Annotations, visit the [Help Center](https://help.wheniwork.com/hc/en-us/articles/204348065-Annotations).
When I Work Annotations API is one of 22 APIs that When I Work publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 8 JSON Schema definitions.
Tagged areas include Annotations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 8 JSON Schemas.
This API exposes 5 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://api.wheniwork.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
When I Work Annotations API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JSON Web Token) (W-Token).
By default, every request must be authenticated.
W-Token— Authentication with When I Work is based on a token model using [JSON Web Tokens](https://jwt.io/). First, you authenticate using a private developer key and t…
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Annotations convey important information to all staff for the given schedules (locations) and date range. Any or none of the following tags may apply to an Annotation: Time Off No…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Annotation (16 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from When I Work 12
Other APIs When I Work publishes across the network.