When I Work Accounts API
Accounts (aka Workplaces) are objects that define a business account with When I Work. Each user is associated with an account enabling them to access Shifts or other data.For more information about Accounts, visit the [Help Center](https://help.wheniwork.com/article-categories/account-settings/).
When I Work Accounts 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 Accounts. 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 4 paths, and defines 3 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
When I Work Accounts 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 4 paths, the API surfaces 5 operations — 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Accounts (aka Workplaces) are objects that define a business account with When I Work. Each user is associated with an account enabling them to access Shifts or other data. For mo…
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are components-schemas-User (28 properties), schemas-Account (16 properties), schemas-Place (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from When I Work 12
Other APIs When I Work publishes across the network.