How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 User. 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.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.wheniwork.com.

12 operations 8 paths 4 schemas 1 DELETE3 GET7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.wheniwork.com/2
Authentication
HTTP Bearer
Resource Areas
1

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.

Users 12

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…

GET
/2/users
List Users
get2Users 6 params → 200
POST
/2/users
Create User
post2Users body → 200
GET
/2/users/{id}
Get User
get2UsersById 1 param → 200
PUT
/2/users/{id}
Update User
put2UsersById 1 param body → 200
DELETE
/2/users/{id}
Delete User
delete2UsersById 2 params → 200
POST
/2/users/avatar/{id}
Create/Update user avatar
post2UsersAvatarById 2 params body → 200
POST
/2/users/bulkupdate
Create A Batch of Users
post2UsersBulkupdate body → 200
GET
/2/users/profile
Get User Profile
get2UsersProfile → 200
POST
/2/users/profile
Update User Profile
post2UsersProfile body → 200
POST
/2/users/alerts
Update User Alert Settings
post2UsersAlerts body → 200
POST
/2/users/invite
Invite users
post2UsersInvite body → 200
POST
/2/users/invite/{id}
Invite single user
post2UsersInviteById 1 param body → 200

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.

User
object
23 properties
components-schemas-User
object
28 properties
BulkUserResponse
Response for both Valid/Invalid requests
AlertSetting
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

when-i-work-users-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
Where this information came from

This is an independent, third-party profile of When I Work Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.