Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

When I Work Schedule Templates API

Schedule templates allow you to create a daily or weekly schedule that is reusable. If your schedules are very similar from day to day or week to week, use a template to save time and avoid creating schedules from scratch.For more information about using Schedule Templates, visit the [Help Center](https://help.wheniwork.com/articles/using-schedule-templates-computer/).

When I Work Schedule Templates 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 Schedule Templates. 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 5 schemas. 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.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.wheniwork.com/2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

When I Work Schedule Templates 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.

Schedule Templates 5

Schedule templates allow you to create a daily or weekly schedule that is reusable. If your schedules are very similar from day to day or week to week, use a template to save time…

GET
/2/templates
List Schedule Templates
→ 200
POST
/2/templates
Create Schedule Template
body → 200
GET
/2/templates/{id}
Get Schedule Template
1 param → 200
PUT
/2/templates/{id}
Update Schedule Template
1 param body → 200
DELETE
/2/templates/{id}
Delete Schedule Template
1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Shift (30 properties), ScheduleTemplate (10 properties), BaseScheduledBreak (9 properties). Each schema is shown below with its type and property counts.

ShiftScheduledBreak
BaseScheduledBreak
object
9 properties 2 required
ScheduleTemplateShift
Shift
object
30 properties 3 required
ScheduleTemplate
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

when-i-work-schedule-templates-api-openapi.yml Raw ↑

Other APIs When I Work publishes across the network.

When I Work Accounts API
When I Work Annotations API
When I Work Availabilities API
When I Work Import API
When I Work OpenShift Requests API
When I Work Payrolls API
When I Work Positions API
When I Work Punch API
When I Work Request Type API
When I Work Schedules (Locations) API
When I Work Shift Break - Paid Rest API
When I Work Shift Breaks API