# When I Work Annotations API

**Canonical:** https://apis.io/apis/when-i-work/when-i-work-annotations-api/  
**Provider:** When I Work — https://apis.io/providers/when-i-work/  
**Base URL:** https://api.wheniwork.com/2  
**Documentation:** https://apidocs.wheniwork.com/external/index.html

When I Work Annotations API is one of 22 APIs that [When I Work](https://apis.io/providers/when-i-work/) publishes on the [APIs.io](https://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.

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 * Announcement The "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).

## Machine-readable artifacts (16)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/openapi/when-i-work-annotations-api-openapi.yml
- **Documentation** — https://apidocs.wheniwork.com/external/index.html
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-shift-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-user-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-time-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-position-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-schedule-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-site-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-shifttemplate-schema.json
- **Examples** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/examples/when-i-work-examples.json
- **Vocabulary** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/vocabulary/when-i-work-vocabulary.yml
- **JSONLDContext** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-ld/when-i-work-context.jsonld
- **Plans** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/plans/when-i-work-plans-pricing.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/rate-limits/when-i-work-rate-limits.yml
- **FinOps** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/finops/when-i-work-finops.yml

## Other When I Work APIs (12)

- [When I Work Accounts API](https://apis.io/apis/when-i-work/when-i-work-accounts-api/)
- [When I Work Availabilities API](https://apis.io/apis/when-i-work/when-i-work-availabilities-api/)
- [When I Work Import API](https://apis.io/apis/when-i-work/when-i-work-import-api/)
- [When I Work OpenShift Requests API](https://apis.io/apis/when-i-work/when-i-work-openshift-requests-api/)
- [When I Work Payrolls API](https://apis.io/apis/when-i-work/when-i-work-payrolls-api/)
- [When I Work Positions API](https://apis.io/apis/when-i-work/when-i-work-positions-api/)
- [When I Work Punch API](https://apis.io/apis/when-i-work/when-i-work-punch-api/)
- [When I Work Request Type API](https://apis.io/apis/when-i-work/when-i-work-request-type-api/)
- [When I Work Schedule Templates API](https://apis.io/apis/when-i-work/when-i-work-schedule-templates-api/)
- [When I Work Schedules (Locations) API](https://apis.io/apis/when-i-work/when-i-work-schedules-locations-api/)
- [When I Work Shift Break - Paid Rest API](https://apis.io/apis/when-i-work/when-i-work-shift-break-paid-rest-api/)
- [When I Work Shift Breaks API](https://apis.io/apis/when-i-work/when-i-work-shift-breaks-api/)

## Tags

Annotations

---

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