Workforce Engagement

Simplified

The When I Work^® API is thorough, flexible, and restful. It's methods are logically grouped, and follow standard conventions. Make a selection below to jump to the method group you would like to know more about. Use the Jump menu at the top to move from topic to topic.

If you have questions or would like an API Developer Key please contact us.

Server authentication is based on a token model. The developer with authenticate using a private developer key, along with the user's credentials. This will return back a token that can be use for all further requests. The token may be included in the headers, as a cookie or in the query string using the key W-Token

W-Token: 34b4be9dd746952....7b27b593a4004b3d3dbaf

In order to get this token, you must make the following request:
POST https://api.wheniwork.com/2/login
with some sample data:

{
    "key": "your_developer_key",
    "username": "email@address.com",
    "password": "password1"
}

For more information on how to get the token using the Login method, see Login Method.

All requests are rate limited. You can perform 100 requests/minute for the same user on the same developer key. Unauthenticated requests will use the IP instead of user to rate limit. You may check how many requests you have left using the W-Limit-Remaining header:

W-Limit-Remaining: 87

Once you have reached your limit, you will receive a 429 Too Many Requests response with a message telling your how many seconds to wait. in this case W-Limit-Remaining will be 0.