Get Employee Login Link

Retrieve a link that automatically signs in an employee and redirects them to their Zeal Employee Dashboard in which they can see/download their paystubs. This link (and dashboard) will be hosted on your custom domain. When an employee logs out of the dashboard, they will be redirected to the Base URL from your Settings page.

The link fetched only works in Live Mode (does not work for employees in Test Mode).
If success: true, url field contains the Employee Login Link.
If success: false, errors field contains an array of error objects

attribute

type

description

success

boolean

Response status

data

object

Contains newly created Employee Login Link

errors

array

Contains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes

Language
Authentication
Header
Click Try It! to start a request and see the response here!