When I Work Payrolls API
Payrolls allows you to select a pay period date range and hours worked within that range. Default range if not supplied is today + 3 days.> Please note that payrolls cannot be created or deleted via the APIFor more info about managing Payroll, visit the [Help Center](https://help.wheniwork.com/articles/close-and-export-payroll/).
When I Work Payrolls 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 Payrolls. 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 11 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 Payrolls 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 — 4 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Payrolls allows you to select a pay period date range and hours worked within that range. Default range if not supplied is today + 3 days. Please note that payrolls cannot be crea…
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Shift (30 properties), Time (27 properties), Absence (16 properties), Punch (16 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.