# When I Work Import API

**Canonical:** https://apis.io/apis/when-i-work/when-i-work-import-api/  
**Provider:** When I Work — https://apis.io/providers/when-i-work/  
**Base URL:** https://api.wheniwork.com/2  
**Documentation:** https://apidocs.wheniwork.com/external/index.html

When I Work Import API is one of 22 APIs that [When I Work](https://apis.io/providers/when-i-work/) publishes on the [APIs.io](https://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.

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 here. Where possible, the column names will align with names used elsewhere in the API, but this is not always possible. <table> <thead> <tr> <th>type</th> <th>columns</th> <th>required?</th> <th>notes</th> </tr> </thead> <tbody> <tr> <td rowspan="5" class="nowrap"><code>SHIFT_TEMPLATE</code></td> <td>start_time</td> <td>✅</td> <td></td> </tr> <tr> <td>end_time</td> <td>✅</td> <td></td> </tr> <tr> <td>schedule</td> <td></td> <td> <p>A schedule name to associate with the shift template. If no schedule with that name exists, a new schedule will be created.</p> <p>If omitted, the shift template will be assigned to all schedules (or the value "All Schedules" can be provided to do the same).</p> </td> </tr> <tr> <td>position</td> <td></td> <td> <p>A position name to associate with the shift template. If no position with that name exists, a new position will be created.</p> </td> </tr> <tr> <td>unpaid_break</td> <td></td> <td>The length of the unpaid break in minutes.</td> </tr> <tr> <td rowspan="12" class="nowrap"><code>EMPLOYEE</code></td> <td>first_name</td> <td>✅</td> <td>First name of the employee</td> </tr> <tr> <td>last_name</td> <td>✅</td> <td>Last name of the employee</td> </tr> <tr> <td>email</td> <td></td> <td>The email address of the employee</td> </tr> <tr> <td>employee_code</td> <td></td> <td>The employee code to associate with the employee</td> </tr> <tr> <td>file_number</td> <td></td> <td>The file number corresponding to the employee in ADP</td> </tr> <tr> <td>id</td> <td></td> <td>The user id corresponding to the employee in When I Work</td> </tr> <tr> <td>location</td> <td></td> <td> <p>A schedule (location) name to associate with the employee. If no schedule with that name exists, a new schedule will be created.</p> </td> </tr> <tr> <td>max</td> <td></td> <td>The maximum hours per week of the employee</td> </tr> <tr> <td>phone</td> <td></td> <td>The phone number of the employee</td> </tr> <tr> <td>position</td> <td></td> <td> <p>A position name to associate with the employee. If no position with that name exists, a new position will be created.</p> </td> </tr> <tr> <td>tags</td> <td></td> <td> <p>A comma separated list of tags to associate to the employee. If the tag does not exist, it will be created.</p> </td> </tr> <tr> <td>wage</td> <td></td> <td> <p>The hourly rate of the employee expressed as a floating point number (e.g. 14.50)</p> </td> </tr> </tbody> </table>

## Machine-readable artifacts (16)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/openapi/when-i-work-import-api-openapi.yml
- **Documentation** — https://apidocs.wheniwork.com/external/index.html
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-shift-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-user-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-time-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-position-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-schedule-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-site-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-schema/when-i-work-shifttemplate-schema.json
- **Examples** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/examples/when-i-work-examples.json
- **Vocabulary** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/vocabulary/when-i-work-vocabulary.yml
- **JSONLDContext** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/json-ld/when-i-work-context.jsonld
- **Plans** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/plans/when-i-work-plans-pricing.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/rate-limits/when-i-work-rate-limits.yml
- **FinOps** — https://raw.githubusercontent.com/api-evangelist/when-i-work/refs/heads/main/finops/when-i-work-finops.yml

## Other When I Work APIs (12)

- [When I Work Accounts API](https://apis.io/apis/when-i-work/when-i-work-accounts-api/)
- [When I Work Annotations API](https://apis.io/apis/when-i-work/when-i-work-annotations-api/)
- [When I Work Availabilities API](https://apis.io/apis/when-i-work/when-i-work-availabilities-api/)
- [When I Work OpenShift Requests API](https://apis.io/apis/when-i-work/when-i-work-openshift-requests-api/)
- [When I Work Payrolls API](https://apis.io/apis/when-i-work/when-i-work-payrolls-api/)
- [When I Work Positions API](https://apis.io/apis/when-i-work/when-i-work-positions-api/)
- [When I Work Punch API](https://apis.io/apis/when-i-work/when-i-work-punch-api/)
- [When I Work Request Type API](https://apis.io/apis/when-i-work/when-i-work-request-type-api/)
- [When I Work Schedule Templates API](https://apis.io/apis/when-i-work/when-i-work-schedule-templates-api/)
- [When I Work Schedules (Locations) API](https://apis.io/apis/when-i-work/when-i-work-schedules-locations-api/)
- [When I Work Shift Break - Paid Rest API](https://apis.io/apis/when-i-work/when-i-work-shift-break-paid-rest-api/)
- [When I Work Shift Breaks API](https://apis.io/apis/when-i-work/when-i-work-shift-breaks-api/)

## Tags

Import

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/when-i-work/when-i-work-import-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/when-i-work/.