Employee - GET

Helps to get all your employee information.

Request

Headers

Key	Details	Example
Authorization*	{token_type} {access_token}	Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f
Method*	GET	GET
x-accept-version	{recommended_latest_version_number}	2
employeeIds	{comma_separated_employeeId}	1,2,4 //Returns all if not supplied

* Required header

Response

Headers

Key	Details	Data Type	Example
statusCode	Very important to check this for shopwave server uptime. 200 for success.	int	200

Body

Key	Details	Data Type
employees[{employeeId}].id	Unique identifier for an employee.	int
employees[{employeeId}].firstName	First Name of an employee	string
employees[{employeeId}].lastName	Last name of an employee	string
employees[{employeeId}].email	Email address of an employee	string
employees[{employeeId}].roleId	Check the employee role table for details	int
employees[{employeeId}].joinedDate	YYYY-MM-DDTHH:ii:ss.mmmZ format of employee joined date	Datetime
employees[{employeeId}].exitDate	YYYY-MM-DDTHH:ii:ss.mmmZ format of employee exit date	datetime

Attribute Options

Role Id

ID	Value
1	Owner
2	Manager
3	Assistant
4	Guest
5	Assistant Manager

Status Codes

Error

Please check the live API calls for more details on the API messages.

ID	Status Code	Title	Details
908	401	Expired Token	Token expired or invalid. Please renew your token
911	401	Authorization Header Invalid	The authorization header is invalid. The correct format is Authorization: {token_type} {accessToken}
899	500	Unknown Error	Something went wrong. Please contact the site administrator

Success

Please check the live API calls for more info on the API messages.

ID	Status Code	Title	Details
203	200	Request Processed Successfully	The request has been successfully completed.
202	200	Token is valid	Token is validated and found valid.
204	204	No content to return	End of the page or no content to return for your request