When I Work Users API
A person on the When I Work platform is associated with a two tier record. The persons email/password is associated to a person_id.For each Workplace the person belongs to a user_id record exists. This record links back to the person_id so only a single instance of the email/password exists. If a user updates their email or password this applies to all related instances of the user.For more information about Users, visit the [Help Center](https://help.wheniwork.com/articles/user-access-privileges-computer/).
When I Work Users 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 Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 8 JSON Schemas.
This API exposes 12 operations across 8 paths, and defines 4 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 Users 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 12
Across 8 paths, the API surfaces 12 operations — 1 DELETE, 3 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
A person on the When I Work platform is associated with a two tier record. The persons email/password is associated to a personid. For each Workplace the person belongs to a useri…
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are components-schemas-User (28 properties), User (23 properties), AlertSetting (5 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.