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 Shift Requests API

If you’re unable to work one of your shifts, you can give it to one of your coworkers (drop the shift) or trade shifts with one of your coworkers (swap shifts).For more information about using Shift Requests, visit the [Help Center](https://help.wheniwork.com/articles/swapping-and-dropping-shifts-computer/).

When I Work Shift Requests 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 Shift Requests. 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 6 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 6 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 Shift Requests 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.

Shift Requests 5

If you’re unable to work one of your shifts, you can give it to one of your coworkers (drop the shift) or trade shifts with one of your coworkers (swap shifts). For more informati…

GET
/2/swaps
Gets a collection of all shift requests.
9 params → 200
POST
/2/swaps
Create a new shift request.
body → 201
DELETE
/2/swaps/{swap_id}
Delete the given shift request.
1 param → 200
GET
/2/swaps/{swap_id}
Get the details of a specific shift request.
1 param → 200
PUT
/2/swaps/{swap_id}
Update a shift request.
1 param body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Shift (30 properties), User (23 properties), Swap (18 properties), Message (11 properties). Each schema is shown below with its type and property counts.

ShiftScheduledBreak
BaseScheduledBreak
object
9 properties 2 required
Shift
object
30 properties 3 required
Swap
object
Shift requests let users swap shifts with each other or drop shifts for other users to pick up.
18 properties
User
object
23 properties
Message
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

when-i-work-shift-requests-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 Schedules (Locations) API
When I Work Shift Break - Paid Rest API