User Login

🚧

This endpoint is designated for use by our Marketplace Partners only at this time

The intended purpose of this endpoint is to assist with the integration of third party partners. To this end, the below mentioned, "Application Key" is not available for general use.

Sample Request

Headers:

Content-Type - application/x-www-form-urlencoded

Post Variables:

user - The user's email address.
password - The user's password.
applicationKey - The application key provided to you by BambooHR.
deviceId - Optional - An ID for the user's mobile device. This deviceId can be generated when the app is first installed on a device, and should be unique enough to prevent collisions between users within the same company.

Sample Response

Success:

{
    "success":true,
    "userId":1,
    "employeeId":25,
    "key":"e254c96d97a12dc561f56d8713e58ac6c2a8c166"
}

Fail:

{
    "success":false,
}

Success:

<auth>
 <response>authenticated</response>
 <userId>1</userId>
 <employeeId>25</employeeId>
 <key>e254c96d97a12dc561f56d8713e58ac6c2a8c166</key>
</auth>

Fail:

<auth>
 <response>declined</response>
</auth>