Employees

GET/locations/:locationId/employees

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/employees

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//employees' \
--header 'x-api-key;'

Retrieves all employees for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of employee objects. Each object in the array will be structured as follows:

Field Name	Field Type	Field Description	Org Level Attribute*
id	string	The unique ID for the employee.	Yes
locationID	string	The unique ID for the location.
firstName	string	The employee's first name.	Yes
lastName	string	The employee's last name.	Yes
email	string	The employee's email address.	Yes
nickName	string	The employee's nickname.	Yes
address	ADDRESS	The employee's address. See example for structure.	Yes
birthDate	string	An RFC 3339 formatted date representing the employee's birth date. May be null.	Yes
hireDate	string	An RFC 3339 formatted date representing the employee's hire date. May be null.	Yes
terminationDate	string	An RFC 3339 formatted date representing the employee's termination date. May be null.	Yes
loginCode	string	The employee's POS FOH login code.
payrollId	string	The employee's optional payroll ID.
active	boolean	True if the employee is as active at the location.
posUserId	string	The employee ID field is the same at all locations the employee works at, but the posUserID field will be unique for each location.
deleted	boolean	True if the employee is as flagged as deleted.	Yes
excludeFromReporting	boolean	If true, this employee should be excluding for reporting purposes. Whether or not a API Consumer honors this flag will likely vary by application.	Yes
jobPositions	[]JOBPOSITION	An array of job positions that the employee holds (or has held) at the location.

ADDRESS

Field Name	Field Type	Field Description	Org Level Attribute*
street1	string	Street address line 1	Yes
street2	string	Street address line 2	Yes
city	string	City	Yes
state	string	State	Yes
zip	string	Zip Code	Yes
phone	string	Phone number. Note that the value is just as the user typed it (so formatting can vary).	Yes

JOBPOSITION

Field Name	Field Type	Org Level Attribute*
jobPositionId	The unique ID of the job position that the employee clocked in under.	Yes
jobPositionName	The name of the job position.	Yes
payRateAmount	The hourly pay rate for the employee/job position combination.
active	"true" if the employee currently holds this job position at the location.

DOLLARAMOUNT

An amount in US dollars expressed as a decimal number string. For example, $1.10 will be represented as "1.1".

📘

Note that the values of fields marked as "Org Level Attribute" are shared amongst all locations that reside in the same POS organization.

Example Response

[
   {
        "id": "abc123",
        "locationID": "LocationX",
        "firstName": "Mark",
        "lastName": "Nalepka",
        "email": "[email protected]",
        "nickName": "Markis",
        "address": {
            "street1": "1242 Selma",
            "street2": "",
            "city": "Westland",
            "state": "MI",
            "zip": "48185",
            "phone": "1112223333"
        },
        "birthDate": "1969-08-23T00:00:00Z",
        "hireDate": "2015-06-01T00:00:00Z",
        "terminationDate": null,
        "payrollId": "123456",
        "active": true,
        "deleted": false,
        "excludeFromReporting": false,
        "jobPositions": []
    }
]

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location

GET /locations/:locationId/employees/:employeeId

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/employees/:employeeId

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//employees/' \
--header 'x-api-key;'

Retrieves a single employee for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a single JSON employee object. See the parent route's documentation for more details.

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location
employeeId	The unique ID for the employee