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 Availabilities API

Set your availability preferences to let your employer know when you prefer to work and when you prefer not to work.For more information about using Availabilities, visit the [Help Center](https://help.wheniwork.com/articles/setting-your-availability-computer/).

When I Work Availabilities 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 Availabilities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 8 JSON Schemas.

This API exposes 6 operations across 3 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.

6 operations 3 paths 1 schemas 1 DELETE2 GET2 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 Availabilities 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 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Availabilities 6

Set your availability preferences to let your employer know when you prefer to work and when you prefer not to work. For more information about using Availabilities, visit the [He…

GET
/2/availabilityevents
List Availability Events
4 params → 200
POST
/2/availabilityevents
Create Availability Event
body → 200
GET
/2/availabilityevents/{id}
Get Availability Event
1 param → 200
PUT
/2/availabilityevents/{id}
Update Availability Event
1 param body → 200
DELETE
/2/availabilityevents/{id}
Delete Availability Event
1 param → 200
POST
/2/availabilityevents/{id}/exceptions
Create Availability Event Exception
body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is AvailabilityEvent (13 properties). Each schema is shown below with its type and property counts.

AvailabilityEvent
object
13 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

when-i-work-availabilities-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 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
When I Work Shift Breaks API