Classic Operation Definitions
Warning
The endpoints listed in the first column of the table below are no longer recommended for new integrations due to outdated processing logic and data contracts. For more information on current endpoints and data models, see Staff - Operation Definitions.
Contact Genius Technical Support for transition assistance or questions.
Use the recommended alternatives described below:
Old Endpoint | Description | Recommended Alternative |
|---|---|---|
GET /Lookup/CompensationType | The GET Compensation Type endpoint returns a list of available compensation types from Data Management, which are not displayed on the user interface (UI). | POST /External/General/Employee/[ID]/Jobs Use the static default values used in this endpoint. |
POST /Staff/Employee | The Add Employee operation creates a new employee record on our platform. | |
GET /Lookup/WorkType | The Get All Work Types operation returns a list of the kinds of work that an employee clocks in and out of during a shift. | GetExternalGeneralPayrollGetUpdatesResponseBody Use the static default values described in this data model. |
POST /Staff/Shift/ShiftWorkTime | A punch record tracks an employees clock in and clock out actions over the course of a shift. Create a punch record for each shift and update it as the shift progresses. | |
POST /Staff/Employee/EmployeeDetail | This endpoint works with one employee record only. Use this endpoint to create employee data for a single employee, including Employee Site Statuses and POS Credentials. | |
GET /Staff/Employee/EmployeeDetail | Use the Request Employee Data endpoint to receive data for all previously created employees. This is useful when updating employee records. | To request information about a single employee, use GET /External/General/Employee/[ID]. To request information about employees for the whole company or specific site(s), use GET /External/General/Employee. To request information about employees based on the To pull all employees for the whole company or specific site(s) that have been updated since a specific timeframe, use GET /External/General/Employee/GetUpdates. |
PUT /Staff/EmployeeSiteStatus/BulkUpdate | This endpoint is used to create, update, or delete employee site status information in bulk. | To create a single employee together with site statuses, use POST /External/General/Employee. To update specified employee data, such as employee status changes, use PATCH /External/General/Employee/[ID]. |
PUT /Staff/EmployeeJob/UpdateAll | This endpoint is used to create and update employee job data together with a corresponding employee’s rate information. It allows multiple job updates in one request. | To create jobs for a specific employee, use POST /External/General/Employee/[ID]/Jobs. To update a specific employee's job, use PATCH /External/General/Employee/[ID]/Job/[ID]. To delete an incorrect employee's job, use DELETE /External/General/Employee/[ID]/Job/[ID]. |
PUT /Staff/Employee/EmployeeDetail | This endpoint updates employee data, including Employee Site Statuses and POS Credentials. | |
POST /Staff/EmployeeAddress | This endpoint provides the ability to create one employee address at a time. This operation does not allow several addresses to be used for the same employee with the same Address Type. | |
GET /Lookup/AddressType | This endpoint returns a list of available address types from Data Management, which are not displayed on the UI. | POST /External/General/Employee → EmployeeAddresses Array Use the static default values described in this endpoint and array. |
PUT /Staff/EmployeeAddress/<ID> | This endpoint provides the ability to update one employee address at a time. This operation does not allow several addresses to be used for the same employee with the same Address Type. | |
DELETE /Staff/EmployeeAddres/[ID] | This endpoint provides the ability to delete one employee address at a time. | |
POST /Staff/EmployeeEmail | This endpoint provides the ability to create one employee email record at a time. | |
GET /Lookup/EmailType | This endpoint returns a list of available email types from Data Management, which are not displayed on the UI. | POST /External/General/Employee → Employee Emails Array Use the static default values described in this endpoint and array. |
PUT /Staff/EmployeeEmail/[ID] | This endpoint provides the ability to update one employee email record at a time. | |
DELETE /Staff/EmployeeEmail/[ID] | This endpoint provides the ability to delete one employee email record at a time. | |
POST /Staff/EmployeePhone | This endpoint provides the ability to create one employee phone record at a time. | |
GET /Lookup/PhoneType | This endpoint returns a list of available phone type from Data Management, which are not displayed on the UI. | POST /External/General/Employee → EmployeePhones Array Use the static default values described in this endpoint and array. |
PUT /Staff/EmployeePhone/[ID] | This endpoint provides the ability to update one employee phone record at a time. | |
DELETE /Staff/EmployeePhone/[ID] | This endpoint provides the ability to delete one employee phone record at a time. | |
POST /Staff/EmployeeContact | This endpoint provides the ability to create one employee contact record at a time. | |
PUT /Staff/EmployeeContact/[ID] | This endpoint provides the ability to update one employee contact record at a time. | |
DELETE /Staff/EmployeeContact/[ID] | This endpoint provides the ability to delete one employee contact record at a time. | |
GET /Staff/JobCodeRate | This endpoint returns a list of available rate ranges for specific Job Code records and defined compensation types ( | This operation is no longer used. |