Raw schema
{
"type": "object",
"properties": {
"object": {
"type": "string",
"enum": [
"Address",
"Category",
"Comment",
"Company",
"CompanyPeriod",
"Contact",
"Country",
"CustomField",
"CustomFieldData",
"Employee",
"EmployeeAgreement",
"EmployeeAgreementHistory",
"EmployeeAppraisal",
"EmployeeAvailability",
"EmployeeContractedHours",
"EmployeeHistory",
"EmployeePaycycle",
"EmployeePaycycleReturn",
"EmployeeRole",
"EmployeeWorkplace",
"EmploymentCondition",
"EmploymentContract",
"EmploymentContractLeaveRules",
"Event",
"Journal",
"Leave",
"LeaveAccrual",
"LeavePayLine",
"LeaveRules",
"Memo",
"OperationalUnit",
"PayPeriod",
"PayRules",
"PublicHoliday",
"Roster",
"RosterOpen",
"RosterSwap",
"RosterTemplate",
"SalesData",
"Schedule",
"ShiftTemplate",
"State",
"StressProfile",
"Task",
"TaskGroup",
"TaskSetup",
"Team",
"Timesheet",
"TimesheetExport",
"TimesheetPayReturn",
"TimesheetPayReturnDetail",
"TrainingModule",
"TrainingRecord"
],
"description": "Resource API object. Deputy names: Company = location, OperationalUnit = area, Roster = shift, LeaveRules = leave types, TimesheetPayReturn = approved pay lines."
},
"search": {
"description": "Clauses keyed by any id (s1, s2, โฆ). All must match.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Field name, e.g. Employee, Date, StartTime."
},
"data": {
"description": "Comparison value; type depends on the field."
},
"type": {
"type": "string",
"enum": [
"eq",
"ne",
"gt",
"lt",
"ge",
"le",
"is",
"is not",
"in",
"not in",
"starts",
"contains"
],
"description": "Comparison operator."
}
},
"required": [
"field",
"data",
"type"
]
}
},
"sort": {
"description": "Field โ asc/desc, e.g. {\"Id\":\"desc\"}.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"join": {
"description": "Related objects to expand inline, e.g. [\"TimesheetObject\"] on TimesheetPayReturn.",
"type": "array",
"items": {
"type": "string"
}
},
"start": {
"description": "Pagination offset (0-based). Pass the previous page's next_start.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"max": {
"description": "Page size, 1-500 (Deputy's cap). Default 100.",
"type": "integer",
"minimum": 1,
"maximum": 500
}
},
"required": [
"object"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}