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

The import API is used to import a variety of When I Work resources from user-provided CSV or Excel files.### Import TypesAll available import types and their columns are listed here. Where possible, the column names will align with names used elsewhere in the API, but this is not always possible. type columns required? notes SHIFT_TEMPLATE start_time ✅ end_time ✅ schedule A schedule name to associate with the shift template. If no schedule with that name exists,a new schedule will be created. If omitted, the shift template will be assigned to all schedules (or the value "All Schedules"can be provided to do the same). position A position name to associate with the shift template. If no position with that name exists,a new position will be created. unpaid_break The length of the unpaid break in minutes. EMPLOYEE first_name ✅ First name of the employee last_name ✅ Last name of the employee email The email address of the employee employee_code The employee code to associate with the employee file_number The file number corresponding to the employee in ADP id The user id corresponding to the employee in When I Work location A schedule (location) name to associate with the employee. If no schedule with that nameexists, a new schedule will be created. max The maximum hours per week of the employee phone The phone number of the employee position A position name to associate with the employee. If no position with that name exists,a new position will be created. tags A comma separated list of tags to associate to the employee. If the tag does not exist,it will be created. wage The hourly rate of the employee expressed as a floating point number (e.g. 14.50)

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

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

4 operations 4 paths 4 schemas 1 GET3 POST

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 Import 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 4

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

Import 4

The import API is used to import a variety of When I Work resources from user-provided CSV or Excel files. Import Types All available import types and their columns are listed her…

POST
/2/import
Create Import
body → 200
GET
/2/import/{id}
Get Import
1 param → 200
POST
/2/import/{id}/preview
Preview Import
body → 200
POST
/2/import/{id}/finalize
Finalize Import
body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Import (4 properties), EmployeeExtra (1 property). Each schema is shown below with its type and property counts.

EmployeeExtra
object
1 property
ColumnMappingsRequest
object
A mapping from When I Work column names to user column names. The keys should be When I Work column names that are valid for the current import's type; see the…
ImportType
string
The type of resource to be imported. Determines the column names that appear throughout the process. A full list of accepted column names for each type can be…
Import
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

when-i-work-import-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 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