Deputy · Schema
ShiftBidBidApproveResponse
Workforce ManagementEmployee SchedulingTime and AttendanceTimesheetsHuman ResourcesShift PlanningAustraliaScheduling
Properties
| Name | Type | Description |
|---|---|---|
| success | boolean | |
| data | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/deputy/json-schema/deputy-shift-bid-bid-approve-response-schema.json",
"title": "ShiftBidBidApproveResponse",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/deputy-bidapprove-api-openapi.yml#/components/schemas/ShiftBidBidApproveResponse",
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"$ref": "#/$defs/ShiftBidBidApproveResponseData"
}
},
"$defs": {
"ConsentConsentRecordType": {
"type": "string",
"enum": [
"SHIFT",
"TIMESHEET",
"REGULAR_SCHEDULE"
],
"default": "SHIFT"
},
"ConsentConsentStatus": {
"type": "string",
"enum": [
"PENDING",
"ACCEPTED",
"DECLINED",
"CANCELLED",
"OVERRIDDEN_ACCEPTED"
],
"default": "PENDING"
},
"ShiftBidBidApproveResponseData": {
"type": "object",
"properties": {
"shifts": {
"type": "array",
"items": {
"$ref": "#/$defs/tenantschedulev2modelShift"
}
}
}
},
"ShiftConsentChangesetShiftConsentAction": {
"type": "string",
"enum": [
"CREATE",
"MODIFY",
"DELETE"
],
"default": "CREATE"
},
"ShiftConsentChangesetShiftConsentChangesetData": {
"type": "object",
"properties": {
"start": {
"type": "string"
},
"end": {
"type": "string"
},
"approvalRequired": {
"type": "boolean"
},
"cost": {
"type": "number",
"format": "float"
},
"date": {
"type": "string"
},
"employee": {
"type": "integer",
"format": "int32"
},
"mealbreakSlotsUnpaidMinutes": {
"type": "number",
"format": "float"
},
"mealbreakSlots": {
"type": "array",
"items": {
"$ref": "#/$defs/modelBreak"
}
},
"isOpen": {
"type": "boolean"
},
"area": {
"type": "integer",
"format": "int32"
},
"duration": {
"type": "number",
"format": "float"
},
"location": {
"type": "integer",
"format": "int32"
}
}
},
"ShiftConsentChangesetShiftConsentStatus": {
"type": "string",
"enum": [
"PENDING",
"ACTIONED",
"AUTO_ACTIONED"
],
"default": "PENDING"
},
"modelBooleanField": {
"type": "object",
"properties": {
"value": {
"type": "boolean",
"default": "false"
}
}
},
"modelBreak": {
"type": "object",
"properties": {
"slotType": {
"$ref": "#/$defs/modelSlotType",
"title": "type of slot"
},
"start": {
"type": "integer",
"format": "int32",
"title": "can start break after seconds passed after shift start"
},
"end": {
"type": "integer",
"format": "int32",
"title": "can end break after seconds passed after shift start"
},
"state": {
"$ref": "#/$defs/modelBreakState",
"title": "Break state"
},
"canStartEarly": {
"type": "boolean",
"title": "[Deprecated] can employee start break early, override shift template"
},
"canEndEarly": {
"type": "boolean",
"title": "[Deprecated] can employee end break early, override shift template"
},
"isMandatory": {
"type": "boolean",
"title": "[Deprecated] is it mandatory to take this break, override shift template"
},
"type": {
"$ref": "#/$defs/tenantsharedv2modelBreakType",
"title": "type of break"
},
"typeLabel": {
"type": "string",
"title": "break type name in config"
},
"startDateTime": {
"type": "string",
"title": "format ISO8601 eg 2024-06-25T13:45:00+01:00"
},
"endDateTime": {
"type": "string",
"title": "format ISO8601 eg 2024-06-25T13:45:00+01:00"
}
}
},
"modelBreakState": {
"type": "string",
"enum": [
"NOT_START",
"IN_PROGRESS",
"FINISHED",
"DURATION_ONLY",
"DURATION_FINISHED"
],
"default": "NOT_START",
"title": "Break States"
},
"modelConfirmationStatus": {
"type": "string",
"enum": [
"ROSTER_CONFIRMATION_NOT_REQUIRED",
"ROSTER_CONFIRMATION_REQUIRED",
"ROSTER_CONFIRMATION_DONE",
"ROSTER_CONFIRMATION_DECLINED"
],
"default": "ROSTER_CONFIRMATION_NOT_REQUIRED"
},
"modelConsent": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"recordId": {
"type": "string"
},
"recordType": {
"$ref": "#/$defs/ConsentConsentRecordType"
},
"transactionId": {
"type": "string"
},
"employeeId": {
"type": "integer",
"format": "int32"
},
"status": {
"$ref": "#/$defs/ConsentConsentStatus"
},
"description": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/modelShiftTypeConsentMetadata"
},
"creator": {
"type": "integer",
"format": "int32"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"modelFileField": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int32"
}
}
},
"modelListField": {
"type": "object",
"properties": {
"value": {
"type": "string"
}
}
},
"modelMultiListField": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"modelShiftConsentChangeset": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"shiftId": {
"type": "integer",
"format": "int32"
},
"consentTransactionId": {
"type": "string"
},
"action": {
"$ref": "#/$defs/ShiftConsentChangesetShiftConsentAction"
},
"status": {
"$ref": "#/$defs/ShiftConsentChangesetShiftConsentStatus"
},
"newData": {
"$ref": "#/$defs/ShiftConsentChangesetShiftConsentChangesetData"
},
"oldData": {
"$ref": "#/$defs/ShiftConsentChangesetShiftConsentChangesetData"
},
"violatedRules": {
"type": "array",
"items": {
"$ref": "#/$defs/modelViolatedRules"
}
},
"creator": {
"type": "integer",
"format": "int32"
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"consents": {
"type": "array",
"items": {
"$ref": "#/$defs/modelConsent"
}
}
}
},
"modelShiftTypeConsentMetadata": {
"type": "object",
"properties": {
"comment": {
"type": "string"
},
"extras": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"modelSlotType": {
"type": "string",
"enum": [
"BREAK",
"WORK",
"CUSTOM"
],
"default": "BREAK",
"title": "Type of Slot"
},
"modelStringField": {
"type": "object",
"properties": {
"value": {
"type": "string"
}
}
},
"modelSwapStatus": {
"type": "string",
"enum": [
"SWAP_STATUS_NOT_REQUIRED",
"SWAP_STATUS_PENDING_OUT",
"SWAP_STATUS_PENDING_IN",
"SWAP_STATUS_PENDING_IN_OUT",
"SWAP_STATUS_PENDING_APPROVAL",
"SWAP_STATUS_APPROVED",
"SWAP_STATUS_CANCELLED",
"SWAP_STATUS_DECLINED"
],
"default": "SWAP_STATUS_NOT_REQUIRED"
},
"modelViolatedRules": {
"type": "object",
"properties": {
"ruleCode": {
"type": "string"
},
"warning": {
"$ref": "#/$defs/modelViolatedRulesWarning"
},
"ruleConfigs": {
"type": "array",
"items": {
"$ref": "#/$defs/modelViolatedRulesRuleConfig"
}
}
}
},
"modelViolatedRulesOperation": {
"type": "string",
"enum": [
"NOT_SPECIFIED",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_OR_EQUAL",
"LESS_THAN_OR_EQUAL",
"EQUAL",
"NOT_EQUAL"
],
"default": "NOT_SPECIFIED"
},
"modelViolatedRulesRuleConfig": {
"type": "object",
"properties": {
"field": {
"type": "string",
"title": "What field of roster is triggering the consent"
},
"operation": {
"$ref": "#/$defs/modelViolatedRulesOperation",
"title": "What operation is used for the consent checking"
},
"value": {
"type": "string",
"title": "The value of what is compared"
},
"gap": {
"type": "integer",
"format": "int32",
"title": "How many days different between the shifts"
},
"space": {
"type": "integer",
"format": "int32",
"title": "The duration from the next or previous shift to the current shift in seconds"
}
}
},
"modelViolatedRulesWarning": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"tenantschedulev2modelShift": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"title": "Shift ID"
},
"start": {
"type": "string",
"title": "Shift start time, format ISO8601 eg 2012-12-18T13:45:00+01:00"
},
"end": {
"type": "string",
"title": "Shift end time, format ISO8601 eg 2012-12-18T13:45:00+01:00"
},
"mealbreakDuration": {
"type": "number",
"format": "float",
"title": "Shift mealbreak stored in minutes"
},
"mealbreakSlots": {
"type": "array",
"items": {
"$ref": "#/$defs/modelBreak"
},
"title": "Shift break slots"
},
"duration": {
"type": "number",
"format": "float",
"title": "Total hours of shift works excluding mealbreak"
},
"cost": {
"type": "number",
"format": "float",
"title": "Shift total cost"
},
"area": {
"type": "integer",
"format": "int32",
"title": "Area Id where shift is allocated"
},
"employee": {
"type": "integer",
"format": "int32",
"title": "Employee ID the shift is assigned"
},
"note": {
"type": "string",
"title": "Notes or comments regarding the shift"
},
"warning": {
"type": "string",
"title": "Warning message"
},
"warningOverrideComment": {
"type": "string",
"title": "Details once warning message is overridden"
},
"isPublished": {
"type": "boolean",
"title": "If shift is published or not"
},
"timesheet": {
"type": "integer",
"format": "int32",
"title": "Timesheet ID connected to the shift"
},
"isOpen": {
"type": "boolean",
"title": "If shift is open or not"
},
"approvalRequired": {
"type": "boolean",
"title": "If approval is required or not"
},
"confirmationStatus": {
"$ref": "#/$defs/modelConfirmationStatus",
"title": "Shift confirmation status"
},
"confirmationNote": {
"type": "string",
"title": "Message displayed on confirmation"
},
"confirmedByWhom": {
"type": "integer",
"format": "int32",
"title": "Employee who confirmed the shift"
},
"confirmedAt": {
"type": "string",
"title": "Shift confirmation time, format ISO8601 eg 2012-12-18T13:45:00+01:00"
},
"swapStatus": {
"$ref": "#/$defs/modelSwapStatus",
"title": "Shift swap status once shift is opened for swap"
},
"swapApprovedBy": {
"type": "integer",
"format": "int32",
"title": "Shift Swap Manager ID"
},
"shiftTemplate": {
"type": "integer",
"format": "int32",
"title": "Shift Template ID"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/v2modelChildShift"
},
"title": "Child Shifts"
},
"canEdit": {
"type": "boolean",
"title": "Can edit this shift"
},
"customFields": {
"type": "array",
"items": {
"$ref": "#/$defs/tenantsharedv2modelCustomField"
},
"title": "Custom Fields"
},
"customFieldData": {
"type": "integer",
"format": "int32",
"title": "Custom Field Data ID"
},
"creator": {
"type": "integer",
"format": "int32",
"title": "Employee ID who created shift"
},
"createdAt": {
"type": "string",
"title": "When the shift was created, format ISO8601 eg 2012-12-18T13:45:00+01:00"
},
"modifiedAt": {
"type": "string",
"title": "When the shift was modified, format ISO8601 eg 2012-12-18T13:45:00+01:00"
},
"consentChangesets": {
"type": "array",
"items": {
"$ref": "#/$defs/modelShiftConsentChangeset"
},
"title": "Consent changeset data"
},
"areaName": {
"type": "string",
"title": "Area name"
},
"location": {
"type": "integer",
"format": "int32",
"title": "Location Id"
},
"locationName": {
"type": "string",
"title": "Location name"
}
},
"title": "Shift"
},
"tenantsharedv2modelBreakType": {
"type": "string",
"enum": [
"MEAL_BREAK",
"REST_BREAK"
],
"default": "MEAL_BREAK",
"title": "Break Type"
},
"tenantsharedv2modelCustomField": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"booleanField": {
"$ref": "#/$defs/modelBooleanField"
},
"stringField": {
"$ref": "#/$defs/modelStringField"
},
"listField": {
"$ref": "#/$defs/modelListField"
},
"multiListField": {
"$ref": "#/$defs/modelMultiListField"
},
"fileField": {
"$ref": "#/$defs/modelFileField",
"title": "file id"
},
"employeeVisible": {
"type": "boolean"
}
}
},
"v2modelChildShift": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"title": "Shift ID"
},
"start": {
"type": "string",
"title": "Shift start time, format ISO8601 eg 2012-12-18T13:45:00+01:00"
},
"end": {
"type": "string",
"title": "Shift end time, format ISO8601 eg 2012-12-18T13:45:00+01:00"
},
"cost": {
"type": "number",
"format": "float",
"title": "Shift total cost"
},
"area": {
"type": "integer",
"format": "int32",
"title": "Area Id where shift is allocated"
},
"canEdit": {
"type": "boolean",
"title": "Can edit this shift"
},
"parentId": {
"type": "integer",
"format": "int32",
"title": "Shift parent id"
},
"isOpen": {
"type": "boolean",
"title": "If shift is open or not"
},
"approvalRequired": {
"type": "boolean",
"title": "If approval is required or not"
},
"isPublished": {
"type": "boolean",
"title": "If shift is published or not"
},
"confirmationStatus": {
"$ref": "#/$defs/modelConfirmationStatus",
"title": "Child shift confirmation status"
},
"confirmedByWhom": {
"type": "integer",
"format": "int32",
"title": "Employee who confirmed the child shift"
},
"confirmedAt": {
"type": "string",
"title": "Shift confirmation time, format ISO8601 eg 2012-12-18T13:45:00+01:00"
},
"creator": {
"type": "integer",
"format": "int32",
"title": "Employee ID who created shift"
},
"createdAt": {
"type": "string",
"title": "When the shift was created, format ISO8601 eg 2012-12-18T13:45:00+01:00"
},
"modifiedAt": {
"type": "string",
"title": "When the shift was modified, format ISO8601 eg 2012-12-18T13:45:00+01:00"
},
"warning": {
"type": "string"
},
"warningOverrideComment": {
"type": "string"
},
"areaName": {
"type": "string",
"title": "Area name"
},
"location": {
"type": "integer",
"format": "int32",
"title": "Location Id"
},
"locationName": {
"type": "string",
"title": "Location name"
}
},
"title": "Child Shift"
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/deputy-shift-bid-bid-approve-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.