ReadySetWork - Data API

Log In
Welcome Back!

API

Please contact your account representative or call us at 1 (877) 507-3706 for your API key.

Method:GET

URL:https://www.readysetwork.com/rswapi/employees?apiKey={YOUR-API-KEY}

Description:
This endpoint returns the employee(s) details for an account. When none of the optional parameters are passsed it returns all employees in the account.

Parameters:
Name	Required	Description
apiKey	Yes	used to establish connection to a RSW account
empId	No	used to filter the result set by employee id.
status	No	used to filter by "active" or "inactive" employees

Response:

                            [
                                {
                                    "rswId": 1135,
                                    "name": "Molly Manager",
                                    "firstName": "Molly",
                                    "lastName": "Manager",
                                    "timeClockId": null,
                                    "phone": "",
                                    "email": "",
                                    "communicationPreference": "None",
                                    "status": "active",
                                    "customID": ""
                                },
                                {
                                    "rswId": 1136,
                                    "name": "Jacob Dreyfuss",
                                    "firstName": "Jacob",
                                    "lastName": "Dreyfuss",
                                    "timeClockId": null,
                                    "phone": "2158960119",
                                    "email": "jacob.dreyfuss@readysetwork.com",
                                    "communicationPreference": "Email",
                                    "status": "active",
                                    "customID": ""
                                },
                                {
                                    "rswId": 1138,
                                    "name": "Christian Anderson",
                                    "firstName": "Christian",
                                    "lastName": "Anderson",
                                    "timeClockId": null,
                                    "phone": "",
                                    "email": "christian_anderson@readysetwork.com",
                                    "communicationPreference": "Email",
                                    "status": "active",
                                    "customID": ""
                                },
                                {
                                    "rswId": 1141,
                                    "name": "Theodore Coyle",
                                    "firstName": "Theodore",
                                    "lastName": "Coyle",
                                    "timeClockId": null,
                                    "phone": null,
                                    "email": "theodore@readysetwork.com",
                                    "communicationPreference": "Email",
                                    "status": "active",
                                    "customID": ""
                                }
                            ]

Method:GET

URL:https://www.readysetwork.com/rswapi/employeeschedules?apiKey={YOUR-API-KEY}

Description:
This endpoint returns a collection of employees and their shifts as JSON objects. It has one mandatory parameter and three optional parameters. The apikey is the mandatory parameter, and if it is the only parameter provided, only shifts greater than the current date are included. Only employees who have shifts are included in the result set. The startDate and endDate are optional parameters which serve as bounding dates for the shifts to be returned. The scheduleName is also an optional parameter used to filter by schedules (locations).

Parameters:
Name	Required	Description
apiKey	Yes	used to establish connection to a RSW account
startDate	No	lower bound for the date range of shifts, if less than the current date, the current date is used instead. E.g. 12/01/2013
endDate	No	upper bound for the date range of shifts.
scheduleName	No	Name of the Schedule(Location).

Response:

                            [
                                {
                                "employee": {
                                    "rswId": 1246
                                    "name": "Joseph Banks",
                                    "firstName": "Joseph",
                                    "lastName": "Banks",
                                    "timeClockId": null,
                                    "phone": null,
                                    "email": "jb1@readysetwork.com",
                                    "communicationPreference": "Email",
                                    "status": "active",
                                    "customID": ""
                                },
                                "shifts": [
                                    {
                                    "schedule": "1'st Schedule Name",
                                    "timezone": "Eastern Standard Time",
                                    "name": "Morning",
                                    "job": "Nurse",
                                    "startDateTime": "/Date(1386333000000)/",
                                    "formattedStartTime": "Friday, December 06, 2013 7:30 AM",
                                    "endDateTime": "/Date(1386358200000)/",
                                    "formattedEndTime": "Friday, December 06, 2013 2:30 PM"
                                    },
                                    {
                                    "schedule": "1'st Schedule Name",
                                    "timezone": "Eastern Standard Time",
                                    "name": "Afternoon",
                                    "job": "Trainee",
                                    "startDateTime": "/Date(1386363600000)/",
                                    "formattedStartTime": "Friday, December 06, 2013 4:00 PM",
                                    "endDateTime": "/Date(1386374400000)/",
                                    "formattedEndTime": "Friday, December 06, 2013 7:00 PM"
                                    }
                                ]
                                },
                                {
                                "employee": {
                                    "rswId": 1138
                                    "name": "Christian Anderson",
                                    "firstName": "Christian",
                                    "lastName": "Anderson",
                                    "timeClockId": null,
                                    "phone": "1234567890",
                                    "email": "somebody@gmail.com",
                                    "communicationPreference": "Text Message",
                                    "status": "active",
                                    "customID": ""
                                },
                                "shifts": [
                                    {
                                    "schedule": "1'st Schedule Name",
                                    "timezone": "Eastern Standard Time",
                                    "name": "Pullover",
                                    "job": "Nurse",
                                    "startDateTime": "/Date(1386468000000)/",
                                    "formattedStartTime": "Saturday, December 07, 2013 9:00 PM",
                                    "endDateTime": "/Date(1386489600000)/",
                                    "formattedEndTime": "Sunday, December 08, 2013 3:00 AM"
                                    }
                                ]
                                }
                            ]

