--- updatedAt: 2026-05-03T08:13:15.000Z --- Fetch the complete documentation index at: https://developer.connecteam.com/llms.txt. Use this file to discover all available pages before exploring further. # Get pay rates Retrieves pay rate information for one or more users within your organization. This endpoint supports flexible filtering by effective dates, rate types, and resource assignments. It's designed for payroll integration scenarios where you need to fetch pay rates for multiple employees at once. The response includes historical modification data when requested, allowing you to track changes over time for audit and compliance purposes. Pagination is supported for large result sets. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Connecteam API documentation", "version": "v1" }, "servers": [ { "url": "https://api.connecteam.com/" } ], "paths": { "/pay-rates/v1/pay-rates": { "get": { "tags": [ "Pay Rates:v1:Pay Rates:v1:PayRates" ], "summary": "Get pay rates", "description": "Retrieves pay rate information for one or more users within your organization. This endpoint supports flexible filtering by effective dates, rate types, and resource assignments. It's designed for payroll integration scenarios where you need to fetch pay rates for multiple employees at once. The response includes historical modification data when requested, allowing you to track changes over time for audit and compliance purposes. Pagination is supported for large result sets.", "operationId": "get_pay_rates_pay_rates_v1_pay_rates_get", "security": [ { "APIKeyHeader": [] }, { "OAuth2": [ "pay_rates.read" ] } ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "title": "Startdate", "description": "Return pay rates that are in effect during the date range starting from this date, in ISO 8601 format (YYYY-MM-DD). This includes rates with an effective date before startDate if they are still the most recent rate at the start of the range. Must be used together with endDate. Date range cannot exceed 365 days.", "type": "string" }, "description": "Return pay rates that are in effect during the date range starting from this date, in ISO 8601 format (YYYY-MM-DD). This includes rates with an effective date before startDate if they are still the most recent rate at the start of the range. Must be used together with endDate. Date range cannot exceed 365 days." }, { "name": "endDate", "in": "query", "required": true, "schema": { "title": "Enddate", "description": "Return pay rates that are in effect during the date range ending at this date, in ISO 8601 format (YYYY-MM-DD). Must be used together with startDate. Date range cannot exceed 365 days.", "type": "string" }, "description": "Return pay rates that are in effect during the date range ending at this date, in ISO 8601 format (YYYY-MM-DD). Must be used together with startDate. Date range cannot exceed 365 days." }, { "name": "userIds", "in": "query", "required": false, "schema": { "title": "Userids", "description": "List of user IDs to retrieve pay rates for. If omitted, pay rates for all users will be returned (subject to pagination).", "type": "array", "items": { "type": "integer" } }, "description": "List of user IDs to retrieve pay rates for. If omitted, pay rates for all users will be returned (subject to pagination)." }, { "name": "rateType", "in": "query", "required": false, "schema": { "description": "Filter by rate type. Valid values: hourly, monthly, yearly.", "allOf": [ { "$ref": "#/components/schemas/WageTypesEnum" } ] }, "description": "Filter by rate type. Valid values: hourly, monthly, yearly." }, { "name": "resourceIds", "in": "query", "required": false, "schema": { "title": "Resourceids", "description": "Filter resource rate details to include only specific resources. This filter only affects resourcesRates; other pay rate fields are always returned.", "type": "array", "items": { "type": "string" } }, "description": "Filter resource rate details to include only specific resources. This filter only affects resourcesRates; other pay rate fields are always returned." }, { "name": "isIncludeHistory", "in": "query", "required": false, "schema": { "title": "Isincludehistory", "description": "When set to true, includes the complete modification history for each pay rate. Note: Setting this to true may increase response time and payload size.", "default": false, "type": "boolean" }, "description": "When set to true, includes the complete modification history for each pay rate. Note: Setting this to true may increase response time and payload size." }, { "name": "limit", "in": "query", "required": false, "schema": { "title": "Limit", "description": "The maximum number of results to display per page", "default": 100, "minimum": 1, "maximum": 500, "type": "integer" }, "description": "The maximum number of results to display per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "title": "Offset", "description": "The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results", "default": 0, "minimum": 0, "type": "integer" }, "description": "The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedBaseResponse_PayRatesGetResponseData_" } } } }, "400": { "description": "Invalid request parameters", "content": { "application/json": { "examples": { "invalid_date_range": { "summary": "Date range exceeds 365 days", "value": { "details": { "error_message": "Request query is invalid", "error_code": 1003 }, "error": { "__root__": { "message": "Date range cannot exceed 365 days", "type": "value_error" } }, "path": "/pay-rates/v1/pay-rates", "request_id": "550e8400-e29b-41d4-a716-446655440000" } }, "invalid_date_format": { "summary": "Invalid date format", "value": { "details": { "error_message": "Request query is invalid", "error_code": 1003 }, "error": { "query.start_date": { "message": "invalid date format, expected YYYY-MM-DD", "type": "value_error.date" } }, "path": "/pay-rates/v1/pay-rates", "request_id": "550e8400-e29b-41d4-a716-446655440000" } } }, "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "webhooks": { "Time activity clock in": { "post": { "summary": "Time Activity Clock In Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_clock_in_eventTime_activity_clock_in_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityClockInWebhookResponse" } } } } } } }, "Time activity clock out": { "post": { "summary": "Time Activity Clock Out Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_clock_out_eventTime_activity_clock_out_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityClockOutWebhookResponse" } } } } } } }, "Time activity auto clock out": { "post": { "summary": "Time Activity Auto Clock Out Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_auto_clock_out_eventTime_activity_auto_clock_out_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAutoClockOutWebhookResponse" } } } } } } }, "Time activity admin add": { "post": { "summary": "Time Activity Admin Add Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_admin_add_eventTime_activity_admin_add_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAdminAddWebhookResponse" } } } } } } }, "Time activity admin edit": { "post": { "summary": "Time Activity Admin Edit Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_admin_edit_eventTime_activity_admin_edit_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAdminEditWebhookResponse" } } } } } } }, "Time activity admin delete": { "post": { "summary": "Time Activity Admin Delete Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_admin_delete_eventTime_activity_admin_delete_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAdminDeleteWebhookResponse" } } } } } } }, "Time activity admin approved clock out outside geo fence request": { "post": { "summary": "Time Activity Admin Approved Clock Out Outside Geo Fence Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_admin_approved_clock_out_outside_geo_fence_request_eventTime_activity_admin_approved_clock_out_outside_geo_fence_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAdminApprovedClockOutOutsideGeoFenceRequestWebhookResponse" } } } } } } }, "Time activity admin approved add request": { "post": { "summary": "Time Activity Admin Approved Add Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_admin_approved_add_request_eventTime_activity_admin_approved_add_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAdminApprovedAddRequestWebhookResponse" } } } } } } }, "Time activity admin approved edit request": { "post": { "summary": "Time Activity Admin Approved Edit Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_admin_approved_edit_request_eventTime_activity_admin_approved_edit_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAdminApprovedEditRequestWebhookResponse" } } } } } } }, "Time activity admin approved delete request": { "post": { "summary": "Time Activity Admin Approved Delete Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_admin_approved_delete_request_eventTime_activity_admin_approved_delete_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAdminApprovedDeleteRequestWebhookResponse" } } } } } } }, "Time activity admin declined request": { "post": { "summary": "Time Activity Admin Declined Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_admin_declined_request_eventTime_activity_admin_declined_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAdminDeclinedRequestWebhookResponse" } } } } } } }, "Time activity auto approved add request": { "post": { "summary": "Time Activity Auto Approved Add Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_auto_approved_add_request_eventTime_activity_auto_approved_add_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAutoApprovedAddRequestWebhookResponse" } } } } } } }, "Time activity auto approved edit request": { "post": { "summary": "Time Activity Auto Approved Edit Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_auto_approved_edit_request_eventTime_activity_auto_approved_edit_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAutoApprovedEditRequestWebhookResponse" } } } } } } }, "Time activity auto approved delete request": { "post": { "summary": "Time Activity Auto Approved Delete Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_auto_approved_delete_request_eventTime_activity_auto_approved_delete_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAutoApprovedDeleteRequestWebhookResponse" } } } } } } }, "Time activity auto approved clock out outside geo fence request": { "post": { "summary": "Time Activity Auto Approved Clock Out Outside Geo Fence Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_auto_approved_clock_out_outside_geo_fence_request_eventTime_activity_auto_approved_clock_out_outside_geo_fence_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAutoApprovedClockOutOutsideGeoFenceRequestWebhookResponse" } } } } } } }, "Time activity admin approved clock out without NFC request": { "post": { "summary": "Time Activity Admin Approved Clock Out Without Nfc Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_admin_approved_clock_out_without_nfc_request_eventTime_activity_admin_approved_clock_out_without_NFC_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAdminApprovedClockOutWithoutNfcRequestWebhookResponse" } } } } } } }, "Time activity auto approved clock out without NFC request": { "post": { "summary": "Time Activity Auto Approved Clock Out Without Nfc Request Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "time_activity_auto_approved_clock_out_without_nfc_request_eventTime_activity_auto_approved_clock_out_without_NFC_request_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeActivityAutoApprovedClockOutWithoutNfcRequestWebhookResponse" } } } } } } }, "Availability status created": { "post": { "summary": "Availability Status Created Event", "description": "Receive real-time data updates on availability status events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "availability_status_created_eventAvailability_status_created_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCreatedStatusWebhookResponse" } } } } } } }, "Availability status deleted": { "post": { "summary": "Availability Status Deleted Event", "description": "Receive real-time data updates on availability status events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "availability_status_deleted_eventAvailability_status_deleted_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityDeletedStatusWebhookResponse" } } } } } } }, "Shifts created": { "post": { "summary": "Shifts Created Event", "description": "Receive real-time data updates on shifts creation at your specified URL. \n\n**V1** (default): one event per individual user assignment. \n\n**V2**: aggregates all user assignments of the same shift into a single event, with a combined list\nof assigned user IDs and a base shift ID. Adding a new user to an existing shift triggers a\n**shift.updated** event instead. Contact us to enable V2 for your account. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "shifts_created_eventShifts_created_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftCreatedWebhookResponse" } } } } } } }, "Shifts updated": { "post": { "summary": "Shifts Updated Event", "description": "Receive real-time data updates on shifts updates at your specified URL. \n\n**V1** (default): one event per individual user assignment. \n\n**V2**: aggregates all user assignments of the same shift into a single event, with a combined list\nof assigned user IDs and a base shift ID. Contact us to enable V2 for your account. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "shifts_updated_eventShifts_updated_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftUpdatedWebhookResponse" } } } } } } }, "Shifts deleted": { "post": { "summary": "Shifts Deleted Event", "description": "Receive real-time data updates on shifts deletion at your specified URL. \n\n**V1** (default): one event per individual user assignment. \n\n**V2**: uses base shift IDs and only fires when the entire shift is removed. Unassigning a single\nuser from a multi-user shift triggers a **shift.updated** event instead.\nContact us to enable V2 for your account. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "shifts_deleted_eventShifts_deleted_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftDeletedWebhookResponse" } } } } } } }, "User created": { "post": { "summary": "User Created Event", "description": "Receive real-time data updates on time activity events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "user_created_eventUser_created_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersChangedWebhookResponse" } } } } } } }, "User updated": { "post": { "summary": "User Updated Event", "description": "Receive real-time data updates on user update events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "user_updated_eventUser_updated_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersChangedWebhookResponse" } } } } } } }, "User deleted": { "post": { "summary": "User Deleted Event", "description": "Receive real-time data updates on user deletion events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "user_deleted_eventUser_deleted_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserIdWebhookResponse" } } } } } } }, "User archived": { "post": { "summary": "User Archived Event", "description": "Receive real-time data updates on user archiving events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "user_archived_eventUser_archived_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserIdWebhookResponse" } } } } } } }, "User restored": { "post": { "summary": "User Restored Event", "description": "Receive real-time data updates on user restoration events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "user_restored_eventUser_restored_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserIdWebhookResponse" } } } } } } }, "User promoted": { "post": { "summary": "User Promoted Event", "description": "Receive real-time data updates on user promotion events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "user_promoted_eventUser_promoted_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserIdWebhookResponse" } } } } } } }, "User demoted": { "post": { "summary": "User Demoted Event", "description": "Receive real-time data updates on user demotion events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "user_demoted_eventUser_demoted_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserIdWebhookResponse" } } } } } } }, "Task Published": { "post": { "summary": "Task Published Event", "description": "Receive real-time data updates on task published events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "task_published_eventTask_Published_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskChangedWebhookResponse" } } } } } } }, "Task Completed": { "post": { "summary": "Task Completed Event", "description": "Receive real-time data updates on task complete events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "task_completed_eventTask_Completed_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskChangedWebhookResponse" } } } } } } }, "Form Submission": { "post": { "summary": "Form Submission Event", "description": "Receive real-time data updates on user demotion events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "form_submission_eventForm_Submission_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionWebhookResponse" } } } } } } }, "Manager Field Updated": { "post": { "summary": "Manager Field Updated Event", "description": "Receive real-time data updates on user demotion events at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "manager_field_updated_eventManager_Field_Updated_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagerFieldUpdatedWebhookResponse" } } } } } } }, "Form submission Edited": { "post": { "summary": "Form Submission Edited Event", "description": "Receive real-time data updates when a form submission is edited at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "form_submission_edited_eventForm_submission_Edited_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionWebhookResponse" } } } } } } }, "Pending User Request Fulfilled": { "post": { "summary": "Pending User Request Approved", "description": "Receive real-time data updates on fulfilled users from user pending requests at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "pending_user_request_approvedPending_User_Request_Fulfilled_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskChangedWebhookResponse" } } } } } } }, "Chat message created": { "post": { "summary": "Chat Message Created Event", "description": "Receive real-time data updates on chat message creation at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "chat_message_created_eventChat_message_created_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWebhookResponse" } } } } } } }, "Chat message updated": { "post": { "summary": "Chat Message Updated Event", "description": "Receive real-time data updates on chat message updates at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "chat_message_updated_eventChat_message_updated_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWebhookResponse" } } } } } } }, "Chat message deleted": { "post": { "summary": "Chat Message Deleted Event", "description": "Receive real-time data updates on chat message deletion at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "chat_message_deleted_eventChat_message_deleted_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWebhookResponse" } } } } } } }, "Chat conversation created": { "post": { "summary": "Chat Conversation Created Event", "description": "Receive real-time data updates on chat conversation creation at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "chat_conversation_created_eventChat_conversation_created_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWebhookResponse" } } } } } } }, "Chat conversation updated": { "post": { "summary": "Chat Conversation Updated Event", "description": "Receive real-time data updates on chat conversation updates at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "chat_conversation_updated_eventChat_conversation_updated_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWebhookResponse" } } } } } } }, "Chat conversation deleted": { "post": { "summary": "Chat Conversation Deleted Event", "description": "Receive real-time data updates on chat conversation deletion at your specified URL. \n\nFind more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.", "operationId": "chat_conversation_deleted_eventChat_conversation_deleted_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWebhookResponse" } } } } } } } }, "components": { "schemas": { "ActivityFileResponse": { "properties": { "fileName": { "type": "string", "title": "Filename", "description": "The name of the file in a shift attachment of type file" }, "fileUrl": { "type": "string", "title": "Fileurl", "description": "The URL of the file in a shift attachment of type file" } }, "type": "object", "required": [ "fileName", "fileUrl" ], "title": "ActivityFileResponse" }, "AlbumNoteDataOut": { "properties": { "type": { "type": "string", "title": "Type", "description": "Album note type", "default": "album" }, "album": { "items": { "$ref": "#/components/schemas/ImageNoteDataOut" }, "type": "array", "title": "Album", "description": "The list of images in the album" } }, "type": "object", "required": [ "album" ], "title": "AlbumNoteDataOut" }, "AudioAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "audioRecording" ], "title": "Questiontype", "description": "The questions type", "default": "audioRecording" }, "audioUrl": { "type": "string", "title": "Audiourl", "description": "The audio url." }, "audioLength": { "type": "integer", "title": "Audiolength", "description": "The audio length in seconds." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty" ], "title": "AudioAnswer" }, "AutoClockOutModeType": { "type": "string", "enum": [ "dailyLimit", "hourLimit", "schedulerShiftEnded", "geofenceExit", "disabledGps", "disabledGpsPermission" ], "title": "AutoClockOutModeType", "description": "An enumeration." }, "AvailabilityCreatedStatusWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "availability_status_created" }, "schedulerId": { "type": "integer", "minimum": 1, "title": "Schedulerid", "description": "The unique identifier of the schedule" }, "availabilityStatuses": { "items": { "$ref": "#/components/schemas/AvailabilityStatusDataResponse" }, "type": "array", "title": "Availabilitystatuses", "description": "The availability status items" }, "isAdminAction": { "type": "boolean", "title": "Isadminaction", "description": "Whether the action was done by an admin" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "schedulerId", "availabilityStatuses", "isAdminAction" ], "title": "AvailabilityCreatedStatusWebhookResponse", "description": "Webhook response for availability status created event" }, "AvailabilityDeletedStatusWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "availability_status_deleted" }, "schedulerId": { "type": "integer", "minimum": 1, "title": "Schedulerid", "description": "The unique identifier of the schedule" }, "availabilityStatuses": { "items": { "$ref": "#/components/schemas/AvailabilityStatusDataResponse" }, "type": "array", "title": "Availabilitystatuses", "description": "The availability status items" }, "isAdminAction": { "type": "boolean", "title": "Isadminaction", "description": "Whether the action was done by an admin" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "schedulerId", "availabilityStatuses", "isAdminAction" ], "title": "AvailabilityDeletedStatusWebhookResponse", "description": "Webhook response for availability status deleted event" }, "AvailabilityStatusDataResponse": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id", "description": "The unique identifier of the availability status" }, "type": { "$ref": "#/components/schemas/AvailabilityType", "description": "The type of the availability status" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "start": { "$ref": "#/components/schemas/TimestampWithTimezone", "description": "The start time of the availability status" }, "end": { "$ref": "#/components/schemas/TimestampWithTimezone", "description": "The end time of the availability status" }, "isAllDay": { "type": "boolean", "title": "Isallday", "description": "Whether the availability status is for a full day" }, "note": { "type": "string", "title": "Note", "description": "The note of the availability status" } }, "type": "object", "required": [ "type", "userId", "start", "end", "isAllDay", "note" ], "title": "AvailabilityStatusDataResponse" }, "AvailabilityType": { "type": "string", "enum": [ "available", "preferToWork", "unavailable", "absence" ], "title": "AvailabilityType" }, "ChatWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type" }, "data": { "additionalProperties": true, "type": "object", "title": "Data", "description": "Event-specific data" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "eventType", "data" ], "title": "ChatWebhookResponse" }, "CustomFieldResponseV2": { "properties": { "customFieldId": { "type": "integer", "minimum": 1, "title": "Customfieldid", "description": "The custom field unique id" }, "value": { "title": "Value", "description": "The custom field value" }, "type": { "$ref": "#/components/schemas/UserCustomFields", "description": "The custom field type" }, "name": { "type": "string", "title": "Name", "description": "The custom field name" } }, "type": "object", "required": [ "customFieldId", "value", "type", "name" ], "title": "CustomFieldResponseV2" }, "DateTimeAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "datetime" ], "title": "Questiontype", "description": "The questions type", "default": "datetime" }, "timestamp": { "type": "integer", "title": "Timestamp", "description": "The timestamp of the answer." }, "timezone": { "type": "string", "title": "Timezone", "description": "The timezone of the answer." }, "isTimeSubmitted": { "type": "boolean", "title": "Istimesubmitted", "description": "Whether the time was submitted." }, "isDateSubmitted": { "type": "boolean", "title": "Isdatesubmitted", "description": "Whether the date was submitted." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty", "isTimeSubmitted", "isDateSubmitted" ], "title": "DateTimeAnswer" }, "DescriptionAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "questionType": { "type": "string", "enum": [ "description" ], "title": "Questiontype", "description": "The questions type", "default": "description" } }, "type": "object", "required": [ "questionId" ], "title": "DescriptionAnswer" }, "EmailAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "emailAddress" ], "title": "Questiontype", "description": "The questions type", "default": "emailAddress" }, "value": { "type": "string", "title": "Value", "description": "The email address" } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty" ], "title": "EmailAnswer" }, "ErrorParing": { "properties": { "error_message": { "type": "string", "title": "Error Message" }, "error_code": { "type": "integer", "title": "Error Code" } }, "type": "object", "required": [ "error_message", "error_code" ], "title": "ErrorParing", "description": "V1 error paring model for backward compatibility" }, "FileNoteDataOut": { "properties": { "url": { "type": "string", "title": "Url", "description": "The url of the file to upload" }, "type": { "type": "string", "title": "Type", "description": "URL note type", "default": "file" }, "name": { "type": "string", "title": "Name", "description": "The name of the file" } }, "type": "object", "required": [ "url", "name" ], "title": "FileNoteDataOut" }, "FilesAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "files" ], "title": "Questiontype", "description": "The questions type", "default": "files" }, "files": { "items": { "$ref": "#/components/schemas/FormFileModel" }, "type": "array", "title": "Files", "description": "The files." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty", "files" ], "title": "FilesAnswer" }, "FormFileModel": { "properties": { "url": { "type": "string", "title": "Url", "description": "The URL of the file." }, "size": { "type": "integer", "title": "Size", "description": "The size of the file in bytes." }, "fileName": { "type": "string", "title": "Filename", "description": "The name of the file." } }, "type": "object", "required": [ "url", "size", "fileName" ], "title": "FormFileModel" }, "FormImageModel": { "properties": { "url": { "type": "string", "title": "Url", "description": "The URL of the image." } }, "type": "object", "required": [ "url" ], "title": "FormImageModel" }, "FormImageSelectionModel": { "properties": { "imageSelectionId": { "type": "string", "title": "Imageselectionid", "description": "The ID of the image selection." }, "text": { "type": "string", "title": "Text", "description": "The text of the image selection." }, "image": { "type": "string", "title": "Image", "description": "The URL of the image." } }, "type": "object", "required": [ "imageSelectionId", "text", "image" ], "title": "FormImageSelectionModel" }, "FormMultipleChoiceOptionModel": { "properties": { "multipleChoiceOptionId": { "type": "string", "title": "Multiplechoiceoptionid", "description": "The ID of the multiple choice option" }, "text": { "type": "string", "title": "Text", "description": "The text of the option" } }, "type": "object", "required": [ "multipleChoiceOptionId", "text" ], "title": "FormMultipleChoiceOptionModel" }, "FormSubmissionAnswersResponse": { "properties": { "formSubmissionId": { "type": "string", "title": "Formsubmissionid", "description": "The form submission id." }, "formId": { "type": "integer", "title": "Formid", "description": "The forms id." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "submissionTimezone": { "type": "string", "title": "Submissiontimezone", "description": "The timezone of the submission." }, "entryNum": { "type": "integer", "title": "Entrynum", "description": "The entry number." }, "submittingUserId": { "type": "integer", "title": "Submittinguserid", "description": "The user id of the submitting user." }, "isAnonymous": { "type": "boolean", "title": "Isanonymous", "description": "Whether the submission is anonymous." }, "answers": { "items": { "oneOf": [ { "$ref": "#/components/schemas/MultipleChoiceAnswer" }, { "$ref": "#/components/schemas/NumberAnswer" }, { "$ref": "#/components/schemas/OpenEndedAnswer" }, { "$ref": "#/components/schemas/EmailAnswer" }, { "$ref": "#/components/schemas/YesNoAnswer" }, { "$ref": "#/components/schemas/PhoneNumberAnswer" }, { "$ref": "#/components/schemas/ScannerAnswer" }, { "$ref": "#/components/schemas/ImageSelectionAnswer" }, { "$ref": "#/components/schemas/LocationAnswer" }, { "$ref": "#/components/schemas/AudioAnswer" }, { "$ref": "#/components/schemas/TaskAnswer" }, { "$ref": "#/components/schemas/DateTimeAnswer" }, { "$ref": "#/components/schemas/RatingAnswer" }, { "$ref": "#/components/schemas/ImageAnswer" }, { "$ref": "#/components/schemas/SignatureAnswer" }, { "$ref": "#/components/schemas/FilesAnswer" }, { "$ref": "#/components/schemas/SliderAnswer" }, { "$ref": "#/components/schemas/FormulaAnswer" }, { "$ref": "#/components/schemas/VideoAnswer" }, { "$ref": "#/components/schemas/DescriptionAnswer" }, { "$ref": "#/components/schemas/GroupAnswer" }, { "$ref": "#/components/schemas/MultiGroupAnswer" } ], "discriminator": { "propertyName": "questionType", "mapping": { "multipleChoice": "#/components/schemas/MultipleChoiceAnswer", "number": "#/components/schemas/NumberAnswer", "openEnded": "#/components/schemas/OpenEndedAnswer", "emailAddress": "#/components/schemas/EmailAnswer", "yesNo": "#/components/schemas/YesNoAnswer", "phoneNumber": "#/components/schemas/PhoneNumberAnswer", "scanDocument": "#/components/schemas/ScannerAnswer", "imageSelection": "#/components/schemas/ImageSelectionAnswer", "location": "#/components/schemas/LocationAnswer", "audioRecording": "#/components/schemas/AudioAnswer", "task": "#/components/schemas/TaskAnswer", "datetime": "#/components/schemas/DateTimeAnswer", "rating": "#/components/schemas/RatingAnswer", "image": "#/components/schemas/ImageAnswer", "signature": "#/components/schemas/SignatureAnswer", "files": "#/components/schemas/FilesAnswer", "slider": "#/components/schemas/SliderAnswer", "formula": "#/components/schemas/FormulaAnswer", "video": "#/components/schemas/VideoAnswer", "description": "#/components/schemas/DescriptionAnswer", "group": "#/components/schemas/GroupAnswer", "multiGroup": "#/components/schemas/MultiGroupAnswer" } } }, "type": "array", "title": "Answers", "description": "The answers." }, "submissionStartTimestamp": { "type": "integer", "title": "Submissionstarttimestamp", "description": "The captured timestamp marking when the employee opened the form to begin filling it out." } }, "type": "object", "required": [ "formSubmissionId", "formId", "submissionTimestamp", "submissionTimezone", "entryNum", "submittingUserId", "isAnonymous", "answers", "submissionStartTimestamp" ], "title": "FormSubmissionAnswersResponse" }, "FormSubmissionManagerFieldsResponse": { "properties": { "formSubmissionId": { "type": "string", "title": "Formsubmissionid", "description": "The form submission id." }, "formId": { "type": "integer", "title": "Formid", "description": "The forms id." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "submissionTimezone": { "type": "string", "title": "Submissiontimezone", "description": "The timezone of the submission." }, "entryNum": { "type": "integer", "title": "Entrynum", "description": "The entry number." }, "managerFields": { "items": { "oneOf": [ { "$ref": "#/components/schemas/ManagerFieldDate" }, { "$ref": "#/components/schemas/ManagerFieldFile" }, { "$ref": "#/components/schemas/ManagerFieldSignature" }, { "$ref": "#/components/schemas/ManagerFieldOwner" }, { "$ref": "#/components/schemas/v2__features__workflow__external_api__v1__form_submissions__models__response__answer_models__ManagerFieldStatus" }, { "$ref": "#/components/schemas/ManagerFieldNote" } ], "discriminator": { "propertyName": "managerFieldType", "mapping": { "date": "#/components/schemas/ManagerFieldDate", "file": "#/components/schemas/ManagerFieldFile", "signature": "#/components/schemas/ManagerFieldSignature", "owner": "#/components/schemas/ManagerFieldOwner", "status": "#/components/schemas/v2__features__workflow__external_api__v1__form_submissions__models__response__answer_models__ManagerFieldStatus", "note": "#/components/schemas/ManagerFieldNote" } } }, "type": "array", "title": "Managerfields", "description": "The manager fields." } }, "type": "object", "required": [ "formSubmissionId", "formId", "submissionTimestamp", "submissionTimezone", "entryNum", "managerFields" ], "title": "FormSubmissionManagerFieldsResponse" }, "FormSubmissionWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook" }, "data": { "allOf": [ { "$ref": "#/components/schemas/FormSubmissionAnswersResponse" } ], "title": "Data", "description": "The form submission" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "eventType", "data" ], "title": "FormSubmissionWebhookResponse" }, "FormVideoModel": { "properties": { "videoUrl": { "type": "string", "title": "Videourl", "description": "The URL of the video." } }, "type": "object", "required": [ "videoUrl" ], "title": "FormVideoModel" }, "FormulaAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "formula" ], "title": "Questiontype", "description": "The questions type", "default": "formula" }, "result": { "type": "number", "title": "Result", "description": "The result of the formula." }, "status": { "type": "string", "title": "Status", "description": "The status of the formula." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty" ], "title": "FormulaAnswer" }, "GeneralActivityShiftAttachmentResponse": { "properties": { "shiftAttachmentId": { "type": "string", "title": "Shiftattachmentid", "description": "The ID of the shift attachment" }, "attachment": { "allOf": [ { "$ref": "#/components/schemas/GeneralActivityShiftAttachmentValueResponse" } ], "title": "Attachment", "description": "The value of the shift attachment" } }, "type": "object", "required": [ "shiftAttachmentId", "attachment" ], "title": "GeneralActivityShiftAttachmentResponse" }, "GeneralActivityShiftAttachmentValueResponse": { "properties": { "itemId": { "type": "string", "title": "Itemid", "description": "The ID of the dropdown list item" }, "freeText": { "type": "string", "title": "Freetext", "description": "The value of the shift attachment of type free text" }, "number": { "type": "number", "title": "Number", "description": "The value of the shift attachment of type number" }, "fileName": { "type": "string", "title": "Filename", "description": "The name of the file in a shift attachment of type file" }, "fileUrl": { "type": "string", "title": "Fileurl", "description": "The URL of the file in a shift attachment of type file" }, "files": { "items": { "$ref": "#/components/schemas/ActivityFileResponse" }, "type": "array", "title": "Files", "description": "The value of the shift attachment of type files" }, "images": { "items": { "type": "string" }, "type": "array", "title": "Images", "description": "The value of the shift attachment of type images" }, "image": { "type": "string", "title": "Image", "description": "The value of the shift attachment of type signature" } }, "type": "object", "title": "GeneralActivityShiftAttachmentValueResponse" }, "GpsData": { "properties": { "address": { "type": "string", "title": "Address", "description": "The address associated with the GPS data." }, "longitude": { "type": "number", "title": "Longitude", "description": "The longitude coordinate." }, "latitude": { "type": "number", "title": "Latitude", "description": "The latitude coordinate." } }, "type": "object", "title": "GpsData" }, "GpsDataV2": { "properties": { "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "The address associated with the GPS data." }, "longitude": { "anyOf": [ { "type": "number", "maximum": 180, "minimum": -180, "description": "The longitude coordinate." }, { "type": "null" } ], "title": "Longitude", "description": "The longitude coordinate." }, "latitude": { "anyOf": [ { "type": "number", "maximum": 90, "minimum": -90, "description": "The latitude coordinate." }, { "type": "null" } ], "title": "Latitude", "description": "The latitude coordinate." } }, "type": "object", "title": "GpsDataV2" }, "GroupAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "questionType": { "type": "string", "enum": [ "group" ], "title": "Questiontype", "description": "The questions type", "default": "group" }, "answers": { "items": { "oneOf": [ { "$ref": "#/components/schemas/MultipleChoiceAnswer" }, { "$ref": "#/components/schemas/NumberAnswer" }, { "$ref": "#/components/schemas/OpenEndedAnswer" }, { "$ref": "#/components/schemas/EmailAnswer" }, { "$ref": "#/components/schemas/YesNoAnswer" }, { "$ref": "#/components/schemas/PhoneNumberAnswer" }, { "$ref": "#/components/schemas/ScannerAnswer" }, { "$ref": "#/components/schemas/ImageSelectionAnswer" }, { "$ref": "#/components/schemas/LocationAnswer" }, { "$ref": "#/components/schemas/AudioAnswer" }, { "$ref": "#/components/schemas/TaskAnswer" }, { "$ref": "#/components/schemas/DateTimeAnswer" }, { "$ref": "#/components/schemas/RatingAnswer" }, { "$ref": "#/components/schemas/ImageAnswer" }, { "$ref": "#/components/schemas/SignatureAnswer" }, { "$ref": "#/components/schemas/FilesAnswer" }, { "$ref": "#/components/schemas/SliderAnswer" }, { "$ref": "#/components/schemas/FormulaAnswer" }, { "$ref": "#/components/schemas/VideoAnswer" }, { "$ref": "#/components/schemas/DescriptionAnswer" } ], "discriminator": { "propertyName": "questionType", "mapping": { "multipleChoice": "#/components/schemas/MultipleChoiceAnswer", "number": "#/components/schemas/NumberAnswer", "openEnded": "#/components/schemas/OpenEndedAnswer", "emailAddress": "#/components/schemas/EmailAnswer", "yesNo": "#/components/schemas/YesNoAnswer", "phoneNumber": "#/components/schemas/PhoneNumberAnswer", "scanDocument": "#/components/schemas/ScannerAnswer", "imageSelection": "#/components/schemas/ImageSelectionAnswer", "location": "#/components/schemas/LocationAnswer", "audioRecording": "#/components/schemas/AudioAnswer", "task": "#/components/schemas/TaskAnswer", "datetime": "#/components/schemas/DateTimeAnswer", "rating": "#/components/schemas/RatingAnswer", "image": "#/components/schemas/ImageAnswer", "signature": "#/components/schemas/SignatureAnswer", "files": "#/components/schemas/FilesAnswer", "slider": "#/components/schemas/SliderAnswer", "formula": "#/components/schemas/FormulaAnswer", "video": "#/components/schemas/VideoAnswer", "description": "#/components/schemas/DescriptionAnswer" } } }, "type": "array", "title": "Answers", "description": "The list of answers in the group." } }, "type": "object", "required": [ "questionId", "answers" ], "title": "GroupAnswer" }, "HTMLNoteDataOut": { "properties": { "type": { "type": "string", "title": "Type", "description": "HTML note type", "default": "html" }, "html": { "type": "string", "title": "Html", "description": "The HTML content of the note" } }, "type": "object", "required": [ "html" ], "title": "HTMLNoteDataOut" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ImageAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "image" ], "title": "Questiontype", "description": "The questions type", "default": "image" }, "images": { "items": { "$ref": "#/components/schemas/FormImageModel" }, "type": "array", "title": "Images", "description": "The images." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty", "images" ], "title": "ImageAnswer" }, "ImageNoteDataOut": { "properties": { "url": { "type": "string", "title": "Url", "description": "The url of the file to upload" } }, "type": "object", "required": [ "url" ], "title": "ImageNoteDataOut" }, "ImageSelectionAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "imageSelection" ], "title": "Questiontype", "description": "The questions type", "default": "imageSelection" }, "selectedAnswers": { "items": { "$ref": "#/components/schemas/FormImageSelectionModel" }, "type": "array", "title": "Selectedanswers", "description": "The selected answers." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty", "selectedAnswers" ], "title": "ImageSelectionAnswer" }, "LocationAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "location" ], "title": "Questiontype", "description": "The questions type", "default": "location" }, "locationInput": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Locationinput", "description": "The location input." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty" ], "title": "LocationAnswer" }, "LocationDataAPI": { "properties": { "isReferencedToJob": { "type": "boolean", "title": "Isreferencedtojob", "description": "Indicates whether the location is referenced to a job. can only be true if job id isn't empty" }, "gps": { "anyOf": [ { "$ref": "#/components/schemas/GpsDataV2" }, { "type": "null" } ], "description": "GPS data associated with the location." } }, "type": "object", "required": [ "isReferencedToJob" ], "title": "LocationDataAPI" }, "ManagerFieldDate": { "properties": { "managerFieldId": { "type": "string", "title": "Managerfieldid", "description": "The manager field id." }, "managerFieldType": { "type": "string", "enum": [ "date" ], "title": "Managerfieldtype", "description": "The field type", "default": "date" }, "date": { "type": "string", "title": "Date", "description": "The date filled in the field." } }, "type": "object", "required": [ "managerFieldId" ], "title": "ManagerFieldDate" }, "ManagerFieldFile": { "properties": { "managerFieldId": { "type": "string", "title": "Managerfieldid", "description": "The manager field id." }, "managerFieldType": { "type": "string", "enum": [ "file" ], "title": "Managerfieldtype", "description": "The field type", "default": "file" }, "files": { "items": { "$ref": "#/components/schemas/ManagerFieldFileModel" }, "type": "array", "title": "Files", "description": "The files." } }, "type": "object", "required": [ "managerFieldId" ], "title": "ManagerFieldFile" }, "ManagerFieldFileModel": { "properties": { "fileUrl": { "type": "string", "title": "Fileurl", "description": "The URL of the file." }, "filename": { "type": "string", "title": "Filename", "description": "The name of the file." } }, "type": "object", "required": [ "fileUrl", "filename" ], "title": "ManagerFieldFileModel" }, "ManagerFieldNote": { "properties": { "managerFieldId": { "type": "string", "title": "Managerfieldid", "description": "The manager field id." }, "managerFieldType": { "type": "string", "enum": [ "note" ], "title": "Managerfieldtype", "description": "The field type", "default": "note" }, "note": { "type": "string", "title": "Note", "description": "The note filled in the field." } }, "type": "object", "required": [ "managerFieldId" ], "title": "ManagerFieldNote" }, "ManagerFieldOwner": { "properties": { "managerFieldId": { "type": "string", "title": "Managerfieldid", "description": "The manager field id." }, "managerFieldType": { "type": "string", "enum": [ "owner" ], "title": "Managerfieldtype", "description": "The field type", "default": "owner" }, "userId": { "type": "integer", "title": "Userid", "description": "The user id of the assigned owner." } }, "type": "object", "required": [ "managerFieldId" ], "title": "ManagerFieldOwner" }, "ManagerFieldSignature": { "properties": { "managerFieldId": { "type": "string", "title": "Managerfieldid", "description": "The manager field id." }, "managerFieldType": { "type": "string", "enum": [ "signature" ], "title": "Managerfieldtype", "description": "The field type", "default": "signature" }, "image": { "type": "string", "title": "Image", "description": "The image of the signature." }, "signingUserId": { "type": "integer", "title": "Signinguserid", "description": "The user id of the signing user." }, "signingTimestamp": { "type": "integer", "title": "Signingtimestamp", "description": "The timestamp of the signing." } }, "type": "object", "required": [ "managerFieldId" ], "title": "ManagerFieldSignature" }, "ManagerFieldStatusOption": { "properties": { "statusOptionId": { "type": "string", "title": "Statusoptionid", "description": "The ID of the status option." }, "name": { "type": "string", "title": "Name", "description": "The name of the status option." }, "color": { "type": "string", "title": "Color", "description": "The color of the status option." } }, "type": "object", "required": [ "statusOptionId", "name", "color" ], "title": "ManagerFieldStatusOption" }, "ManagerFieldUpdatedWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook" }, "data": { "allOf": [ { "$ref": "#/components/schemas/FormSubmissionManagerFieldsResponse" } ], "title": "Data", "description": "The manager fields." } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "eventType", "data" ], "title": "ManagerFieldUpdatedWebhookResponse" }, "ManualBreakActivityResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique identifier of the time clock" }, "managerNote": { "type": "string", "title": "Managernote", "description": "The manager note providing additional details" }, "employeeNote": { "type": "string", "title": "Employeenote", "description": "The employee note providing additional details" }, "start": { "allOf": [ { "$ref": "#/components/schemas/TimeActivityTimePointResponse" } ], "title": "Start", "description": "The start time of the time activity" }, "end": { "allOf": [ { "$ref": "#/components/schemas/TimeActivityTimePointResponse" } ], "title": "End", "description": "The end time of the time activity" }, "createdAt": { "type": "integer", "minimum": 1, "title": "Createdat", "description": "The creation time of the time activity" }, "modifiedAt": { "type": "integer", "minimum": 1, "title": "Modifiedat", "description": "The last modification time of the time activity" }, "manualBreakId": { "type": "string", "title": "Manualbreakid", "description": "The ID of the manual break" }, "isAutoClockOut": { "type": "boolean", "title": "Isautoclockout", "description": "Indicates whether the user was auto clocked out from the shift", "default": false } }, "type": "object", "required": [ "id", "start", "manualBreakId" ], "title": "ManualBreakActivityResponse" }, "MultiAnswerItem": { "properties": { "type": { "type": "string", "title": "Type", "description": "The type of the answer item" }, "index": { "type": "integer", "title": "Index", "description": "The index of the answer item" }, "answers": { "items": { "oneOf": [ { "$ref": "#/components/schemas/MultipleChoiceAnswer" }, { "$ref": "#/components/schemas/NumberAnswer" }, { "$ref": "#/components/schemas/OpenEndedAnswer" }, { "$ref": "#/components/schemas/EmailAnswer" }, { "$ref": "#/components/schemas/YesNoAnswer" }, { "$ref": "#/components/schemas/PhoneNumberAnswer" }, { "$ref": "#/components/schemas/ScannerAnswer" }, { "$ref": "#/components/schemas/ImageSelectionAnswer" }, { "$ref": "#/components/schemas/LocationAnswer" }, { "$ref": "#/components/schemas/AudioAnswer" }, { "$ref": "#/components/schemas/TaskAnswer" }, { "$ref": "#/components/schemas/DateTimeAnswer" }, { "$ref": "#/components/schemas/RatingAnswer" }, { "$ref": "#/components/schemas/ImageAnswer" }, { "$ref": "#/components/schemas/SignatureAnswer" }, { "$ref": "#/components/schemas/FilesAnswer" }, { "$ref": "#/components/schemas/SliderAnswer" }, { "$ref": "#/components/schemas/FormulaAnswer" }, { "$ref": "#/components/schemas/VideoAnswer" }, { "$ref": "#/components/schemas/DescriptionAnswer" } ], "discriminator": { "propertyName": "questionType", "mapping": { "multipleChoice": "#/components/schemas/MultipleChoiceAnswer", "number": "#/components/schemas/NumberAnswer", "openEnded": "#/components/schemas/OpenEndedAnswer", "emailAddress": "#/components/schemas/EmailAnswer", "yesNo": "#/components/schemas/YesNoAnswer", "phoneNumber": "#/components/schemas/PhoneNumberAnswer", "scanDocument": "#/components/schemas/ScannerAnswer", "imageSelection": "#/components/schemas/ImageSelectionAnswer", "location": "#/components/schemas/LocationAnswer", "audioRecording": "#/components/schemas/AudioAnswer", "task": "#/components/schemas/TaskAnswer", "datetime": "#/components/schemas/DateTimeAnswer", "rating": "#/components/schemas/RatingAnswer", "image": "#/components/schemas/ImageAnswer", "signature": "#/components/schemas/SignatureAnswer", "files": "#/components/schemas/FilesAnswer", "slider": "#/components/schemas/SliderAnswer", "formula": "#/components/schemas/FormulaAnswer", "video": "#/components/schemas/VideoAnswer", "description": "#/components/schemas/DescriptionAnswer" } } }, "type": "array", "title": "Answers", "description": "The list of answers" } }, "type": "object", "required": [ "type", "index", "answers" ], "title": "MultiAnswerItem" }, "MultiGroupAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "questionType": { "type": "string", "enum": [ "multiGroup" ], "title": "Questiontype", "description": "The questions type", "default": "multiGroup" }, "groupAnswers": { "items": { "$ref": "#/components/schemas/MultiAnswerItem" }, "type": "array", "title": "Groupanswers", "description": "List of multi-answer items" } }, "type": "object", "required": [ "questionId", "groupAnswers" ], "title": "MultiGroupAnswer" }, "MultipleChoiceAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "multipleChoice" ], "title": "Questiontype", "description": "The questions type", "default": "multipleChoice" }, "selectedAnswers": { "items": { "$ref": "#/components/schemas/FormMultipleChoiceOptionModel" }, "type": "array", "title": "Selectedanswers", "description": "The selected answers." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty", "selectedAnswers" ], "title": "MultipleChoiceAnswer" }, "NumberAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "number" ], "title": "Questiontype", "description": "The questions type", "default": "number" }, "inputValue": { "type": "number", "title": "Inputvalue", "description": "The input value." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty" ], "title": "NumberAnswer" }, "OpenEndedAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "openEnded" ], "title": "Questiontype", "description": "The questions type", "default": "openEnded" }, "value": { "type": "string", "title": "Value", "description": "The input text." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty" ], "title": "OpenEndedAnswer" }, "PaginatedBaseResponse_PayRatesGetResponseData_": { "properties": { "requestId": { "type": "string", "title": "Requestid" }, "data": { "$ref": "#/components/schemas/PayRatesGetResponseData" }, "paging": { "$ref": "#/components/schemas/PagingResponseModel" } }, "type": "object", "required": [ "data", "paging" ], "title": "PaginatedBaseResponse[PayRatesGetResponseData]" }, "PagingResponseModel": { "properties": { "offset": { "type": "integer", "minimum": 0, "title": "Offset", "description": "The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results" }, "total": { "type": "integer", "minimum": 0, "title": "Total", "description": "Total number of resources matching the request, ignoring pagination. Use this to retrieve the full count without paginating through every page. Only populated by endpoints that compute it." } }, "type": "object", "required": [ "offset" ], "title": "PagingResponseModel" }, "PayRateByUserResponse": { "properties": { "userId": { "type": "integer", "title": "Userid", "description": "The unique identifier of the user in the Connecteam system" }, "payRate": { "allOf": [ { "$ref": "#/components/schemas/PayRateResponse" } ], "title": "Payrate", "description": "Pay rate configuration for this user" } }, "type": "object", "required": [ "userId", "payRate" ], "title": "PayRateByUserResponse" }, "PayRateModificationResponse": { "properties": { "modifiedBy": { "type": "integer", "title": "Modifiedby", "description": "User ID of the person who made this modification" }, "modifiedAt": { "type": "integer", "title": "Modifiedat", "description": "Unix timestamp (seconds since epoch) when this modification was made" }, "previousRateType": { "allOf": [ { "$ref": "#/components/schemas/WageTypesEnum" } ], "description": "The rate type before this modification, if changed" }, "previousDefaultRate": { "type": "number", "title": "Previousdefaultrate", "description": "The default rate before this modification, if changed" }, "previousIsDefaultRateEnabled": { "type": "boolean", "title": "Previousisdefaultrateenabled", "description": "Whether the default rate was enabled before this modification, if changed" }, "previousIsResourceRateEnabled": { "type": "boolean", "title": "Previousisresourcerateenabled", "description": "Whether resource-specific rates were enabled before this modification, if changed" } }, "type": "object", "required": [ "modifiedBy", "modifiedAt" ], "title": "PayRateModificationResponse" }, "PayRateResponse": { "properties": { "effectiveDate": { "type": "string", "title": "Effectivedate", "description": "The date this pay rate becomes effective, in YYYY-MM-DD format" }, "rateType": { "allOf": [ { "$ref": "#/components/schemas/WageTypesEnum" } ], "description": "Type of rate calculation. Values: hourly, monthly, yearly" }, "isDefaultRateEnabled": { "type": "boolean", "title": "Isdefaultrateenabled", "description": "Whether the default rate is enabled for this user" }, "defaultRate": { "type": "number", "title": "Defaultrate", "description": "The default rate amount. Only present when isDefaultRateEnabled is true" }, "isResourceRateEnabled": { "type": "boolean", "title": "Isresourcerateenabled", "description": "Whether resource-specific rates are enabled" }, "isApplyDefaultRateToNewResource": { "type": "boolean", "title": "Isapplydefaultratetonewresource", "description": "When true, newly assigned resources will automatically use the defaultRate if no specific rate is configured" }, "resourcesRates": { "items": { "$ref": "#/components/schemas/ResourceRateResponse" }, "type": "array", "title": "Resourcesrates", "description": "Array of resource-specific rate configurations. Only present when isResourceRateEnabled is true" }, "createdBy": { "type": "integer", "title": "Createdby", "description": "User ID of the person who created this pay rate entry" }, "createdAt": { "type": "integer", "title": "Createdat", "description": "Unix timestamp (seconds since epoch) when this pay rate was created" }, "modifiedAt": { "type": "integer", "title": "Modifiedat", "description": "Unix timestamp (seconds since epoch) of the last modification. Only present if the pay rate has been modified" }, "modifications": { "items": { "$ref": "#/components/schemas/PayRateModificationResponse" }, "type": "array", "title": "Modifications", "description": "Complete modification history. Only present when includeHistory=true" } }, "type": "object", "required": [ "effectiveDate", "rateType", "isDefaultRateEnabled", "isResourceRateEnabled", "isApplyDefaultRateToNewResource", "createdBy", "createdAt" ], "title": "PayRateResponse" }, "PayRatesGetResponseData": { "properties": { "payRatesByUsers": { "items": { "$ref": "#/components/schemas/PayRateByUserResponse" }, "type": "array", "title": "Payratesbyusers", "description": "Array of user records with their pay rate configurations" } }, "type": "object", "required": [ "payRatesByUsers" ], "title": "PayRatesGetResponseData" }, "PhoneNumberAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "phoneNumber" ], "title": "Questiontype", "description": "The questions type", "default": "phoneNumber" }, "value": { "type": "string", "title": "Value", "description": "The phone number with country code" } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty" ], "title": "PhoneNumberAnswer" }, "PunchSourceResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier of the source (for NFC or geofence-based sources)" }, "type": { "allOf": [ { "$ref": "#/components/schemas/PunchSourceType" } ], "description": "Indicates how the punch was performed" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/AutoClockOutModeType" } ], "description": "For autoClockOut type, indicates the reason for the auto clock out (e.g., dailyLimit, geofenceExit)" }, "name": { "type": "string", "title": "Name", "description": "Human-readable name of the source (for NFC or geofence-based sources)" } }, "type": "object", "required": [ "type" ], "title": "PunchSourceResponse" }, "PunchSourceType": { "type": "string", "enum": [ "autoClockOut", "nfc", "mobile", "pc", "kiosk", "api", "admin" ], "title": "PunchSourceType", "description": "An enumeration." }, "RatingAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "rating" ], "title": "Questiontype", "description": "The questions type", "default": "rating" }, "ratingValue": { "type": "integer", "title": "Ratingvalue", "description": "The rating value." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty" ], "title": "RatingAnswer" }, "ResourceRateResponse": { "properties": { "resourceId": { "type": "string", "title": "Resourceid", "description": "The unique identifier of the resource in the Connecteam system" }, "rate": { "type": "number", "title": "Rate", "description": "The rate amount for this specific resource. Only present when isUsingDefaultRate is false" }, "isUsingDefaultRate": { "type": "boolean", "title": "Isusingdefaultrate", "description": "When true, this resource uses the user's defaultRate instead of the resource-specific rate" }, "subResourcesRates": { "items": { "$ref": "#/components/schemas/SubResourceRateResponse" }, "type": "array", "title": "Subresourcesrates", "description": "Array of sub-resource rate configurations nested under this parent resource" } }, "type": "object", "required": [ "resourceId", "isUsingDefaultRate" ], "title": "ResourceRateResponse" }, "ScannerAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "scanDocument" ], "title": "Questiontype", "description": "The questions type", "default": "scanDocument" }, "images": { "items": { "$ref": "#/components/schemas/FormImageModel" }, "type": "array", "title": "Images", "description": "The images." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty", "images" ], "title": "ScannerAnswer" }, "ShiftActivityResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique identifier of the time clock" }, "managerNote": { "type": "string", "title": "Managernote", "description": "The manager note providing additional details" }, "employeeNote": { "type": "string", "title": "Employeenote", "description": "The employee note providing additional details" }, "start": { "allOf": [ { "$ref": "#/components/schemas/TimeActivityTimePointResponse" } ], "title": "Start", "description": "The start time of the time activity" }, "end": { "allOf": [ { "$ref": "#/components/schemas/TimeActivityTimePointResponse" } ], "title": "End", "description": "The end time of the time activity" }, "createdAt": { "type": "integer", "minimum": 1, "title": "Createdat", "description": "The creation time of the time activity" }, "modifiedAt": { "type": "integer", "minimum": 1, "title": "Modifiedat", "description": "The last modification time of the time activity" }, "jobId": { "type": "string", "title": "Jobid", "description": "The ID of the job" }, "subJobId": { "type": "string", "title": "Subjobid", "description": "The ID of the sub job" }, "schedulerShiftId": { "type": "string", "title": "Schedulershiftid", "description": "The unique identifier of the shift from the schedule, if it exists." }, "shiftAttachments": { "items": { "$ref": "#/components/schemas/GeneralActivityShiftAttachmentResponse" }, "type": "array", "title": "Shiftattachments", "description": "The shift attachments" }, "isAutoClockOut": { "type": "boolean", "title": "Isautoclockout", "description": "Indicates whether the user was auto clocked out from the shift", "default": false } }, "type": "object", "required": [ "id", "start" ], "title": "ShiftActivityResponse" }, "ShiftBreakDataApi": { "properties": { "id": { "type": "string", "title": "Id", "description": "The id of the break" }, "name": { "type": "string", "title": "Name", "description": "The name of the break." }, "type": { "$ref": "#/components/schemas/ShiftBreakTypeAPI", "description": "The type of the break (paid/unpaid)" }, "startTime": { "anyOf": [ { "type": "integer", "minimum": 0, "description": "Integer with minimum value of 0" }, { "type": "null" } ], "title": "Starttime", "description": "The time the break starts, counted in minutes from the beginning of the day" }, "duration": { "type": "integer", "minimum": 0, "title": "Duration", "description": "The time the break lasts in minutes" } }, "type": "object", "required": [ "id", "name", "type", "duration" ], "title": "ShiftBreakDataApi" }, "ShiftBreakTypeAPI": { "type": "string", "enum": [ "paid", "unpaid" ], "title": "ShiftBreakTypeAPI" }, "ShiftCreatedWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type", "default": "shift" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "shift_created" }, "schedulerId": { "type": "integer", "minimum": 1, "title": "Schedulerid", "description": "The unique identifier of the schedule" }, "data": { "$ref": "#/components/schemas/ShiftCreatedWebhookResponseData", "description": "The data" } }, "type": "object", "required": [ "company", "eventTimestamp", "evnetTimestamp", "schedulerId", "data" ], "title": "ShiftCreatedWebhookResponse" }, "ShiftCreatedWebhookResponseData": { "properties": { "shifts": { "items": { "$ref": "#/components/schemas/WebhookShiftResponse" }, "type": "array", "title": "Shifts", "description": "The created shifts" } }, "type": "object", "required": [ "shifts" ], "title": "ShiftCreatedWebhookResponseData" }, "ShiftDeletedWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type", "default": "shift" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "shift_deleted" }, "schedulerId": { "type": "integer", "minimum": 1, "title": "Schedulerid", "description": "The unique identifier of the schedule" }, "data": { "$ref": "#/components/schemas/ShiftDeletedWebhookResponseData", "description": "The data" } }, "type": "object", "required": [ "company", "eventTimestamp", "evnetTimestamp", "schedulerId", "data" ], "title": "ShiftDeletedWebhookResponse" }, "ShiftDeletedWebhookResponseData": { "properties": { "ids": { "items": { "type": "string" }, "type": "array", "title": "Ids", "description": "The deleted shifts ids" } }, "type": "object", "required": [ "ids" ], "title": "ShiftDeletedWebhookResponseData" }, "ShiftDetailsOutput": { "properties": { "shiftLayers": { "items": { "$ref": "#/components/schemas/ShiftLayerOutput" }, "type": "array", "title": "Shiftlayers", "description": "The various layers of information associated with the shift" }, "shiftSource": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shiftsource", "description": "The source of the shift" } }, "type": "object", "title": "ShiftDetailsOutput" }, "ShiftLayerInstanceOutput": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique identifier of the value" }, "displayName": { "type": "string", "title": "Displayname", "description": "The name of the value" } }, "type": "object", "required": [ "id", "displayName" ], "title": "ShiftLayerInstanceOutput" }, "ShiftLayerOutput": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique identifier of the shift layer" }, "title": { "type": "string", "title": "Title", "description": "The name of the shift layer" }, "value": { "$ref": "#/components/schemas/ShiftLayerInstanceOutput", "description": "The value of the shift layer" } }, "type": "object", "required": [ "id", "title", "value" ], "title": "ShiftLayerOutput" }, "ShiftUpdatedWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type", "default": "shift" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "shift_updated" }, "schedulerId": { "type": "integer", "minimum": 1, "title": "Schedulerid", "description": "The unique identifier of the schedule" }, "data": { "$ref": "#/components/schemas/ShiftUpdatedWebhookResponseData", "description": "The data" } }, "type": "object", "required": [ "company", "eventTimestamp", "evnetTimestamp", "schedulerId", "data" ], "title": "ShiftUpdatedWebhookResponse" }, "ShiftUpdatedWebhookResponseData": { "properties": { "shifts": { "items": { "$ref": "#/components/schemas/WebhookShiftResponse" }, "type": "array", "title": "Shifts", "description": "The updated shifts" } }, "type": "object", "required": [ "shifts" ], "title": "ShiftUpdatedWebhookResponseData" }, "SignatureAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "signature" ], "title": "Questiontype", "description": "The questions type", "default": "signature" }, "images": { "items": { "$ref": "#/components/schemas/FormImageModel" }, "type": "array", "title": "Images", "description": "The images." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty", "images" ], "title": "SignatureAnswer" }, "SliderAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "slider" ], "title": "Questiontype", "description": "The questions type", "default": "slider" }, "value": { "type": "integer", "title": "Value", "description": "The value of the slider." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty" ], "title": "SliderAnswer" }, "StatusData": { "properties": { "statusId": { "type": "string", "title": "Statusid", "description": "The ID of the status" }, "status": { "$ref": "#/components/schemas/StatusTypesAPI", "description": "The status of the shift, valid values:\naccepted, checked_in, completed, rejected, claimed, claim_requested, unclaimed, unclaim_requested, cancel_claim_request, reset" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "The note of the status" }, "attachments": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Attachments", "description": "The attachments of the status" }, "creationTime": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Creationtime", "description": "The creation time of the status" }, "updateTime": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updatetime", "description": "The update time of the status" }, "creatingUserId": { "type": "integer", "title": "Creatinguserid", "description": "The ID of the user who created the status" }, "modifyingUserId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Modifyinguserid", "description": "The ID of the user who modified the status" }, "gps": { "anyOf": [ { "$ref": "#/components/schemas/GpsDataV2" }, { "type": "null" } ], "description": "The GPS data of the status" }, "assignedUserId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Assigneduserid", "description": "The ID of the user assigned to the status" } }, "type": "object", "required": [ "statusId", "status", "creatingUserId" ], "title": "StatusData" }, "StatusTypesAPI": { "type": "string", "enum": [ "accepted", "checked_in", "completed", "rejected", "claimed", "claim_requested", "unclaimed", "unclaim_requested", "cancel_claim_request", "reset" ], "title": "StatusTypesAPI" }, "SubResourceRateResponse": { "properties": { "subResourceId": { "type": "string", "title": "Subresourceid", "description": "The unique identifier of the sub-resource" }, "rate": { "type": "number", "title": "Rate", "description": "The rate amount for this sub-resource. Only present when isUsingParentRate is false" }, "isUsingParentRate": { "type": "boolean", "title": "Isusingparentrate", "description": "When true, this sub-resource inherits the parent resource's rate" } }, "type": "object", "required": [ "subResourceId", "isUsingParentRate" ], "title": "SubResourceRateResponse" }, "TaskAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "task" ], "title": "Questiontype", "description": "The questions type", "default": "task" }, "isChecked": { "type": "boolean", "title": "Ischecked", "description": "Whether the task is checked" } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty", "isChecked" ], "title": "TaskAnswer" }, "TaskChangedWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type" }, "data": { "items": { "type": "object" }, "type": "array", "title": "Data", "description": "data of the task" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "eventType", "data" ], "title": "TaskChangedWebhookResponse" }, "TimeActivityAdminAddWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "admin_add" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAdminAddWebhookResponse" }, "TimeActivityAdminApprovedAddRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "admin_approved_add_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAdminApprovedAddRequestWebhookResponse" }, "TimeActivityAdminApprovedClockOutOutsideGeoFenceRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "admin_approved_clock_out_outside_geo_fence_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAdminApprovedClockOutOutsideGeoFenceRequestWebhookResponse" }, "TimeActivityAdminApprovedClockOutWithoutNfcRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "admin_approved_clock_out_without_nfc_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAdminApprovedClockOutWithoutNfcRequestWebhookResponse" }, "TimeActivityAdminApprovedDeleteRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "admin_approved_delete_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAdminApprovedDeleteRequestWebhookResponse" }, "TimeActivityAdminApprovedEditRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "admin_approved_edit_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAdminApprovedEditRequestWebhookResponse" }, "TimeActivityAdminDeclinedRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "admin_declined_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAdminDeclinedRequestWebhookResponse" }, "TimeActivityAdminDeleteWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "admin_delete" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAdminDeleteWebhookResponse" }, "TimeActivityAdminEditWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "admin_edit" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAdminEditWebhookResponse" }, "TimeActivityAutoApprovedAddRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "auto_approved_add_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAutoApprovedAddRequestWebhookResponse" }, "TimeActivityAutoApprovedClockOutOutsideGeoFenceRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "auto_approved_clock_out_outside_geo_fence_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAutoApprovedClockOutOutsideGeoFenceRequestWebhookResponse" }, "TimeActivityAutoApprovedClockOutWithoutNfcRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "auto_approved_clock_out_without_nfc_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAutoApprovedClockOutWithoutNfcRequestWebhookResponse" }, "TimeActivityAutoApprovedDeleteRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "auto_approved_delete_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAutoApprovedDeleteRequestWebhookResponse" }, "TimeActivityAutoApprovedEditRequestWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "auto_approved_edit_request" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAutoApprovedEditRequestWebhookResponse" }, "TimeActivityAutoClockOutWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "auto_clock_out" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityAutoClockOutWebhookResponse" }, "TimeActivityClockInWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "clock_in" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityClockInWebhookResponse" }, "TimeActivityClockOutWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type that triggers the webhook", "default": "clock_out" }, "userId": { "type": "integer", "minimum": 1, "title": "Userid", "description": "The unique identifier of the user" }, "timeClockId": { "type": "integer", "minimum": 1, "title": "Timeclockid", "description": "The unique identifier of the time clock" }, "timeActivity": { "anyOf": [ { "$ref": "#/components/schemas/ManualBreakActivityResponse" }, { "$ref": "#/components/schemas/TimeOffActivityResponse" }, { "$ref": "#/components/schemas/ShiftActivityResponse" } ], "title": "Timeactivity", "description": "The time activity" }, "timeActivityId": { "type": "string", "title": "Timeactivityid", "description": "The time activity id" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "userId" ], "title": "TimeActivityClockOutWebhookResponse" }, "TimeActivityTimePointResponse": { "properties": { "timestamp": { "type": "integer", "minimum": 1, "title": "Timestamp", "description": "The timestamp in Unix format (in seconds)" }, "timezone": { "type": "string", "title": "Timezone", "description": "The timezone in Tz format (e.g. America/New_York)" }, "locationData": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Locationdata", "description": "The location data" }, "geofenceId": { "type": "string", "title": "Geofenceid", "description": "The ID of the geofence the user was inside when this punch was recorded. None if the punch was outside any configured geofence." }, "source": { "allOf": [ { "$ref": "#/components/schemas/PunchSourceResponse" } ], "title": "Source", "description": "Describes the origin from which the punch was created" } }, "type": "object", "required": [ "timestamp", "timezone" ], "title": "TimeActivityTimePointResponse" }, "TimeOffActivityDurationUnits": { "type": "string", "enum": [ "hours", "days" ], "title": "TimeOffActivityDurationUnits", "description": "An enumeration." }, "TimeOffActivityResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique identifier of the time clock" }, "managerNote": { "type": "string", "title": "Managernote", "description": "The manager note providing additional details" }, "employeeNote": { "type": "string", "title": "Employeenote", "description": "The employee note providing additional details" }, "start": { "allOf": [ { "$ref": "#/components/schemas/TimeActivityTimePointResponse" } ], "title": "Start", "description": "The start time of the time activity" }, "end": { "allOf": [ { "$ref": "#/components/schemas/TimeActivityTimePointResponse" } ], "title": "End", "description": "The end time of the time activity" }, "createdAt": { "type": "integer", "minimum": 1, "title": "Createdat", "description": "The creation time of the time activity" }, "modifiedAt": { "type": "integer", "minimum": 1, "title": "Modifiedat", "description": "The last modification time of the time activity" }, "policyTypeId": { "type": "string", "title": "Policytypeid", "description": "The ID of the policy type" }, "duration": { "allOf": [ { "$ref": "#/components/schemas/TimeOffDurationResponse" } ], "title": "Duration", "description": "The duration of the time off" }, "isAllDay": { "type": "boolean", "title": "Isallday", "description": "Indicates whether the time off is all day" } }, "type": "object", "required": [ "id", "start", "policyTypeId", "duration", "isAllDay" ], "title": "TimeOffActivityResponse" }, "TimeOffDurationResponse": { "properties": { "value": { "type": "number", "title": "Value", "description": "The value of the duration" }, "units": { "allOf": [ { "$ref": "#/components/schemas/TimeOffActivityDurationUnits" } ], "description": "The units of the time off in the chosen unit (hours/days)" } }, "type": "object", "required": [ "value", "units" ], "title": "TimeOffDurationResponse" }, "TimestampWithTimezone": { "properties": { "timestamp": { "type": "integer", "minimum": 1, "title": "Timestamp", "description": "The timestamp in Unix format (in seconds)" }, "timezone": { "type": "string", "title": "Timezone", "description": "The timezone in Tz format (e.g. America/New_York)" } }, "type": "object", "required": [ "timestamp", "timezone" ], "title": "TimestampWithTimezone" }, "UserCustomFields": { "type": "string", "enum": [ "email", "date", "phone", "number", "str", "dropdown", "file", "directManager", "birthday", "link", "location" ], "title": "UserCustomFields" }, "UserIdWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type" }, "data": { "items": { "type": "object" }, "type": "array", "title": "Data", "description": "The ids of the users" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "eventType", "data" ], "title": "UserIdWebhookResponse" }, "UsersChangedWebhookResponse": { "properties": { "requestId": { "type": "string", "title": "Requestid", "description": "The request id" }, "company": { "type": "string", "title": "Company", "description": "The company id" }, "activityType": { "type": "string", "title": "Activitytype", "description": "The activity type" }, "eventTimestamp": { "type": "integer", "title": "Eventtimestamp", "description": "The event unix timestamp" }, "evnetTimestamp": { "type": "integer", "title": "Evnettimestamp", "description": "DEPRECATED: Use event_timestamp instead" }, "eventType": { "type": "string", "title": "Eventtype", "description": "The event type" }, "data": { "items": { "type": "object" }, "type": "array", "title": "Data", "description": "The new data of the updated users" } }, "type": "object", "required": [ "company", "activityType", "eventTimestamp", "evnetTimestamp", "eventType", "data" ], "title": "UsersChangedWebhookResponse" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "ValidationErrorResponse": { "properties": { "details": { "allOf": [ { "$ref": "#/components/schemas/ErrorParing" } ], "title": "Details", "default": { "error_message": "Request is invalid", "error_code": 1004 } }, "error": { "anyOf": [ { "type": "object" }, { "items": { "type": "object" }, "type": "array" }, { "type": "string" } ], "title": "Error", "default": "Validation Error" }, "path": { "type": "string", "title": "Path" }, "requestId": { "type": "string", "title": "Requestid" } }, "type": "object", "title": "ValidationErrorResponse", "description": "All errors responses should include:\nrequest_id,\nConnecteam error code and error message,\nthe url path,\nthe request body,\nand error data which can be a pydantic class or a dict and should look something like this:\n`{\n \"error.path\": \"the gist of the error\"\n}`\n\nfor example if the user doesn't exist it should look something like this:\n`{\n \"user.id\": \"user doesn't exist\"\n}`" }, "VideoAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "video" ], "title": "Questiontype", "description": "The questions type", "default": "video" }, "videos": { "items": { "$ref": "#/components/schemas/FormVideoModel" }, "type": "array", "title": "Videos", "description": "The videos." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty", "videos" ], "title": "VideoAnswer" }, "WageTypesEnum": { "type": "string", "enum": [ "hourly", "monthly", "yearly" ], "title": "WageTypesEnum", "description": "An enumeration." }, "WebhookShiftResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "The ID of the shift" }, "color": { "type": "string", "title": "Color", "description": "The color of the shift" }, "assignedUserIds": { "items": { "type": "integer", "minimum": 1, "description": "Integer with minimum value of 1" }, "type": "array", "title": "Assigneduserids", "description": "The IDs of the assigned users" }, "startTime": { "type": "integer", "minimum": 1, "title": "Starttime", "description": "The start time of the shift" }, "endTime": { "type": "integer", "minimum": 1, "title": "Endtime", "description": "The end time of the shift" }, "timezone": { "type": "string", "title": "Timezone", "description": "The timezone of the shift" }, "isOpenShift": { "type": "boolean", "title": "Isopenshift", "description": "Whether the shift is an open shift" }, "title": { "type": "string", "title": "Title", "description": "The title of the shift" }, "jobId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Jobid", "description": "The ID of the job" }, "locationData": { "anyOf": [ { "$ref": "#/components/schemas/LocationDataAPI" }, { "type": "null" } ], "description": "The location data" }, "isPublished": { "type": "boolean", "title": "Ispublished", "description": "Whether the shift is published" }, "isRequireAdminApproval": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Isrequireadminapproval", "description": "Whether the shift requires admin approval" }, "updateTime": { "anyOf": [ { "type": "integer", "minimum": 1, "description": "Integer with minimum value of 1" }, { "type": "null" } ], "title": "Updatetime", "description": "The update time of the shift" }, "creationTime": { "anyOf": [ { "type": "integer", "minimum": 1, "description": "Integer with minimum value of 1" }, { "type": "null" } ], "title": "Creationtime", "description": "The creation time of the shift" }, "createdBy": { "anyOf": [ { "type": "integer", "minimum": 1, "description": "Integer with minimum value of 1" }, { "type": "null" } ], "title": "Createdby", "description": "The user ID of the admin who created the shift. If the shift was created via API, the user ID will be the owner of the authentication key" }, "openSpots": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Openspots", "description": "The number of open spots" }, "notes": { "items": { "anyOf": [ { "$ref": "#/components/schemas/HTMLNoteDataOut" }, { "$ref": "#/components/schemas/AlbumNoteDataOut" }, { "$ref": "#/components/schemas/FileNoteDataOut" } ] }, "type": "array", "title": "Notes", "description": "The notes of the shift" }, "statuses": { "items": { "$ref": "#/components/schemas/StatusData" }, "type": "array", "title": "Statuses", "description": "The statuses of the shift" }, "breaks": { "items": { "$ref": "#/components/schemas/ShiftBreakDataApi" }, "type": "array", "title": "Breaks", "description": "The breaks of the shift" }, "shiftDetails": { "$ref": "#/components/schemas/ShiftDetailsOutput", "description": "The additional details on the shift, if applicable" }, "customFields": { "items": { "$ref": "#/components/schemas/CustomFieldResponseV2" }, "type": "array", "title": "Customfields", "description": "The shift's custom fields" }, "allDay": { "type": "boolean", "title": "Allday", "description": "Indicates if the shift is an all-day event" } }, "type": "object", "required": [ "id", "color", "startTime", "endTime", "timezone", "isOpenShift", "title", "isPublished", "shiftDetails", "allDay" ], "title": "WebhookShiftResponse" }, "YesNoAnswer": { "properties": { "questionId": { "type": "string", "title": "Questionid", "description": "The questions id." }, "wasHidden": { "type": "boolean", "title": "Washidden", "description": "Whether the submission was hidden (by a condition)." }, "submissionTimestamp": { "type": "integer", "title": "Submissiontimestamp", "description": "The timestamp of the submission." }, "location": { "allOf": [ { "$ref": "#/components/schemas/GpsData" } ], "title": "Location", "description": "The location of the submission." }, "updateTimestamp": { "type": "integer", "title": "Updatetimestamp", "description": "The timestamp of the last update." }, "updateUserId": { "type": "integer", "title": "Updateuserid", "description": "The user id of the last update." }, "wasSubmittedEmpty": { "type": "boolean", "title": "Wassubmittedempty", "description": "Whether the submission was empty." }, "questionType": { "type": "string", "enum": [ "yesNo" ], "title": "Questiontype", "description": "The questions type", "default": "yesNo" }, "selectedIndex": { "type": "integer", "title": "Selectedindex", "description": "The selected index." } }, "type": "object", "required": [ "questionId", "wasSubmittedEmpty" ], "title": "YesNoAnswer" }, "v2__features__workflow__external_api__v1__form_submissions__models__response__answer_models__ManagerFieldStatus": { "properties": { "managerFieldId": { "type": "string", "title": "Managerfieldid", "description": "The manager field id." }, "managerFieldType": { "type": "string", "enum": [ "status" ], "title": "Managerfieldtype", "description": "The field type", "default": "status" }, "lastUpdatedTimestamp": { "type": "integer", "title": "Lastupdatedtimestamp", "description": "The timestamp of the status update." }, "status": { "allOf": [ { "$ref": "#/components/schemas/ManagerFieldStatusOption" } ], "title": "Status", "description": "The status of the field." } }, "type": "object", "required": [ "managerFieldId" ], "title": "ManagerFieldStatus" } }, "securitySchemes": { "APIKeyHeader": { "type": "apiKey", "description": "The Api key of the company given by Connecteam", "in": "header", "name": "X-API-KEY" }, "OAuth2": { "type": "oauth2", "description": "OAuth2 Bearer token", "flows": { "clientCredentials": { "scopes": { "account_information.read": "account information - read", "account_information.write": "account information - write", "account_information.delete": "account information - delete", "company_policies.read": "company policies - read", "company_policies.write": "company policies - write", "company_policies.delete": "company policies - delete", "company_insights.read": "company insights - read", "users.read": "users - read", "users.write": "users - write", "users.delete": "users - delete", "assets.read": "assets - read", "assets.write": "assets - write", "assets.delete": "assets - delete", "sales_data.read": "sales data - read", "sales_data.write": "sales data - write", "sales_data.delete": "sales data - delete", "attachments.read": "attachments - read", "attachments.write": "attachments - write", "attachments.delete": "attachments - delete", "quick_tasks.read": "quick tasks - read", "quick_tasks.write": "quick tasks - write", "quick_tasks.delete": "quick tasks - delete", "publishers.read": "publishers - read", "publishers.write": "publishers - write", "publishers.delete": "publishers - delete", "chat.read": "chat - read", "chat.write": "chat - write", "chat.delete": "chat - delete", "jobs.read": "jobs - read", "jobs.write": "jobs - write", "jobs.delete": "jobs - delete", "schedule.read": "schedule - read", "schedule.write": "schedule - write", "schedule.delete": "schedule - delete", "daily_note.read": "daily note - read", "daily_note.write": "daily note - write", "daily_note.delete": "daily note - delete", "time_clock.read": "time clock - read", "time_clock.write": "time clock - write", "time_clock.delete": "time clock - delete", "nfc.read": "nfc - read", "nfc.write": "nfc - write", "nfc.delete": "nfc - delete", "time_off.read": "time off - read", "time_off.write": "time off - write", "time_off.delete": "time off - delete", "pay_rates.read": "pay rates - read", "pay_rates.write": "pay rates - write", "pay_rates.delete": "pay rates - delete", "forms.read": "forms - read", "forms.write": "forms - write", "forms.delete": "forms - delete", "onboarding.read": "onboarding - read", "onboarding.write": "onboarding - write", "onboarding.delete": "onboarding - delete", "settings.read": "settings - read", "settings.write": "settings - write", "settings.delete": "settings - delete", "company_checklist.read": "company checklist - read", "company_checklist.write": "company checklist - write", "recognitions.read": "recognitions - read", "celebrations.read": "celebrations - read", "documents.read": "documents - read" }, "tokenUrl": "/oauth/v1/token" } } } } } } ```