Supported MethodsSupported Parameters
GET, POST, PATCHId, name, page, pageSize, modTimeStart, modTimeEnd, isActive, isDeleted
{
	"ID": "",
	"Name": "",
	"FirstName": "",
	"LastName": "",
	"Address": {
		"Line1": "",
		"Line2": "",
		"Line3": "",
		"Line4": "",
		"Line5": "",
		"City": "",
		"State": "",
		"PostalCode": "",
		"Country": ""
	},
	"Email": "",
	"IsActive": true,
	"Number": "",
	"HireDate": "2023-01-09T15:34:09Z",
	"Salutation": "",
	"MiddleName": "",
	"Suffix": "",
	"Phone": "",
	"Mobile": "",
	"AlternatePhone": "",
	"Department": "",
	"SSN": "",
	"JobTitle": "",
	"CustomFields": [{
		"FullName": "",
		"Value": ""
	}],
	"ExemptStatus": "",
	"Earnings": [{
		"Item": {
			"ID": "",
			"Name": ""
		},
		"Rate": 0.0
	}],
	"SickHours": {
		"AccrualPeriod": "",
		"HoursAvailable": "",
		"HoursAccrued": "",
		"MaximumHours": "",
		"ResetEachYear": true,
		"HoursUsed": "",
		"AccrualStartDate": "2023-01-09T15:34:09Z"
	},
	"Type": "",
	"UseTimeDataToCreatePaychecks": true,
	"DateOfBirth": "01/09/2023",
	"Class": {
		"ID": "",
		"FullName": ""
	},
	"CreatedDate": "2023-01-09T15:34:09Z",
	"LastModifiedDate": "2023-01-09T15:34:09Z",
	"PayPeriod": "",
	"Supervisor": {
		"Name": "",
		"ID": ""
	},
	"EmploymentType": "",
	"VacationHours": {
		"HoursAvailable": "",
		"AccrualPeriod": "",
		"HoursAccrued": "",
		"MaximumHours": "",
		"ResetEachYear": true,
		"HoursUsed": "",
		"AccrualStartDate": "2023-01-09T15:34:09Z"
	},
	"DeletedDate": "2023-01-09T15:34:09Z",
	"MiddleInitial": ""
}

Important Notes

POST/PATCH not supported for the following:

  • SSN (supported for POST but not PATCH)
  • PayPeriod
  • Supervisor.Name
  • Supervisor.ID
  • EmploymentType
  • VacationHours.HoursAvailable
  • VacationHours.AccrualPeriod
  • VacationHours.HoursAccrued
  • VacationHours.MaximumHours
  • VacationHours.ResetEachYear
  • VacationHours.HoursUsed
  • VacationHours.AccrualStartDate