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 Schedules (Locations) API

Schedules are logical groupings of users that are working together. Schedules can be physical offices with addresses or logical groups like departments. Users can be tagged (associated) to one or more schedules. Schedules can be departments, facilities, business divisions or any grouping of staff.For more information about using Scheduled, visit the [Help Center](https://help.wheniwork.com/articles/creating-and-managing-schedules-computer/).

When I Work Schedules (Locations) 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 Schedules (Locations). 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 2 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 2 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 Schedules (Locations) 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.

Schedules (Locations) 5

Schedules are logical groupings of users that are working together. Schedules can be physical offices with addresses or logical groups like departments. Users can be tagged (assoc…

GET
/2/locations
List Schedules (Locations)
1 param → 200
POST
/2/locations
Create Schedule (Location)
body → 200
GET
/2/locations/{id}
Get Schedule (Location)
1 param → 200
PUT
/2/locations/{id}
Update Schedule (Location)
1 param body → 200
DELETE
/2/locations/{id}
Delete Schedule (Location)
2 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Schedule (19 properties), Place (15 properties). Each schema is shown below with its type and property counts.

Place
object
15 properties
Schedule
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

when-i-work-schedules-locations-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 Schedule Templates API
When I Work Shift Break - Paid Rest API
When I Work Shift Breaks API