Method:GET

URL:https://www.readysetwork.com/rswapi/employeetimeoffs?apiKey={YOUR-API-KEY}

Description:
This endpoint returns a collection of employees and their time-off requests as JSON objects. It has one mandatory parameter and three optional parameters. The apikey is the mandatory parameter, and if it is the only parameter provided, only time-off requests greater than the current date are included. Only employees who have made time off requests are included in the result set. The startDate and endDate are optional parameters which serve as bounding dates for the time-off requests to be returned. The empId is also an optional parameter used to filter by employee.

Parameters:
Name	Required	Description
apiKey	Yes	used to establish connection to a RSW account
startDate	No	lower bound for the date range of shifts, if less than the current date, the current date is used instead. E.g. 12/01/2013
endDate	No	upper bound for the date range of shifts.
empId	No	used to filter the result set by employee id.

Response:

                            [
                                {
                                    "employee": {
                                        "rswId": 1138,
                                        "name": "Christian Anderson",
                                        "firstName": "Christian",
                                        "lastName": "Anderson",
                                        "timeClockId": null,
                                        "phone": "",
                                        "email": "christiananderson@readysetwork.com",
                                        "communicationPreference": "Email",
                                        "status": "active",
                                        "customID": ""
                                    },
                                    "timeoffs": [
                                        {
                                            "timeOffFrom": "Thursday, April 03, 2014 12:00 AM",
                                            "timeOffTo": "Thursday, April 03, 2014 11:59 PM",
                                            "statusId": 1,
                                            "status": "New",
                                            "notes": "I'm going to a concert"
                                        },
                                        {
                                            "timeOffFrom": "Sunday, March 02, 2014 12:00 AM",
                                            "timeOffTo": "Sunday, March 02, 2014 11:59 PM",
                                            "statusId": 1,
                                            "status": "New",
                                            "notes": "I can't make it this day"
                                        },
                                        {
                                            "timeOffFrom": "Tuesday, February 25, 2014 12:00 AM",
                                            "timeOffTo": "Tuesday, February 25, 2014 11:59 PM",
                                            "statusId": 1,
                                            "status": "New",
                                            "notes": "Family vacation"
                                        }
                                    ]
                                },
                                {
                                    "employee": {
                                        "rswId": 11832,
                                        "name": "Theodore Coyle",
                                        "firstName": "Theodore",
                                        "lastName": "Coyle",
                                        "timeClockId": null,
                                        "phone": null,
                                        "email": "theodore_coyle@readysetwork.com",
                                        "communicationPreference": "Email",
                                        "status": "active",
                                        "customID": ""
                                    },
                                    "timeoffs": [
                                        {
                                            "timeOffFrom": "Saturday, March 08, 2014 12:00 AM",
                                            "timeOffTo": "Sunday, March 09, 2014 11:59 PM",
                                            "statusId": 2,
                                            "status": "Approved",
                                            "notes": ""
                                        }
                                    ]
                                }
                            ]