{"openapi":"3.1.0","info":{"title":"Connecteam API documentation","version":"v1"},"servers":[{"url":"https://api.connecteam.com/"}],"paths":{"/me":{"get":{"tags":["Account"],"summary":"Get account information","description":"Retrieve the account information","operationId":"get_account_information_me_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_MeResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["account_information.read"]}]}},"/settings/v1/webhooks/{webhookId}":{"get":{"tags":["Settings:v1:Webhook"],"summary":"Get webhook","description":"Retrieve single webhook information by its unique ID","operationId":"get_webhook_settings_v1_webhooks__webhookId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["settings.read"]}],"parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the webhook","title":"Webhookid"},"description":"The unique identifier of the webhook"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_PublicBaseWebhookResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Settings:v1:Webhook"],"summary":"Update Webhook","description":"Update an existing webhook settings by its unique ID.","operationId":"update_webhook_settings_v1_webhooks__webhookId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["settings.write"]}],"parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the webhook","title":"Webhookid"},"description":"The unique identifier of the webhook"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdateRequest","description":"Update data for new webhook"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_PublicBaseWebhookResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Settings:v1:Webhook"],"summary":"Delete webhook","description":"Delete a single webhook configuration by its unique ID","operationId":"delete_webhook_settings_v1_webhooks__webhookId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["settings.delete"]}],"parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the webhook","title":"Webhookid"},"description":"The unique identifier of the webhook"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_WebhookDeleteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v1/webhooks":{"post":{"tags":["Settings:v1:Webhook"],"summary":"Create webhook","description":"Create individual webhook settings under specified details","operationId":"create_webhook_settings_v1_webhooks_post","security":[{"APIKeyHeader":[]},{"OAuth2":["settings.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRequest","description":"Create data for new webhook"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_PublicBaseWebhookResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Settings:v1:Webhook"],"summary":"Get webhooks","description":"Retrieves a list of webhook settings associated with the account.","operationId":"get_webhooks_by_type_settings_v1_webhooks_get","security":[{"APIKeyHeader":[]},{"OAuth2":["settings.read"]}],"parameters":[{"name":"featureType","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The feature type of the webhook. Current options are: users, forms, time_activity, tasks","title":"Featuretype"},"description":"The feature type of the webhook. Current options are: users, forms, time_activity, tasks"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to display per page","default":10,"title":"Limit"},"description":"The maximum number of results to display per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"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,"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"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponseV2_WebhookListResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/attachments/v1/files/generate-upload-url":{"post":{"tags":["Attachments:v1:Files"],"summary":"Generate upload url","description":"Generates a pre-signed URL that can be used to securely upload an attachment to the cloud. The pre-signed URL ensures temporary access for the upload (300 seconds), and it will be associated with a specific feature within the application.","operationId":"generate_upload_url_attachments_v1_files_generate_upload_url_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FileURLCreateRequest"}],"title":"Request Upload Url","description":"Create data for new file upload URL"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_FileURLResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["attachments.write"]}]}},"/attachments/v1/files/complete-upload/{fileId}":{"put":{"tags":["Attachments:v1:Files"],"summary":"Finalize upload","description":"Finalizes the upload process for the attachment identified by the fileId. It confirms and registers the uploaded file, ensuring it is properly associated with the relevant feature.","operationId":"finalize_upload_attachments_v1_files_complete_upload__fileId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["attachments.write"]}],"parameters":[{"name":"fileId","in":"path","required":true,"schema":{"title":"Fileid","description":"The unique identifier for the uploaded filetype","type":"string"},"description":"The unique identifier for the uploaded filetype"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_FileCompleteUploadResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/attachments/v1/files/{fileId}":{"get":{"tags":["Attachments:v1:Files"],"summary":"Get file metadata","description":"Retrieve detailed information about a previously uploaded attachment identified by the fileId. The response includes its metadata, and the status of the upload process.","operationId":"get_file_url_attachments_v1_files__fileId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["attachments.read"]}],"parameters":[{"name":"fileId","in":"path","required":true,"schema":{"title":"Fileid","description":"The unique identifier for the uploaded filetype","type":"string"},"description":"The unique identifier for the uploaded filetype"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_GetFileURLResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/attachments/v1/files/download-url":{"post":{"tags":["Attachments:v1:Files"],"summary":"Generate download URL","description":"Generates a time limited URL for downloading a file.","operationId":"generate_download_url_attachments_v1_files_download_url_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FileDownloadURLRequest"}],"title":"Request Body","description":"Request data for generating download URL"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_FileDownloadURLResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"APIKeyHeader":[]},{"OAuth2":["attachments.read"]}]}},"/forms/v1/forms/{formId}":{"get":{"tags":["Forms:v1:Forms"],"summary":"Get form","description":"Retrieve single form information by its unique ID","operationId":"get_form_forms_v1_forms__formId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["forms.read"]}],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"title":"Formid","description":"Form id to return","minimum":1,"type":"integer"},"description":"Form id to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_FormResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/forms/v1/forms":{"get":{"tags":["Forms:v1:Forms"],"summary":"Get forms","description":"Retrieve a list of forms associated with the account","operationId":"get_forms_forms_v1_forms_get","security":[{"APIKeyHeader":[]},{"OAuth2":["forms.read"]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"title":"Name","description":"The name of the form to filter by (partial, case-insensitive match)","type":"string"},"description":"The name of the form to filter by (partial, case-insensitive match)"},{"name":"startDate","in":"query","required":false,"schema":{"title":"Startdate","description":"Filter forms created on or after this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive.","type":"string"},"description":"Filter forms created on or after this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive."},{"name":"endDate","in":"query","required":false,"schema":{"title":"Enddate","description":"Filter forms created on or before this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive.","type":"string"},"description":"Filter forms created on or before this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive."},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":300,"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_FormsGetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/forms/v1/forms/{formId}/form-submissions":{"get":{"tags":["Forms:v1:Form Submissions"],"summary":"Get form submissions","description":"Retrieve a list of form submissions by form ID","operationId":"get_form_submissions_forms_v1_forms__formId__form_submissions_get","security":[{"APIKeyHeader":[]},{"OAuth2":["forms.read"]}],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"title":"Formid","description":"Filter by Form Id","minimum":1,"type":"integer"},"description":"Filter by Form Id"},{"name":"userIds","in":"query","required":false,"schema":{"title":"Userids","description":"Filter by submitting user ids","type":"array","items":{"type":"integer"}},"description":"Filter by submitting user ids"},{"name":"submittingStartTimestamp","in":"query","required":false,"schema":{"title":"Submittingstarttimestamp","description":"Filter form submissions that were submitted from this timestamp","type":"integer"},"description":"Filter form submissions that were submitted from this timestamp"},{"name":"submittingEndTime","in":"query","required":false,"schema":{"title":"Submittingendtime","description":"Filter form submissions that were submitted until this timestamp","type":"integer"},"description":"Filter form submissions that were submitted until this timestamp"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":100,"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_FormsSubmissionsGetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/forms/v1/forms/{formId}/form-submissions/{formSubmissionId}":{"get":{"tags":["Forms:v1:Form Submissions"],"summary":"Get form submission","description":"Retrieve a single form submission by form submission ID","operationId":"get_form_submission_forms_v1_forms__formId__form_submissions__formSubmissionId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["forms.read"]}],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"title":"Formid","description":"Form Id","minimum":1,"type":"integer"},"description":"Form Id"},{"name":"formSubmissionId","in":"path","required":true,"schema":{"title":"Formsubmissionid","description":"Filter by Form submission id","type":"string"},"description":"Filter by Form submission id"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_FormsSubmissionGetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Forms:v1:Form Submissions"],"summary":"Update form submission","description":"Update a single form submission by form submission ID. Currently, updates are only supported for manager fields.","operationId":"update_form_submissions_forms_v1_forms__formId__form_submissions__formSubmissionId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["forms.write"]}],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"title":"Formid","description":"Form Id","minimum":1,"type":"integer"},"description":"Form Id"},{"name":"formSubmissionId","in":"path","required":true,"schema":{"title":"Formsubmissionid","description":"Filter by Form submission id","type":"string"},"description":"Filter by Form submission id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Form Submission","allOf":[{"$ref":"#/components/schemas/FormSubmissionPutRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_FormsSubmissionPutResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/forms/v1/forms/{formId}/questions/{questionId}":{"get":{"tags":["Forms:v1:Questions"],"summary":"Get dropdown question options","description":"Retrieve the list of selectable options for a dropdown-type question within a specified form.","operationId":"get_dropdown_question_options_forms_v1_forms__formId__questions__questionId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["forms.read"]}],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"title":"Formid","description":"The unique identifier of the form","minimum":1,"type":"integer"},"description":"The unique identifier of the form"},{"name":"questionId","in":"path","required":true,"schema":{"title":"Questionid","description":"The unique identifier of the question within the specified form. This question must be of type dropdown.","type":"string"},"description":"The unique identifier of the question within the specified form. This question must be of type dropdown."},{"name":"includeDeleted","in":"query","required":false,"schema":{"title":"Includedeleted","description":"Include deleted options","default":false,"type":"boolean"},"description":"Include deleted options"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"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_GetDropdownOptionsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Forms:v1:Questions"],"summary":"Add dropdown options","description":"Add a new value option under a specified question. The value will be added to the existing value options and will not override them. Make sure the question type is of dropdown one.","operationId":"add_dropdown_options_forms_v1_forms__formId__questions__questionId__post","security":[{"APIKeyHeader":[]},{"OAuth2":["forms.write"]}],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"title":"Formid","description":"The unique identifier of the form","minimum":1,"type":"integer"},"description":"The unique identifier of the form"},{"name":"questionId","in":"path","required":true,"schema":{"title":"Questionid","description":"The unique identifier of the question within the specified form. This question must be of type dropdown.","type":"string"},"description":"The unique identifier of the question within the specified form. This question must be of type dropdown."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Dropdown Options","description":"The value to be added to the dropdown options list","allOf":[{"$ref":"#/components/schemas/AddDropdownOptionRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_AddDropdownOptionsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/forms/v1/forms/{formId}/questions/{questionId}/options/{optionId}":{"put":{"tags":["Forms:v1:Questions"],"summary":"Update dropdown option","description":"Update the label of an existing option in a dropdown-type question within a specified form. This action overrides the current value.","operationId":"update_dropdown_options_forms_v1_forms__formId__questions__questionId__options__optionId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["forms.write"]}],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"title":"Formid","description":"The unique identifier of the form","minimum":1,"type":"integer"},"description":"The unique identifier of the form"},{"name":"questionId","in":"path","required":true,"schema":{"title":"Questionid","description":"The unique identifier of the question within the specified form. This question must be of type dropdown.","type":"string"},"description":"The unique identifier of the question within the specified form. This question must be of type dropdown."},{"name":"optionId","in":"path","required":true,"schema":{"title":"Optionid","description":"The unique identifier of the specific option within the dropdown list.","type":"string"},"description":"The unique identifier of the specific option within the dropdown list."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Value Request","description":"The value to be updated. This will override the current option value.","allOf":[{"$ref":"#/components/schemas/UpdateDropdownOptionRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_UpdateDropdownOptionResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Forms:v1:Questions"],"summary":"Delete dropdown option","description":"Delete an existing selectable option from a dropdown-type question within a specified form.","operationId":"delete_dropdown_option_forms_v1_forms__formId__questions__questionId__options__optionId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["forms.delete"]}],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"title":"Formid","description":"The unique identifier of the form","minimum":1,"type":"integer"},"description":"The unique identifier of the form"},{"name":"questionId","in":"path","required":true,"schema":{"title":"Questionid","description":"The unique identifier of the question within the specified form. This question must be of type dropdown.","type":"string"},"description":"The unique identifier of the question within the specified form. This question must be of type dropdown."},{"name":"optionId","in":"path","required":true,"schema":{"title":"Optionid","description":"The unique identifier of the specific option within the dropdown list","type":"string"},"description":"The unique identifier of the specific option within the dropdown list"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_DeleteDropdownOptionResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers":{"get":{"tags":["Schedule:v1:Schedulers"],"summary":"Get schedulers","description":"Retrieve a list of schedulers associated with the account","operationId":"get_schedulers_scheduler_v1_schedulers_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_SchedulersResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}]}},"/scheduler/v1/schedulers/user-unavailability":{"get":{"tags":["Schedule:v1:Schedulers:Unavailabilities"],"summary":"Get user unavailabilities","description":"Retrieve a list of user unavailabilities, approved time-off requests and assigned shifts","operationId":"get_unavailabilities_scheduler_v1_schedulers_user_unavailability_get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"userId","in":"query","required":true,"schema":{"type":"integer","description":"The unique identifier of the user","title":"Userid"},"description":"The unique identifier of the user"},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","description":"The start time to filter by in Unix format (in seconds)","title":"Starttime"},"description":"The start time to filter by in Unix format (in seconds)"},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","description":"The end time to filter by in Unix format (in seconds)","title":"Endtime"},"description":"The end time to filter by in Unix format (in seconds)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_GetUnavailabilitiesResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers/{schedulerId}/shifts":{"get":{"tags":["Schedule:v1:Schedulers:Schedule:Shifts:Shifts"],"summary":"Get shifts","description":"Retrieve a list of shifts under a specific schedule","operationId":"get_shifts_scheduler_v1_schedulers__schedulerId__shifts_get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","description":"The start time to filter by in Unix format (in seconds)","title":"Starttime"},"description":"The start time to filter by in Unix format (in seconds)"},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","description":"The end time to filter by in Unix format (in seconds)","title":"Endtime"},"description":"The end time to filter by in Unix format (in seconds)"},{"name":"isOpenShift","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter shifts that are open shifts","title":"Isopenshift"},"description":"Filter shifts that are open shifts"},{"name":"isPublished","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter shifts that are published","title":"Ispublished"},"description":"Filter shifts that are published"},{"name":"isRequireAdminApproval","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter shifts that require admin approval","title":"Isrequireadminapproval"},"description":"Filter shifts that require admin approval"},{"name":"jobId","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"List of job IDs","title":"Jobid"},"description":"List of job IDs"},{"name":"assignedUserIds","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"integer","minimum":1,"description":"Integer with minimum value of 1"}},{"type":"null"}],"description":"List of user IDs","title":"Assigneduserids"},"description":"List of user IDs"},{"name":"shiftId","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"List of shift IDs","title":"Shiftid"},"description":"List of shift IDs"},{"name":"title","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the shift","title":"Title"},"description":"Title of the shift"},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ShiftsSortKeysExternal","description":"Sort key","default":"created_at"},"description":"Sort key"},{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Sort order, set only if sort key is set","default":"asc"},"description":"Sort order, set only if sort key is set"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"The maximum number of results to display per page","default":10,"title":"Limit"},"description":"The maximum number of results to display per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"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,"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"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponseV2_ShiftBulkResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Schedule:v1:Schedulers:Schedule:Shifts:Shifts"],"summary":"Create shifts","description":"Create single or multiple shifts under a specific schedule","operationId":"create_shifts_scheduler_v1_schedulers__schedulerId__shifts_post","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.write"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"notifyUsers","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.","default":true,"title":"Notifyusers"},"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShiftCreateRequest"},"max_items":500,"title":"Shifts"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_ShiftBulkResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Schedule:v1:Schedulers:Schedule:Shifts:Shifts"],"summary":"Delete shifts","description":"Delete single or multiple shifts in a specified schedule","operationId":"delete_shifts_by_ids_scheduler_v1_schedulers__schedulerId__shifts_delete","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.delete"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"notifyUsers","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.","default":true,"title":"Notifyusers"},"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShiftBulkDeleteRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_ShiftBulkDeleteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Schedule:v1:Schedulers:Schedule:Shifts:Shifts"],"summary":"Update shifts","description":"Update single or multiple shifts under a specific schedule","operationId":"update_shifts_scheduler_v1_schedulers__schedulerId__shifts_put","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.write"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"notifyUsers","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.","default":true,"title":"Notifyusers"},"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShiftUpdateRequest"},"title":"Shifts"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_ShiftUpdateBulkResponse_"}}}},"400":{"description":"Invalid shift update request. For targeted V2 Vision base/group edits, assignedUserIds must be provided when isEditForAllUsers is explicitly false."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers/{schedulerId}/shifts/{shiftId}":{"get":{"tags":["Schedule:v1:Schedulers:Schedule:Shifts:Shifts"],"summary":"Get shift","description":"Retrieve single shift information by its unique ID","operationId":"get_shift_by_id_scheduler_v1_schedulers__schedulerId__shifts__shiftId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"shiftId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the shift","title":"Shiftid"},"description":"The unique identifier of the shift"},{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_ShiftResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Schedule:v1:Schedulers:Schedule:Shifts:Shifts"],"summary":"Delete shift","description":"Delete a single shift by its unique ID","operationId":"delete_shift_by_id_scheduler_v1_schedulers__schedulerId__shifts__shiftId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.delete"]}],"parameters":[{"name":"shiftId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the shift to delete","title":"Shiftid"},"description":"The ID of the shift to delete"},{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"notifyUsers","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.","default":true,"title":"Notifyusers"},"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_ShiftDeleteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers/{schedulerId}/shift-layers":{"get":{"tags":["Schedule:v1:Schedulers:Schedule:Shift layers"],"summary":"Get shift layers","description":"Retrieve a list of shift layers under a specified schedule","operationId":"get_shift_layers_scheduler_v1_schedulers__schedulerId__shift_layers_get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_GetSchedulerShiftLayersResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers/{schedulerId}/shift-layers/{layerId}/values":{"get":{"tags":["Schedule:v1:Schedulers:Schedule:Shift layers"],"summary":"Get shift layer values","description":"Retrieve the possible values of a shift layer","operationId":"get_shift_layer_values_scheduler_v1_schedulers__schedulerId__shift_layers__layerId__values_get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"layerId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the layer","title":"Layerid"},"description":"The unique identifier of the layer"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"The maximum number of results to display per page","default":10,"title":"Limit"},"description":"The maximum number of results to display per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"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,"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"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponseV2_GetSchedulerShiftLayerValuesResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers/{schedulerId}/custom-fields":{"get":{"tags":["Schedule:v1:Schedulers:Schedule:Shift Custom Fields"],"summary":"Get shift custom fields","description":"Retrieves all shift custom fields associated with the scheduler","operationId":"get_shift_custom_fields_scheduler_v1_schedulers__schedulerId__custom_fields_get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to display per page","default":10,"title":"Limit"},"description":"The maximum number of results to display per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"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,"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"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponseV2_GetShiftCustomFieldsSettingsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers/{schedulerId}/shifts/auto-assign":{"post":{"tags":["Schedule:v1:Schedulers:Schedule:Shift Auto Assign"],"summary":"Create auto-assign request","description":"Initiate a request to auto-assign shifts by their IDs. If multiple IDs are provided, all corresponding shifts must occur within the same work week (e.g., Monday to Sunday). This endpoint only submits the request; processing may take a few minutes. The auto-assignment considers user preferences to work, unavailability, and approved time off. For assignment status, refer to the auto-assign status endpoint.","operationId":"create_autofill_request_scheduler_v1_schedulers__schedulerId__shifts_auto_assign_post","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.write"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoAssignRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_AutoAssignResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers/{schedulerId}/shifts/auto-assign/{autoAssignRequestId}":{"get":{"tags":["Schedule:v1:Schedulers:Schedule:Shift Auto Assign"],"summary":"Get auto-assign status","description":"Retrieve the status of an auto-assign request using its unique request ID. The response categorizes the results into 'scheduled shifts' for successfully assigned shifts and 'unscheduled shifts' for those where auto-assignment was not successful.","operationId":"get_autofill_status_scheduler_v1_schedulers__schedulerId__shifts_auto_assign__autoAssignRequestId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"autoAssignRequestId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the auto assign request","title":"Autoassignrequestid"},"description":"The unique identifier of the auto assign request"},{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_AutoAssignStatusResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers/{schedulerId}/unavailability":{"post":{"tags":["Schedule:v1:Schedulers:Schedule:Schedule Unavailability"],"summary":"Create schedule unavailability","description":"Create a single unavailability in the specified schedule for a designated user on a given date. The unavailability can be set for the entire day or for a specific part of it. Repeating unavailabilities are currently not supported. The timezone of the unavailability will be determined based on the schedule's settings.","operationId":"create_scheduler_unavailability_scheduler_v1_schedulers__schedulerId__unavailability_post","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.write"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnavailabilityCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_UnavailabilityCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers/{schedulerId}/unavailability/{unavailabilityId}":{"delete":{"tags":["Schedule:v1:Schedulers:Schedule:Schedule Unavailability"],"summary":"Delete schedule unavailability","description":"Delete existing unavailability by its unavailability ID","operationId":"delete_scheduler_unavailability_scheduler_v1_schedulers__schedulerId__unavailability__unavailabilityId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.delete"]}],"parameters":[{"name":"unavailabilityId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the unavailability","title":"Unavailabilityid"},"description":"The unique identifier of the unavailability"},{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_UnavailabilityDeleteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v1/schedulers/{schedulerId}/unavailabilities":{"get":{"tags":["Schedule:v1:Schedulers:Schedule:Schedule Unavailabilities"],"summary":"Get schedule unavailabilities","description":"Retrieve a list of unavailabilities under a specific schedule filtered by date range. The response is paginated and can be filtered by user ID.","operationId":"get_unavailabilities_scheduler_v1_schedulers__schedulerId__unavailabilities_get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","description":"The start time to filter by in Unix format (in seconds)","title":"Starttime"},"description":"The start time to filter by in Unix format (in seconds)"},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","description":"The end time to filter by in Unix format (in seconds)","title":"Endtime"},"description":"The end time to filter by in Unix format (in seconds)"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"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/PaginatedBaseResponseV2_UnavailabilitiesListGetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v2/schedulers/{schedulerId}/shifts":{"get":{"tags":["Schedule:v2:Schedulers:Schedule:Shifts (V2):Shifts"],"summary":"Get shifts","description":"Retrieve a list of shifts under a specific schedule","operationId":"get_shifts_scheduler_v2_schedulers__schedulerId__shifts_get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","description":"The start time to filter by in Unix format (in seconds)","title":"Starttime"},"description":"The start time to filter by in Unix format (in seconds)"},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","description":"The end time to filter by in Unix format (in seconds)","title":"Endtime"},"description":"The end time to filter by in Unix format (in seconds)"},{"name":"isOpenShift","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter shifts that are open shifts","title":"Isopenshift"},"description":"Filter shifts that are open shifts"},{"name":"isPublished","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter shifts that are published","title":"Ispublished"},"description":"Filter shifts that are published"},{"name":"isRequireAdminApproval","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter shifts that require admin approval","title":"Isrequireadminapproval"},"description":"Filter shifts that require admin approval"},{"name":"jobId","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"List of job IDs","title":"Jobid"},"description":"List of job IDs"},{"name":"assignedUserIds","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"integer","minimum":1,"description":"Integer with minimum value of 1"}},{"type":"null"}],"description":"List of user IDs","title":"Assigneduserids"},"description":"List of user IDs"},{"name":"shiftId","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"List of shift IDs","title":"Shiftid"},"description":"List of shift IDs"},{"name":"title","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the shift","title":"Title"},"description":"Title of the shift"},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ShiftsSortKeysExternal","description":"Sort key","default":"created_at"},"description":"Sort key"},{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Sort order, set only if sort key is set","default":"asc"},"description":"Sort order, set only if sort key is set"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"The maximum number of results to display per page","default":10,"title":"Limit"},"description":"The maximum number of results to display per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"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,"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"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponseV2_ShiftBulkResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Schedule:v2:Schedulers:Schedule:Shifts (V2):Shifts"],"summary":"Create shifts","description":"Create single or multiple shifts under a specific schedule","operationId":"create_shifts_scheduler_v2_schedulers__schedulerId__shifts_post","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.write"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"notifyUsers","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.","default":true,"title":"Notifyusers"},"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShiftCreateRequest"},"max_items":500,"title":"Shifts"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_ShiftBulkResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Schedule:v2:Schedulers:Schedule:Shifts (V2):Shifts"],"summary":"Delete shifts","description":"Delete single or multiple shifts in a specified schedule","operationId":"delete_shifts_by_ids_scheduler_v2_schedulers__schedulerId__shifts_delete","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.delete"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"notifyUsers","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.","default":true,"title":"Notifyusers"},"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShiftBulkDeleteRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_ShiftBulkDeleteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Schedule:v2:Schedulers:Schedule:Shifts (V2):Shifts"],"summary":"Update shifts","description":"Update single or multiple shifts under a specific schedule","operationId":"update_shifts_scheduler_v2_schedulers__schedulerId__shifts_put","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.write"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"notifyUsers","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.","default":true,"title":"Notifyusers"},"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShiftUpdateRequest"},"title":"Shifts"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_ShiftUpdateBulkResponse_"}}}},"400":{"description":"Invalid shift update request. For targeted V2 Vision base/group edits, assignedUserIds must be provided when isEditForAllUsers is explicitly false."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v2/schedulers/{schedulerId}/shifts/{shiftId}":{"get":{"tags":["Schedule:v2:Schedulers:Schedule:Shifts (V2):Shifts"],"summary":"Get shift","description":"Retrieve single shift information by its unique ID","operationId":"get_shift_by_id_scheduler_v2_schedulers__schedulerId__shifts__shiftId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"shiftId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the shift","title":"Shiftid"},"description":"The unique identifier of the shift"},{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_ShiftResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Schedule:v2:Schedulers:Schedule:Shifts (V2):Shifts"],"summary":"Delete shift","description":"Delete a single shift by its unique ID","operationId":"delete_shift_by_id_scheduler_v2_schedulers__schedulerId__shifts__shiftId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.delete"]}],"parameters":[{"name":"shiftId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the shift to delete","title":"Shiftid"},"description":"The ID of the shift to delete"},{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"},{"name":"notifyUsers","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.","default":true,"title":"Notifyusers"},"description":"Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_ShiftDeleteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v2/schedulers/{schedulerId}/shifts/auto-assign":{"post":{"tags":["Schedule:v2:Schedulers:Schedule:Shift Auto Assign (V2):Shift Auto Assign"],"summary":"Create auto-assign request","description":"Initiate a request to auto-assign shifts by their IDs. If multiple IDs are provided, all corresponding shifts must occur within the same work week (e.g., Monday to Sunday). This endpoint only submits the request; processing may take a few minutes. The auto-assignment considers user preferences to work, unavailability, and approved time off. For assignment status, refer to the auto-assign status endpoint.","operationId":"create_autofill_request_scheduler_v2_schedulers__schedulerId__shifts_auto_assign_post","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.write"]}],"parameters":[{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoAssignRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_AutoAssignResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v2/schedulers/{schedulerId}/shifts/auto-assign/{autoAssignRequestId}":{"get":{"tags":["Schedule:v2:Schedulers:Schedule:Shift Auto Assign (V2):Shift Auto Assign"],"summary":"Get auto-assign status","description":"Retrieve the status of an auto-assign request using its unique request ID. The response categorizes the results into 'scheduled shifts' for successfully assigned shifts and 'unscheduled shifts' for those where auto-assignment was not successful.","operationId":"get_autofill_status_scheduler_v2_schedulers__schedulerId__shifts_auto_assign__autoAssignRequestId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"autoAssignRequestId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the auto assign request","title":"Autoassignrequestid"},"description":"The unique identifier of the auto assign request"},{"name":"schedulerId","in":"path","required":true,"schema":{"type":"integer","description":"The unique identifier of the schedule","title":"Schedulerid"},"description":"The unique identifier of the schedule"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_AutoAssignStatusResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scheduler/v2/schedulers/user-unavailability":{"get":{"tags":["Schedule:v2:Schedulers:Unavailabilities (V2):Unavailabilities"],"summary":"Get user unavailabilities","description":"Retrieve a list of user unavailabilities, approved time-off requests and assigned shifts","operationId":"get_unavailabilities_scheduler_v2_schedulers_user_unavailability_get","security":[{"APIKeyHeader":[]},{"OAuth2":["schedule.read"]}],"parameters":[{"name":"userId","in":"query","required":true,"schema":{"type":"integer","description":"The unique identifier of the user","title":"Userid"},"description":"The unique identifier of the user"},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","description":"The start time to filter by in Unix format (in seconds)","title":"Starttime"},"description":"The start time to filter by in Unix format (in seconds)"},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","description":"The end time to filter by in Unix format (in seconds)","title":"Endtime"},"description":"The end time to filter by in Unix format (in seconds)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_GetUnavailabilitiesResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/v1/jobs":{"get":{"tags":["Jobs:v1:Jobs"],"summary":"Get jobs","description":"Get a list of job objects relevant to instance id (scheduler id or time clock id).\nIf unified jobs are disabled, only schedulers are supported","operationId":"get_jobs_jobs_v1_jobs_get","security":[{"APIKeyHeader":[]},{"OAuth2":["jobs.read"]}],"parameters":[{"name":"instanceIds","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"integer"}},{"type":"null"}],"description":"List of instance IDs (schedule id or time clock id) to filter by","title":"Instanceids"},"description":"List of instance IDs (schedule id or time clock id) to filter by"},{"name":"jobIds","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"List of job IDs to filter by. In cases where a job ID includes nested sub-jobs, all sub-jobs under that parent job will be retrieved alongside with the parent job. Note that this filter does not support direct querying by sub-job IDs. To retrieve specific sub-jobs, please use the Get Job endpoint","title":"Jobids"},"description":"List of job IDs to filter by. In cases where a job ID includes nested sub-jobs, all sub-jobs under that parent job will be retrieved alongside with the parent job. Note that this filter does not support direct querying by sub-job IDs. To retrieve specific sub-jobs, please use the Get Job endpoint"},{"name":"jobNames","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"List of job names to filter by. In case where a sub-job name is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job.","title":"Jobnames"},"description":"List of job names to filter by. In case where a sub-job name is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job."},{"name":"jobCodes","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"List of job codes to filter by. In case where a sub-job code is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job.","title":"Jobcodes"},"description":"List of job codes to filter by. In case where a sub-job code is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job."},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Determines whether the response includes jobs that have been deleted. Default value is set to true.","default":true,"title":"Includedeleted"},"description":"Determines whether the response includes jobs that have been deleted. Default value is set to true."},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/JobsSortKeysExternal","description":"Sort key"},"description":"Sort key"},{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Sort order, set only if sort key is set","default":"asc"},"description":"Sort order, set only if sort key is set"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"The maximum number of results to display per page","default":10,"title":"Limit"},"description":"The maximum number of results to display per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"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,"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"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponseV2_JobsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Jobs:v1:Jobs"],"summary":"Create jobs","description":"Create individual or multiple jobs under a specified scheduler","operationId":"create_jobs_jobs_v1_jobs_post","security":[{"APIKeyHeader":[]},{"OAuth2":["jobs.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/JobCreateRequest"},{"$ref":"#/components/schemas/SubJobCreateRequest"}]},"maxItems":500,"description":"Request model for the new Jobs","title":"Jobs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_JobsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/v1/jobs/{jobId}":{"get":{"tags":["Jobs:v1:Job"],"summary":"Get job","description":"Retrieve a single job information by its unique ID","operationId":"get_job_jobs_v1_jobs__jobId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["jobs.read"]}],"parameters":[{"name":"jobId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the job","title":"Jobid"},"description":"The unique identifier of the job"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_JobResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Jobs:v1:Job"],"summary":"Update job","description":"Update a single job by its unique identifier. Currently, updating job with nested sub-jobs is not supported.","operationId":"update_job_jobs_v1_jobs__jobId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["jobs.write"]}],"parameters":[{"name":"jobId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the job","title":"Jobid"},"description":"The unique identifier of the job"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/SubJobUpdateRequest"},{"$ref":"#/components/schemas/JobUpdateRequest"}],"title":"Job Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_JobResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Jobs:v1:Job"],"summary":"Delete job","description":"Delete a single job by its unique identifier.\n        Currently, deleting a sub-job and/or job with nested sub-jobs is not supported.","operationId":"delete_job_jobs_v1_jobs__jobId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["jobs.delete"]}],"parameters":[{"name":"jobId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the job","title":"Jobid"},"description":"The unique identifier of the job"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponseV2_DeleteJobResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/v1/custom-fields":{"get":{"tags":["Jobs:v1:Custom Fields"],"summary":"Get resource custom fields","description":"Retrieves all resource custom fields associated with the account. Optionally, filter the results by custom field IDs, names, or types.","operationId":"get_resource_custom_fields_jobs_v1_custom_fields_get","security":[{"APIKeyHeader":[]},{"OAuth2":["jobs.read"]}],"parameters":[{"name":"customFieldIds","in":"query","required":false,"schema":{"title":"Customfieldids","description":"Custom field ids to filter by","type":"array","items":{"type":"integer"}},"description":"Custom field ids to filter by"},{"name":"categoryIds","in":"query","required":false,"schema":{"title":"Categoryids","description":"Custom field category ids to filter by","type":"array","items":{"type":"integer"}},"description":"Custom field category ids to filter by"},{"name":"customFieldTypes","in":"query","required":false,"schema":{"description":"Custom field types to filter by","type":"array","items":{"$ref":"#/components/schemas/ResourceCustomFields"}},"description":"Custom field types to filter by"},{"name":"customFieldNames","in":"query","required":false,"schema":{"title":"Customfieldnames","description":"Custom field names to filter by","type":"array","items":{"type":"string"}},"description":"Custom field names to filter by"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"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"},{"name":"sort","in":"query","required":false,"schema":{"description":"Sort key","allOf":[{"$ref":"#/components/schemas/ResourceCustomFieldsSortExternal"}]},"description":"Sort key"},{"name":"order","in":"query","required":false,"schema":{"description":"Sort order, set only if sort key is set","default":"asc","allOf":[{"$ref":"#/components/schemas/SortOrder"}]},"description":"Sort order, set only if sort key is set"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponse_GetResourceCustomFieldsSettingsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/users":{"get":{"tags":["Users:v1:Users"],"summary":"Get users","description":"Retrieves a list of all users associated with the account. Optionally, filter by user ID to receive specific user information","operationId":"get_users_users_v1_users_get","security":[{"APIKeyHeader":[]},{"OAuth2":["users.read"]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"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"},{"name":"sort","in":"query","required":false,"schema":{"description":"Sort key","allOf":[{"$ref":"#/components/schemas/UsersSortKeysExternal"}]},"description":"Sort key"},{"name":"order","in":"query","required":false,"schema":{"description":"Sort order, set only if sort key is set","default":"asc","allOf":[{"$ref":"#/components/schemas/SortOrder"}]},"description":"Sort order, set only if sort key is set"},{"name":"userIds","in":"query","required":false,"schema":{"title":"Userids","description":"List of user IDs for filtering.","type":"array","items":{"type":"integer","minimum":1}},"description":"List of user IDs for filtering."},{"name":"userStatus","in":"query","required":false,"schema":{"description":"Filter users by status. Default is active.","default":"active","allOf":[{"$ref":"#/components/schemas/UserStatus"}]},"description":"Filter users by status. Default is active."},{"name":"fullNames","in":"query","required":false,"schema":{"title":"Fullnames","description":"List of full names to filter by. Specify the exact first and last name with a space between them as shown in the platform (ignore capitalization).","type":"array","items":{"type":"string"}},"description":"List of full names to filter by. Specify the exact first and last name with a space between them as shown in the platform (ignore capitalization)."},{"name":"phoneNumbers","in":"query","required":false,"schema":{"title":"Phonenumbers","description":"List of phone numbers to filter by (in format +<country code><phone number>).","type":"array","items":{"type":"string"}},"description":"List of phone numbers to filter by (in format +<country code><phone number>)."},{"name":"emailAddresses","in":"query","required":false,"schema":{"title":"Emailaddresses","description":"List of email addresses to filter by (in format test@test.com).","type":"array","items":{"type":"string"}},"description":"List of email addresses to filter by (in format test@test.com)."},{"name":"createdAt","in":"query","required":false,"schema":{"title":"Createdat","description":"Parameter specifying the date in Unix format (in seconds). Only users created after this date will be included in the results.","minimum":1,"type":"integer"},"description":"Parameter specifying the date in Unix format (in seconds). Only users created after this date will be included in the results."},{"name":"modifiedAt","in":"query","required":false,"schema":{"title":"Modifiedat","description":"Parameter specifying the date in in Unix format (in seconds). Only users with fields updated after this date will be included in the results.","minimum":1,"type":"integer"},"description":"Parameter specifying the date in in Unix format (in seconds). Only users with fields updated after this date will be included in the results."},{"name":"lastLogin","in":"query","required":false,"schema":{"title":"Lastlogin","description":"Parameter specifying the date in in Unix format (in seconds). Only users who's logged in after this date will be included in the results.","minimum":1,"type":"integer"},"description":"Parameter specifying the date in in Unix format (in seconds). Only users who's logged in after this date will be included in the results."},{"name":"archivedAt","in":"query","required":false,"schema":{"title":"Archivedat","description":"Parameter specifying the date in Unix format (in seconds). Only users archived after this date will be included in the results.","minimum":1,"type":"integer"},"description":"Parameter specifying the date in Unix format (in seconds). Only users archived after this date will be included in the results."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponse_UsersResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Users:v1:Users"],"summary":"Create users","description":"Create individual or multiple users associated with the account using the provided details.","operationId":"create_users_users_v1_users_post","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"parameters":[{"name":"sendActivation","in":"query","required":false,"schema":{"title":"Sendactivation","description":"Optional flag to send activation sms.","default":false,"type":"boolean"},"description":"Optional flag to send activation sms."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Users","description":"List of users to create.","maxItems":25,"type":"array","items":{"$ref":"#/components/schemas/UserCreateRequest"}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_CreateUsersResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users:v1:Users"],"summary":"Archive users","description":"Archive or permanently delete individual or multiple users associated with the account by their unique userID. In case of deletion, it will permanently delete the users from the system and cannot be undone.","operationId":"archive_users_users_v1_users_delete","security":[{"APIKeyHeader":[]},{"OAuth2":["users.delete"]}],"parameters":[{"name":"deletionType","in":"query","required":false,"schema":{"description":"Determines whether to archive the users or permanently delete the users from the account. Permanent deletion is limited to 25 users per request.","default":"archive","allOf":[{"$ref":"#/components/schemas/DeletionType"}]},"description":"Determines whether to archive the users or permanently delete the users from the account. Permanent deletion is limited to 25 users per request."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","minimum":1,"description":"Integer with minimum value of 1"},"title":"Userids"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_ArchiveUsersResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Users:v1:Users"],"summary":"Update users","description":"Update individual or multiple users associated with the account using the provided details. You can specify updates either by their phone number or unique userID.","operationId":"edit_users_users_v1_users_put","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"parameters":[{"name":"editUsersByPhone","in":"query","required":false,"schema":{"title":"Editusersbyphone","description":"Optional flag to edit users by phone (default by user id).","default":false,"type":"boolean"},"description":"Optional flag to edit users by phone (default by user id)."},{"name":"includeSmartGroupIds","in":"query","required":false,"schema":{"title":"Includesmartgroupids","description":"Indicates whether to include smart group IDs in the response body for the updated user(s). Please note that setting this value to true may increase the request time significantly.","default":true,"type":"boolean"},"description":"Indicates whether to include smart group IDs in the response body for the updated user(s). Please note that setting this value to true may increase the request time significantly."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Users","description":"List of users to edit.","maxItems":25,"type":"array","items":{"$ref":"#/components/schemas/UserEditRequest"}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_EditUsersResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/users/{userId}":{"delete":{"tags":["Users:v1:Users"],"summary":"Delete user","description":"Delete or archive user associated with the account. In case of deletion, it will permanently delete the user from the system and cannot be undone.","operationId":"delete_user_users_v1_users__userId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["users.delete"]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","description":"The ID of the user to archive or delete","minimum":1,"type":"integer"},"description":"The ID of the user to archive or delete"},{"name":"deletionType","in":"query","required":false,"schema":{"description":"Determines whether to archive the user or permanently delete the user from the account.","default":"archive","allOf":[{"$ref":"#/components/schemas/DeletionType"}]},"description":"Determines whether to archive the user or permanently delete the user from the account."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_ArchiveUsersResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/custom-fields":{"get":{"tags":["Users:v1:Custom Fields"],"summary":"Get custom fields","description":"Retrieves all custom fields associated with the account. Optionally, filter the results by categories, names, types, or custom field IDs.","operationId":"get_custom_fields_users_v1_custom_fields_get","security":[{"APIKeyHeader":[]},{"OAuth2":["users.read"]}],"parameters":[{"name":"customFieldIds","in":"query","required":false,"schema":{"title":"Customfieldids","description":"Custom field ids to filter by","type":"array","items":{"type":"integer"}},"description":"Custom field ids to filter by"},{"name":"categoryIds","in":"query","required":false,"schema":{"title":"Categoryids","description":"Custom field category ids to filter by","type":"array","items":{"type":"integer"}},"description":"Custom field category ids to filter by"},{"name":"customFieldTypes","in":"query","required":false,"schema":{"description":"Custom field types to filter by","type":"array","items":{"$ref":"#/components/schemas/UserCustomFields"}},"description":"Custom field types to filter by"},{"name":"customFieldNames","in":"query","required":false,"schema":{"title":"Customfieldnames","description":"Custom field names to filter by","type":"array","items":{"type":"string"}},"description":"Custom field names to filter by"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"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"},{"name":"sort","in":"query","required":false,"schema":{"description":"Sort key","allOf":[{"$ref":"#/components/schemas/CustomFieldsSortExternal"}]},"description":"Sort key"},{"name":"order","in":"query","required":false,"schema":{"description":"Sort order, set only if sort key is set","default":"asc","allOf":[{"$ref":"#/components/schemas/SortOrder"}]},"description":"Sort order, set only if sort key is set"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponse_GetCustomFieldsSettingsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Users:v1:Custom Fields"],"summary":"Create custom fields","description":"Create individual or multiple custom fields associated with the account under a specific category.","operationId":"create_custom_fields_users_v1_custom_fields_post","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Body","allOf":[{"$ref":"#/components/schemas/Body_create_custom_fields_users_v1_custom_fields_post"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_GetCustomFieldsSettingsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Users:v1:Custom Fields"],"summary":"Update custom fields","description":"Update custom fields settings by their unique ID","operationId":"update_custom_fields_users_v1_custom_fields_put","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Body","allOf":[{"$ref":"#/components/schemas/Body_update_custom_fields_users_v1_custom_fields_put"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_GetCustomFieldsSettingsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users:v1:Custom Fields"],"summary":"Delete custom fields","description":"Delete individual or multiple custom fields associated with the account by their unique ID.","operationId":"delete_custom_fields_users_v1_custom_fields_delete","security":[{"APIKeyHeader":[]},{"OAuth2":["users.delete"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Body","allOf":[{"$ref":"#/components/schemas/Body_delete_custom_fields_users_v1_custom_fields_delete"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BulkDeleteCustomFieldResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/custom-fields/{customFieldId}/options":{"get":{"tags":["Users:v1:Custom Fields:Custom Field options"],"summary":"Get custom field options","description":"Retrieve a list of all dropdown value options under a specified custom field","operationId":"get_custom_field_options_users_v1_custom_fields__customFieldId__options_get","security":[{"APIKeyHeader":[]},{"OAuth2":["users.read"]}],"parameters":[{"name":"customFieldId","in":"path","required":true,"schema":{"title":"Customfieldid","description":"The unique identifier of the custom field","type":"integer"},"description":"The unique identifier of the custom field"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":100,"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"},{"name":"isDisabled","in":"query","required":false,"schema":{"title":"Isdisabled","description":"Parameter specifying the if to filter only for disabled options.","type":"boolean"},"description":"Parameter specifying the if to filter only for disabled options."},{"name":"isDeleted","in":"query","required":false,"schema":{"title":"Isdeleted","description":"Parameter specifying the if to filter only for deleted options.","default":false,"type":"boolean"},"description":"Parameter specifying the if to filter only for deleted options."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponse_CustomFieldOptionsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Users:v1:Custom Fields:Custom Field options"],"summary":"Create custom field option","description":"Add new option for a specified custom field.The option will be added to the existing ones and will not overwrite them.Currently supports dropdown custom fields options.","operationId":"create_custom_field_option_users_v1_custom_fields__customFieldId__options_post","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"parameters":[{"name":"customFieldId","in":"path","required":true,"schema":{"title":"Customfieldid","description":"The unique identifier of the custom field","type":"integer"},"description":"The unique identifier of the custom field"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Option Request","allOf":[{"$ref":"#/components/schemas/CreateDropdownCustomFieldOption"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_DropdownCustomFieldOptionResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/custom-fields/{customFieldId}/options/{optionId}":{"put":{"tags":["Users:v1:Custom Fields:Custom Field options"],"summary":"Update custom field option","description":"Update the value for an option under a specified custom field","operationId":"edit_custom_field_option_users_v1_custom_fields__customFieldId__options__optionId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"parameters":[{"name":"optionId","in":"path","required":true,"schema":{"title":"Optionid","description":"The unique identifier of the option to update","type":"integer"},"description":"The unique identifier of the option to update"},{"name":"customFieldId","in":"path","required":true,"schema":{"title":"Customfieldid","description":"The unique identifier of the custom field","type":"integer"},"description":"The unique identifier of the custom field"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Option Request","allOf":[{"$ref":"#/components/schemas/EditSingleDropdownCustomFieldOption"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_DropdownCustomFieldOptionResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users:v1:Custom Fields:Custom Field options"],"summary":"Delete custom field option","description":"Delete the value for an option under a specified custom field","operationId":"delete_custom_field_option_users_v1_custom_fields__customFieldId__options__optionId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["users.delete"]}],"parameters":[{"name":"optionId","in":"path","required":true,"schema":{"title":"Optionid","description":"The unique identifier of the option to delete","type":"integer"},"description":"The unique identifier of the option to delete"},{"name":"customFieldId","in":"path","required":true,"schema":{"title":"Customfieldid","description":"The unique identifier of the custom field","type":"integer"},"description":"The unique identifier of the custom field"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/custom-field-categories":{"get":{"tags":["Users:v1:Custom Field Categories"],"summary":"Get custom field categories","description":"Retrieves all custom fields categories associated with the account. Optionally, filter the results by category IDs and/or names.","operationId":"get_custom_fields_users_v1_custom_field_categories_get","security":[{"APIKeyHeader":[]},{"OAuth2":["users.read"]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"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"},{"name":"categoryIds","in":"query","required":false,"schema":{"title":"Categoryids","description":"Custom field category ids to filter by","type":"array","items":{"type":"integer"}},"description":"Custom field category ids to filter by"},{"name":"categoryNames","in":"query","required":false,"schema":{"title":"Categorynames","description":"Custom field category names to filter by","type":"array","items":{"type":"string"}},"description":"Custom field category names to filter by"},{"name":"sort","in":"query","required":false,"schema":{"description":"Sort key","allOf":[{"$ref":"#/components/schemas/CustomFieldCategoriesSortExternal"}]},"description":"Sort key"},{"name":"order","in":"query","required":false,"schema":{"description":"Sort order, set only if sort key is set","default":"asc","allOf":[{"$ref":"#/components/schemas/SortOrder"}]},"description":"Sort order, set only if sort key is set"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseResponse_CustomFieldCategoriesResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/smart-groups":{"get":{"tags":["Users:v1:Smart Groups"],"summary":"Get smart groups","description":"Retrieves a list of smart groups associated with the account.","operationId":"get_smart_groups_users_v1_smart_groups_get","security":[{"APIKeyHeader":[]},{"OAuth2":["users.read"]}],"parameters":[{"name":"id","in":"query","required":false,"schema":{"title":"Id","description":"The unique identifier of the smart group.","type":"integer"},"description":"The unique identifier of the smart group."},{"name":"name","in":"query","required":false,"schema":{"title":"Name","description":"The name of the smart group to filter by.","type":"string"},"description":"The name of the smart group to filter by."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_GetSmartGroupsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Users:v1:Smart Groups"],"summary":"Create smart group","description":"Create a new smart group under a specified segment. The smart group settings are currently based only on dropdown custom field type (support for additional field types will be added in the future). The created group is dynamic, meaning any new or existing users who meet the selected value criteria will be automatically added to the smart group.","operationId":"create_smart_group_users_v1_smart_groups_post","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/SmartGroupCreateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_SmartGroupCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/smart-groups/{smartGroupId}":{"put":{"tags":["Users:v1:Smart Groups"],"summary":"Update smart group","description":"Update an existing smart group by its unique identifier. Any changes to the applied filters will override the current settings and may result in changes to the users associated with the smart group.","operationId":"update_smart_group_users_v1_smart_groups__smartGroupId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"parameters":[{"name":"smartGroupId","in":"path","required":true,"schema":{"title":"Smartgroupid","description":"The unique identifier of the smart group to update","type":"integer"},"description":"The unique identifier of the smart group to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/SmartGroupUpdateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_SmartGroupUpdateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users:v1:Smart Groups"],"summary":"Delete smart group","description":"Delete existing smart group by its unique identifier","operationId":"delete_smart_group_users_v1_smart_groups__smartGroupId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["users.delete"]}],"parameters":[{"name":"smartGroupId","in":"path","required":true,"schema":{"title":"Smartgroupid","description":"The unique identifier of the smart group to update","type":"integer"},"description":"The unique identifier of the smart group to update"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/smart-group-segments":{"get":{"tags":["Users:v1:Smart Group Segments"],"summary":"Get smart group segments","description":"Retrieves all smart group segments associated with the account. Optionally, filter the results by segment IDs and/or names.","operationId":"get_smart_group_segments_users_v1_smart_group_segments_get","security":[{"APIKeyHeader":[]},{"OAuth2":["users.read"]}],"parameters":[{"name":"segmentIds","in":"query","required":false,"schema":{"title":"Segmentids","description":"Smart group segment IDs to filter by","type":"array","items":{"type":"integer"}},"description":"Smart group segment IDs to filter by"},{"name":"names","in":"query","required":false,"schema":{"title":"Names","description":"Smart group segment names to filter by","type":"array","items":{"type":"string"}},"description":"Smart group segment names to filter by"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_SmartGroupSegmentsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Users:v1:Smart Group Segments"],"summary":"Create smart group segment","description":"Create a new segment for smart groups associated with the account. The segment can be assigned a name and a color.","operationId":"create_smart_group_segment_users_v1_smart_group_segments_post","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/SmartGroupSegmentCreateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_SmartGroupSegmentCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/admins":{"post":{"tags":["Users:v1:Admins"],"summary":"Promote to admin","description":"Promote an existing user to an admin. An invitation link will be sent to the specified email address of the user","operationId":"invite_admin_users_v1_admins_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InviteAdminsRequest"}],"title":"Invite Admin Request","description":"The data for the user who is to be promoted"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}]}},"/users/v1/users/{userId}/notes":{"post":{"tags":["Users:v1:Notes"],"summary":"Create user note","description":"Create new note on the profile of the specified user","operationId":"create_note_users_v1_users__userId__notes_post","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","description":"The unique identifier of user to create note for","type":"integer"},"description":"The unique identifier of user to create note for"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Note Create Request","allOf":[{"$ref":"#/components/schemas/NoteCreateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_NoteCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/users/{userId}/payslips":{"post":{"tags":["Users:v1:Payslips"],"summary":"Upload a payslip","description":"Upload a payslip for a user for a specified period. The payslip attachment must be uploaded first via the attachments endpoint.","operationId":"create_payslip_users_v1_users__userId__payslips_post","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","description":"The unique identifier of the user","type":"integer"},"description":"The unique identifier of the user"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/PayslipCreateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_PayslipCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/users/{userId}/performance/{date}":{"put":{"tags":["Users:v1:Performance"],"summary":"Update performance data","description":"Update or add performance data values for a specific user on a given date. If a value already exists for that date, it will be replaced with the new value. If no value exists, the new value will be added.","operationId":"update_performance_users_v1_users__userId__performance__date__put","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"parameters":[{"name":"date","in":"path","required":true,"schema":{"title":"Date","description":"The date to which the value(s) will be added, specified in ISO 8601 format (e.g., 2025-01-25)","type":"string","format":"date"},"description":"The date to which the value(s) will be added, specified in ISO 8601 format (e.g., 2025-01-25)"},{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","description":"The ID of the user whose data is being accessed or modified","minimum":1,"type":"integer"},"description":"The ID of the user whose data is being accessed or modified"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Performance Data","description":"Performance data values to update","allOf":[{"$ref":"#/components/schemas/PerformanceDataRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_PerformanceUpdateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/pending-users":{"get":{"tags":["Users:v1:Pending Request Users"],"summary":"List pending users","description":"List pending user join requests, optionally filtered by IDs and/or status.","operationId":"get_pending_users_users_v1_pending_users_get","security":[{"APIKeyHeader":[]},{"OAuth2":["users.read"]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"integer"}},{"type":"null"}],"description":"Filter by pending user IDs. Default: all.","title":"Ids"},"description":"Filter by pending user IDs. Default: all."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/UserJoinRequestStatus"},{"type":"null"}],"description":"Filter by status: 'pending', 'approved', or 'declined'. Default: all statuses.","title":"Status"},"description":"Filter by status: 'pending', 'approved', or 'declined'. Default: all statuses."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_GetPendingUsersResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Users:v1:Pending Request Users"],"summary":"Create pending users","description":"Create request to new users that will appear to admin in pending approval.","operationId":"create_pending_users_users_v1_pending_users_post","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Pending Users","description":"List of users to create.","allOf":[{"$ref":"#/components/schemas/PendingUsersRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_PendingUsersResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users:v1:Pending Request Users"],"summary":"Bulk delete pending users","description":"Delete multiple pending user requests by their IDs.","operationId":"bulk_delete_pending_users_users_v1_pending_users_delete","security":[{"APIKeyHeader":[]},{"OAuth2":["users.delete"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","description":"List of pending user IDs to delete.","allOf":[{"$ref":"#/components/schemas/DeletePendingUsersRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/pending-users/":{"put":{"tags":["Users:v1:Pending Request Users"],"summary":"Update invite links data","description":"Approve or reject pending user requests by ID.","operationId":"update_pending_users_status_users_v1_pending_users__put","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UpdatePendingUsersStatusRequest"}],"title":"Request","description":"Status update request."}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}]}},"/users/v1/pending-users/{pendingUserId}":{"put":{"tags":["Users:v1:Pending Request Users"],"summary":"Update pending user","description":"Update an existing pending user request.","operationId":"update_pending_user_users_v1_pending_users__pendingUserId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["users.write"]}],"parameters":[{"name":"pendingUserId","in":"path","required":true,"schema":{"title":"Pendinguserid","description":"The ID of the pending user request to update.","type":"integer"},"description":"The ID of the pending user request to update."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Pending User","description":"User data to update.","allOf":[{"$ref":"#/components/schemas/UpdatePendingUserRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_UpdatePendingUserResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users:v1:Pending Request Users"],"summary":"Delete pending user","description":"Hard delete pending user request based on user id.","operationId":"delete_pending_user_users_v1_pending_users__pendingUserId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["users.delete"]}],"parameters":[{"name":"pendingUserId","in":"path","required":true,"schema":{"title":"Pendinguserid","description":"The unique identifier of the pending user","type":"integer"},"description":"The unique identifier of the pending user"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/users/{userId}/assignments":{"get":{"tags":["Users:v1:Assignments"],"summary":"Get user assignments","description":"Retrieve a list of assigned assets of a specified user within the account. The available asset types are defined in the corresponding assetTypes enumeration param.","operationId":"get_user_assignments_users_v1_users__userId__assignments_get","security":[{"APIKeyHeader":[]},{"OAuth2":["users.read"]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","description":"The unique identifier of the user","type":"integer"},"description":"The unique identifier of the user"},{"name":"assetTypes","in":"query","required":true,"schema":{"description":"Specify the asset types for which you wish to retrieve details. Multiple asset types can be selected.","type":"array","items":{"$ref":"#/components/schemas/LpidWithCoursesDisplayName"}},"description":"Specify the asset types for which you wish to retrieve details. Multiple asset types can be selected."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_AssignmentsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/v1/performance-indicators":{"get":{"tags":["Users:v1:Performance Indicators"],"summary":"Get indicators","description":"Retrieve the metric indicators of the performance data associated with account.","operationId":"get_indicators_users_v1_performance_indicators_get","security":[{"APIKeyHeader":[]},{"OAuth2":["users.read"]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":100,"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_GetIndicatorsBaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/company-policies/v1/pay-rule-policies":{"get":{"tags":["Company Policies:v1:PayRulePolicies"],"summary":"Get company pay rule policies","description":"Retrieve a list of policies associated with the account. Currently supports pay rule policies.","operationId":"get_pay_rule_policies_company_policies_v1_pay_rule_policies_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_PayRulePoliciesResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["company_policies.read"]}]}},"/company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments":{"put":{"tags":["Company Policies:v1:PayRuleAssignment"],"summary":"Assign user to pay rule policy","description":"Assign user to specified pay rule policy. If the provided effective date is earlier than the currently assigned policy's effective date, the existing policy assignment will be replaced and removed.","operationId":"assign_user_to_policy_company_policies_v1_pay_rule_policies__payRulePolicyId__assignments_put","security":[{"APIKeyHeader":[]},{"OAuth2":["company_policies.write"]}],"parameters":[{"name":"payRulePolicyId","in":"path","required":true,"schema":{"title":"Payrulepolicyid","description":"The unique identifier of the pay rule policy to assign","type":"integer"},"description":"The unique identifier of the pay rule policy to assign"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/PayRuleAssignmentRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_PayRuleAssignmentResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-off/v1/policy-types":{"get":{"tags":["Time Off:v1:PolicyTypes"],"summary":"Get policy types","description":"Retrieve a list of policy types associated with the account","operationId":"get_policy_groups_time_off_v1_policy_types_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TimeOffGetPolicyTypesResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["time_off.read"]}]}},"/time-off/v1/policy-types/{policyTypeId}/balances":{"get":{"tags":["Time Off:v1:Balances"],"summary":"Get user balances","description":"Retrieve a list of user time-off balances within a policy type","operationId":"get_balances_time_off_v1_policy_types__policyTypeId__balances_get","security":[{"APIKeyHeader":[]},{"OAuth2":["time_off.read"]}],"parameters":[{"name":"policyTypeId","in":"path","required":true,"schema":{"title":"Policytypeid","description":"Policy type id","type":"string"},"description":"Policy type id"},{"name":"userIds","in":"query","required":false,"schema":{"title":"Userids","description":"List of user ids","type":"array","items":{"type":"integer","minimum":1}},"description":"List of user ids"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":100,"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_TimeOffGetUserBalancesResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-off/v1/policy-types/{policyTypeId}/balances/{userId}":{"put":{"tags":["Time Off:v1:Balances"],"summary":"Update user balance","description":"Update user time-off balance within a policy type","operationId":"put_user_balance_time_off_v1_policy_types__policyTypeId__balances__userId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["time_off.write"]}],"parameters":[{"name":"policyTypeId","in":"path","required":true,"schema":{"title":"Policytypeid","description":"Policy type id","type":"string"},"description":"Policy type id"},{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","description":"The ID of the user to update balance","minimum":1,"type":"integer"},"description":"The ID of the user to update balance"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","description":"The balance to update to","allOf":[{"$ref":"#/components/schemas/TimeOffUpdateUserBalanceRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TimeOffPutUserBalanceResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-off/v1/requests":{"get":{"tags":["Time Off:v1:TimeOffRequests"],"summary":"Get time off requests","description":"Retrieve a paginated list of time-off requests whose date range overlaps the requested window, with optional filtering by employees and statuses. Approved requests include duration (the amount deducted from balance, in the policy units of hours or days); it is omitted for other statuses. Defaults to approved status when no status filter is provided.","operationId":"list_time_off_requests_time_off_v1_requests_get","security":[{"APIKeyHeader":[]},{"OAuth2":["time_off.read"]}],"parameters":[{"name":"startDate","in":"query","required":true,"schema":{"title":"Startdate","description":"Start of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Any request overlapping [startDate, endDate] is returned.","type":"string"},"description":"Start of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Any request overlapping [startDate, endDate] is returned."},{"name":"endDate","in":"query","required":true,"schema":{"title":"Enddate","description":"End of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Must be on or after startDate. Range may not exceed 365 days.","type":"string"},"description":"End of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Must be on or after startDate. Range may not exceed 365 days."},{"name":"userIds","in":"query","required":false,"schema":{"title":"Userids","description":"Filter by one or more employee IDs. Omit to include all employees.","type":"array","items":{"type":"integer","minimum":1}},"description":"Filter by one or more employee IDs. Omit to include all employees."},{"name":"statuses","in":"query","required":false,"schema":{"title":"Statuses","description":"Filter by status. Allowed: approved, pending, denied. Repeat the param for multiple values. Defaults to ['approved'] when omitted.","type":"array","items":{"enum":["approved","pending","denied"],"type":"string"}},"description":"Filter by status. Allowed: approved, pending, denied. Repeat the param for multiple values. Defaults to ['approved'] when omitted."},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":100,"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_TimeOffRequestsListResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Time Off:v1:TimeOffRequests"],"summary":"Create time off request","description":"Create a new time-off request for a user under a specified policy. The time-off request can be either in pending or approved status.","operationId":"post_time_off_request_time_off_v1_requests_post","security":[{"APIKeyHeader":[]},{"OAuth2":["time_off.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Time Off Request Create Request","description":"Request model for the new Time Off Request","allOf":[{"$ref":"#/components/schemas/TimeOffRequestCreateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TimeOffRequestCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-off/v1/requests/{requestId}":{"put":{"tags":["Time Off:v1:TimeOffRequests"],"summary":"Update time off request","description":"Update an existing time-off request. The time-off request can be modified with new dates, times, status, or notes.","operationId":"put_time_off_request_time_off_v1_requests__requestId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["time_off.write"]}],"parameters":[{"name":"requestId","in":"path","required":true,"schema":{"title":"Requestid","description":"The unique identifier of the time off request","type":"string"},"description":"The unique identifier of the time off request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Time Off Request Update Request","description":"Request model for updating the Time Off Request","allOf":[{"$ref":"#/components/schemas/TimeOffRequestUpdateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TimeOffRequestUpdateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-off/v1/time-off-policies/{timeOffPolicyId}/assignments":{"put":{"tags":["Time Off:v1:PolicyAssignment"],"summary":"Assign user to time-off policy","description":"Assign user to specified time-off policy.","operationId":"assign_user_to_policy_time_off_v1_time_off_policies__timeOffPolicyId__assignments_put","security":[{"APIKeyHeader":[]},{"OAuth2":["time_off.write"]}],"parameters":[{"name":"timeOffPolicyId","in":"path","required":true,"schema":{"title":"Timeoffpolicyid","description":"The time off policy id","type":"string"},"description":"The time off policy id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","description":"The assignment request","allOf":[{"$ref":"#/components/schemas/TimeOffAssignPolicyRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TimeOffAssignPolicyResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks":{"get":{"tags":["Time Clock:v1:TimeClocks"],"summary":"Get time clocks","description":"Retrieve a list of time clocks associated with the account","operationId":"get_time_clocks_time_clock_v1_time_clocks_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TimeClocksResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.read"]}]}},"/time-clock/v1/time-clocks/{timeClockId}/time-activities":{"get":{"tags":["Time Clock:v1:TimeClocks:TimeClock:TimeActivities"],"summary":"Get time activities","description":"Retrieve a list of time activities in under a specified time clock.\nTime activities include shift and/or manual breaks","operationId":"get_time_activities_time_clock_v1_time_clocks__timeClockId__time_activities_get","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.read"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"},{"name":"startDate","in":"query","required":true,"schema":{"title":"Startdate","description":"The start time to filter by in ISO 8601 format (YYYY-MM-DD)","type":"string"},"description":"The start time to filter by in ISO 8601 format (YYYY-MM-DD)"},{"name":"endDate","in":"query","required":true,"schema":{"title":"Enddate","description":"The end time to filter by in ISO 8601 format (YYYY-MM-DD)","type":"string"},"description":"The end time to filter by in ISO 8601 format (YYYY-MM-DD)"},{"name":"userIds","in":"query","required":false,"schema":{"title":"Userids","description":"Filter time activities by a list of user IDs. Users who are no longer assigned to the specified time clock cannot be retrieved with this filter.","type":"array","items":{"type":"integer","minimum":1}},"description":"Filter time activities by a list of user IDs. Users who are no longer assigned to the specified time clock cannot be retrieved with this filter."},{"name":"jobIds","in":"query","required":false,"schema":{"title":"Jobids","description":"The job IDs of shifts","type":"array","items":{"type":"string"}},"description":"The job IDs of shifts"},{"name":"manualBreakIds","in":"query","required":false,"schema":{"title":"Manualbreakids","description":"The manual break IDs of manual breaks","type":"array","items":{"type":"string"}},"description":"The manual break IDs of manual breaks"},{"name":"policyTypeIds","in":"query","required":false,"schema":{"title":"Policytypeids","description":"The policy type IDs of time offs","type":"array","items":{"type":"string"}},"description":"The policy type IDs of time offs"},{"name":"activityTypes","in":"query","required":false,"schema":{"description":"The time activity types: shift, manual_break or time_off","type":"array","items":{"$ref":"#/components/schemas/TimeActivityType"}},"description":"The time activity types: shift, manual_break or time_off"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TimeActivitiesGetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Time Clock:v1:TimeClocks:TimeClock:TimeActivities"],"summary":"Create time activities","description":"Create multiple time activities in a time clock","operationId":"create_time_activities_time_clock_v1_time_clocks__timeClockId__time_activities_post","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.write"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Time Activities Request","description":"Request model for the new Time Activities","allOf":[{"$ref":"#/components/schemas/TimeActivitiesCreateRequestList"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TimeActivitiesCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Time Clock:v1:TimeClocks:TimeClock:TimeActivities"],"summary":"Update time activities","description":"Update time activities for users assigned to a specific time clock. Time activities can include adjustments to shifts and/or manual breaks.","operationId":"update_time_activities_time_clock_v1_time_clocks__timeClockId__time_activities_put","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.write"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Timeactivities","allOf":[{"$ref":"#/components/schemas/TimeActivitiesUpdateRequestList"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TimeActivitiesUpdateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/time-activities/{timeActivityId}":{"delete":{"tags":["Time Clock:v1:TimeClocks:TimeClock:TimeActivities"],"summary":"Delete time activity","description":"Deletes a single time activity (a punch shift or a manual break) from a specified time clock. The activity is identified by its unique ID - the same id returned by GET .../time-activities (and used in PUT). The server resolves which user the activity belongs to; the caller supplies only the time clock and the activity ID. The activity cannot be deleted if it falls on a locked or approved timesheet day; the request fails with HAS_LOCKED_DAYS. Time-off / absence entries are not addressable here and resolve to TIME_ACTIVITY_NOT_FOUND.","operationId":"delete_time_activity_time_clock_v1_time_clocks__timeClockId__time_activities__timeActivityId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.delete"]}],"parameters":[{"name":"timeActivityId","in":"path","required":true,"schema":{"title":"Timeactivityid","description":"The unique identifier of the time activity to delete","type":"string"},"description":"The unique identifier of the time activity to delete"},{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"400":{"description":"The request could not be processed.","content":{"application/json":{"examples":{"time_clock_not_found":{"summary":"Time clock not found","value":{"error":"time clock id doesn't exist","path":"/time-clock/v1/time-clocks/{timeClockId}/time-activities/{timeActivityId}","request_id":"550e8400-e29b-41d4-a716-446655440000"}},"invalid_id":{"summary":"Invalid time activity id format","value":{"error":"INVALID_ID: 'abc' is not a valid time activity identifier","path":"/time-clock/v1/time-clocks/{timeClockId}/time-activities/{timeActivityId}","request_id":"550e8400-e29b-41d4-a716-446655440000"}},"has_locked_days":{"summary":"Activity on a locked or approved day","value":{"error":"HAS_LOCKED_DAYS: time activity for user 12345 falls on locked or approved days ['2024-01-23']. Unlock or reject the approval before retrying","path":"/time-clock/v1/time-clocks/{timeClockId}/time-activities/{timeActivityId}","request_id":"550e8400-e29b-41d4-a716-446655440000"}}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"404":{"description":"No active time activity matches the given id under this time clock.","content":{"application/json":{"example":{"error":"TIME_ACTIVITY_NOT_FOUND: no active shift or manual break matches '666edfbac1ed5f748fabd3d2' under this time clock","path":"/time-clock/v1/time-clocks/{timeClockId}/time-activities/{timeActivityId}","request_id":"550e8400-e29b-41d4-a716-446655440000"},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/shift-attachments":{"get":{"tags":["Time Clock:v1:TimeClocks:TimeClock:ShiftAttachments"],"summary":"Get shift attachments","description":"Get shift attachments of a time clock","operationId":"get_shift_attachments_time_clock_v1_time_clocks__timeClockId__shift_attachments_get","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.read"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_ShiftAttachmentsGetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/manual-breaks":{"get":{"tags":["Time Clock:v1:TimeClocks:TimeClock:ManualBreaks"],"summary":"Get manual breaks","description":"Get multiple manual breaks of a time clock","operationId":"get_manual_breaks_time_clock_v1_time_clocks__timeClockId__manual_breaks_get","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.read"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_ManualBreaksGetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/manual-breaks/{manualBreakId}/clock-in":{"post":{"tags":["Time Clock:v1:TimeClocks:TimeClock:ManualBreaks:ManualBreakClockIn"],"summary":"Clock in to a manual break","description":"Start a manual break for an employee. If the employee is clocked into a shift on the same time clock, the shift is automatically closed and the break is started in one call (attributed to the shift's job). If the employee is idle, the break starts standalone. Pass an optional timestamp to record a break that started earlier (offline sync).","operationId":"clock_in_manual_break_time_clock_v1_time_clocks__timeClockId__manual_breaks__manualBreakId__clock_in_post","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.write"]}],"parameters":[{"name":"manualBreakId","in":"path","required":true,"schema":{"title":"Manualbreakid","description":"The unique identifier of the manual break to start","type":"string"},"description":"The unique identifier of the manual break to start"},{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/ManualBreakClockInRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_ManualBreakClockInResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/manual-breaks/clock-out":{"post":{"tags":["Time Clock:v1:TimeClocks:TimeClock:ManualBreaks:ManualBreakClockOut"],"summary":"Clock out from a manual break","description":"End the currently open manual break for an employee. By default, if the break was started from an open shift, the shift is re-opened on the same job (mobile 'Return to job'). Set isResumeShift=false to end the break without resuming. Mandatory breaks cannot be ended before their configured minimum duration. Pass an optional timestamp to record a break that ended earlier (offline sync).","operationId":"clock_out_manual_break_time_clock_v1_time_clocks__timeClockId__manual_breaks_clock_out_post","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.write"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/ManualBreakClockOutRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_ManualBreakClockOutResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/clock-in":{"post":{"tags":["Time Clock:v1:TimeClocks:TimeClock:ClockIn"],"summary":"Clock in","description":"Record the start time for the work period of an employee. The start time is automatically captured when the call is executed.","operationId":"clock_user_in_time_clock_v1_time_clocks__timeClockId__clock_in_post","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.write"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/ClockInRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_ClockInResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/clock-out":{"post":{"tags":["Time Clock:v1:TimeClocks:TimeClock:ClockOut"],"summary":"Clock out","description":"Record the end time for the work period of an employee. The end time is automatically captured when the call is executed. The clock-out will be associated with the current open shift.","operationId":"clock_user_out_time_clock_v1_time_clocks__timeClockId__clock_out_post","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.write"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/ClockOutRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_ClockOutResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/geofences":{"post":{"tags":["Time Clock:v1:TimeClocks:TimeClock:GeoFences"],"summary":"Create geofences","description":"Create new geofences site under a specified time clock. The geofence can be associated with multiple job IDs that are assigned to the time clock only","operationId":"create_geofences_time_clock_v1_time_clocks__timeClockId__geofences_post","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.write"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Geofences Body","description":"Request model for create geofences","allOf":[{"$ref":"#/components/schemas/GeoFencesCreateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_GeoFencesCreatedResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Time Clock:v1:TimeClocks:TimeClock:GeoFences"],"summary":"Get geofences","description":"Get all geofences for a specified time clock","operationId":"get_geofences_time_clock_v1_time_clocks__timeClockId__geofences_get","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.read"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_GeoFencesGetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/geofences/{fenceId}":{"get":{"tags":["Time Clock:v1:TimeClocks:TimeClock:GeoFences"],"summary":"Get geofence","description":"Get a geofence site under a specified time clock","operationId":"get_geofence_time_clock_v1_time_clocks__timeClockId__geofences__fenceId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.read"]}],"parameters":[{"name":"fenceId","in":"path","required":true,"schema":{"title":"Fenceid","description":"The ID of the geofence to get","type":"string"},"description":"The ID of the geofence to get"},{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_GeoFenceWithFenceIdEntity_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Time Clock:v1:TimeClocks:TimeClock:GeoFences"],"summary":"Delete geofence","description":"Delete a geofence site under a specified time clock","operationId":"delete_geo_fence_time_clock_v1_time_clocks__timeClockId__geofences__fenceId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.delete"]}],"parameters":[{"name":"fenceId","in":"path","required":true,"schema":{"title":"Fenceid","description":"The ID of the geofence to delete","type":"string"},"description":"The ID of the geofence to delete"},{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/timesheet":{"get":{"tags":["Time Clock:v1:TimeClocks:TimeClock:Get timesheet totals"],"summary":"Get timesheet totals","description":"Retrieves detailed work records for each employee within a specified date range. This endpoint is designed to support payroll processing by providing total worked hours, categorized by pay rules and resource (if applied in the account settings). Ideal for integrating with external payroll systems to ensure accurate information. The pay rate will be presented in case it is defined within the account. If an automated unpaid break is applied, it will  be deducted from the total hours value. In order to retrieve approved paid time-off (PTO) and manual break information, please use the Get time activities endpoint. Hours will be presented in decimal format. The time period is limited to 45 days.","operationId":"get_timesheet_total_hours_time_clock_v1_time_clocks__timeClockId__timesheet_get","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.read"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"},{"name":"startDate","in":"query","required":true,"schema":{"title":"Startdate","description":"The start of the reporting period, in ISO 8601 format (YYYY-MM-DD). The filter includes all records from 00:00:00 on the specified date.\n            Example: A startDate of 2025-01-01 includes data starting from 2025-01-01T00:00:00","type":"string"},"description":"The start of the reporting period, in ISO 8601 format (YYYY-MM-DD). The filter includes all records from 00:00:00 on the specified date.\n            Example: A startDate of 2025-01-01 includes data starting from 2025-01-01T00:00:00"},{"name":"endDate","in":"query","required":true,"schema":{"title":"Enddate","description":"The end of the reporting period, in ISO 8601 format (YYYY-MM-DD). The filter includes all records up to 23:59:59 on the specified date.\n            Example: An endDate of 2025-01-01 includes data up to 2025-01-01T23:59:59. The end date must be no more than 45 days after the start date. If there is an ongoing overnight shift that continues past the end date, the hours of the overnight  will only be included if it has been configured in the time clock settings.","type":"string"},"description":"The end of the reporting period, in ISO 8601 format (YYYY-MM-DD). The filter includes all records up to 23:59:59 on the specified date.\n            Example: An endDate of 2025-01-01 includes data up to 2025-01-01T23:59:59. The end date must be no more than 45 days after the start date. If there is an ongoing overnight shift that continues past the end date, the hours of the overnight  will only be included if it has been configured in the time clock settings."},{"name":"userIds","in":"query","required":false,"schema":{"title":"Userids","description":"List of user IDs to filter the results. Only time entries associated with these users will be included. If a user has no recorded time entries within the specified date range, they will be excluded from the results.","type":"array","items":{"type":"integer","minimum":1}},"description":"List of user IDs to filter the results. Only time entries associated with these users will be included. If a user has no recorded time entries within the specified date range, they will be excluded from the results."},{"name":"groupIds","in":"query","required":false,"schema":{"title":"Groupids","description":"List of cohort/group IDs to filter the results. Only time entries associated with users in these cohorts will be included.","type":"array","items":{"type":"string"}},"description":"List of cohort/group IDs to filter the results. Only time entries associated with users in these cohorts will be included."},{"name":"jobIds","in":"query","required":false,"schema":{"title":"Jobids","description":"List of job IDs to filter the results. Currently supports only parent job IDs and regular job IDs. If a parent job ID is provided, only sub-jobs that have actual recorded hours will be included in the response.","type":"array","items":{"type":"string"}},"description":"List of job IDs to filter the results. Currently supports only parent job IDs and regular job IDs. If a parent job ID is provided, only sub-jobs that have actual recorded hours will be included in the response."},{"name":"isApproved","in":"query","required":false,"schema":{"title":"Isapproved","description":"Filter by approval status. If not provided, returns all records (approved and unapproved). Set to true for approved only, false for unapproved only.","type":"boolean"},"description":"Filter by approval status. If not provided, returns all records (approved and unapproved). Set to true for approved only, false for unapproved only."},{"name":"isSubmitted","in":"query","required":false,"schema":{"title":"Issubmitted","description":"Filter by submission status. If not provided, returns all records (submitted and unsubmitted). Set to true for submitted only, false for unsubmitted only.","type":"boolean"},"description":"Filter by submission status. If not provided, returns all records (submitted and unsubmitted). Set to true for submitted only, false for unsubmitted only."},{"name":"isLocked","in":"query","required":false,"schema":{"title":"Islocked","description":"Filter by lock status. If not provided, returns all records (locked and unlocked). Set to true for locked only, false for unlocked only.","type":"boolean"},"description":"Filter by lock status. If not provided, returns all records (locked and unlocked). Set to true for locked only, false for unlocked only."},{"name":"includePlanVsActual","in":"query","required":false,"schema":{"title":"Includeplanvsactual","description":"When false (default), Plan vs Actual fields are omitted from the response and scheduled shifts are not fetched. When true, each daily record includes a dailyScheduledDetails object with dailyScheduledHours, dailyScheduledDifferenceHours, dailyScheduledShifts, and shifts (planned shift ids) comparing planned schedule hours to actual worked hours. Does not require Plan vs Actual to be enabled in time clock settings.","default":false,"type":"boolean"},"description":"When false (default), Plan vs Actual fields are omitted from the response and scheduled shifts are not fetched. When true, each daily record includes a dailyScheduledDetails object with dailyScheduledHours, dailyScheduledDifferenceHours, dailyScheduledShifts, and shifts (planned shift ids) comparing planned schedule hours to actual worked hours. Does not require Plan vs Actual to be enabled in time clock settings."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TimesheetTotalHoursGetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/v1/time-clocks/{timeClockId}/users/{userId}/lock-days":{"put":{"tags":["Time Clock:v1:TimeClocks:TimeClock:LockDays"],"summary":"Update user lock days","description":"Locks or unlocks one or more calendar days for a specific user on a given Time Clock. The isLocked boolean on the request body selects the operation: true (the default) prevents subsequent time-activity edits on those dates; false removes the per-day lock and allows edits again. Idempotent: dates already in the requested state are no-ops, and the response reflects the final state. This endpoint does not reopen approved payroll periods. If isLocked is false and any of the requested dates would actually transition from locked to unlocked but fall inside an approved period for this user, the entire request is rejected with DAYS_IN_APPROVED_PERIOD (409); no dates are unlocked. Approved periods must be reopened from the dashboard before calling this endpoint with isLocked: false. isLocked: true on an approved-period day is allowed and is a no-op for day-lock state.","operationId":"update_user_lock_days_time_clock_v1_time_clocks__timeClockId__users__userId__lock_days_put","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.write"]}],"parameters":[{"name":"timeClockId","in":"path","required":true,"schema":{"title":"Timeclockid","description":"The unique identifier of the time clock","type":"integer"},"description":"The unique identifier of the time clock"},{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","description":"The ID of the user whose data is being accessed or modified","minimum":1,"type":"integer"},"description":"The ID of the user whose data is being accessed or modified"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","description":"Lock-state change to apply for this user.","allOf":[{"$ref":"#/components/schemas/LockDaysPutRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_LockDaysPutResponse_"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"examples":{"duplicate_dates":{"summary":"Duplicate dates","value":{"details":{"error_message":"Request body is invalid","error_code":1002},"error":{"__root__":{"message":"dates must be unique","type":"value_error"}},"path":"/time-clock/v1/time-clocks/{timeClockId}/users/{userId}/lock-days","request_id":"550e8400-e29b-41d4-a716-446655440000"}},"too_many_dates":{"summary":"More than 50 dates","value":{"details":{"error_message":"Request body is invalid","error_code":1002},"error":{"body.dates":{"message":"ensure this value has at most 50 items","type":"value_error.list.max_items"}},"path":"/time-clock/v1/time-clocks/{timeClockId}/users/{userId}/lock-days","request_id":"550e8400-e29b-41d4-a716-446655440000"}},"empty_dates":{"summary":"Empty dates","value":{"details":{"error_message":"Request body is invalid","error_code":1002},"error":{"body.dates":{"message":"ensure this value has at least 1 items","type":"value_error.list.min_items"}},"path":"/time-clock/v1/time-clocks/{timeClockId}/users/{userId}/lock-days","request_id":"550e8400-e29b-41d4-a716-446655440000"}},"invalid_date_format":{"summary":"Invalid date format","value":{"details":{"error_message":"Request body is invalid","error_code":1002},"error":{"body.dates.0":{"message":"Date must be a valid date and in the format yyyy-MM-dd (iso format) got 2026/04/10","type":"value_error"}},"path":"/time-clock/v1/time-clocks/{timeClockId}/users/{userId}/lock-days","request_id":"550e8400-e29b-41d4-a716-446655440000"}}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"403":{"description":"Lock days are disabled for this Time Clock. Enable Timesheet Approval (Lock Days) before calling this endpoint.","content":{"application/json":{"example":{"error":"LOCK_DAYS_DISABLED: lock days settings are disabled for time clock 12345. Enable Timesheet Approval (Lock Days) in the Time Clock settings before calling this endpoint.","path":"/time-clock/v1/time-clocks/{timeClockId}/users/{userId}/lock-days","request_id":"550e8400-e29b-41d4-a716-446655440000"},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"404":{"description":"The userId in the path does not exist in the company.","content":{"application/json":{"example":{"error":"User with ID 12345 not found","path":"/time-clock/v1/time-clocks/{timeClockId}/users/{userId}/lock-days","request_id":"550e8400-e29b-41d4-a716-446655440000"},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"409":{"description":"Only when isLocked is false. One or more dates that would actually transition from locked to unlocked are part of an approved payroll period for this user. The entire request is rejected; no dates are unlocked. Reopen the approved period from the dashboard and retry.","content":{"application/json":{"example":{"error":"DAYS_IN_APPROVED_PERIOD: cannot unlock days in an approved payroll period for user 12345 on time clock 67890: ['2026-04-10', '2026-04-11']. Reopen the approved period from the dashboard and retry.","path":"/time-clock/v1/time-clocks/{timeClockId}/users/{userId}/lock-days","request_id":"550e8400-e29b-41d4-a716-446655440000"},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/breadcrumbs/v1/report":{"post":{"tags":["Breadcrumbs:Breadcrumbs"],"summary":"Generate breadcrumbs report","description":"Initiate a breadcrumbs report for a specific date. Returns a request ID that can be used to check the report status.","operationId":"generate_breadcrumbs_report_time_clock_breadcrumbs_v1_report_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BreadcrumbsReportRequest"}],"title":"Request Body","description":"Report request with date"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BreadcrumbsReportResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.read"]}]}},"/time-clock/breadcrumbs/v1/report/{fileId}":{"get":{"tags":["Breadcrumbs:Breadcrumbs"],"summary":"Get breadcrumbs report status","description":"Get the status of a breadcrumbs report task. Returns 'completed' when the file is ready in S3.","operationId":"get_report_status_time_clock_breadcrumbs_v1_report__fileId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.read"]}],"parameters":[{"name":"fileId","in":"path","required":true,"schema":{"title":"Fileid","description":"The request ID from the report endpoint","type":"string"},"description":"The request ID from the report endpoint"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BreadcrumbsReportStatusResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/time-clock/breadcrumbs/v1/report/{fileId}/download":{"get":{"tags":["Breadcrumbs:Breadcrumbs"],"summary":"Download breadcrumbs report","description":"Stream the breadcrumbs JSON report directly from S3. Only available when the task status is 'completed'.","operationId":"download_breadcrumbs_report_time_clock_breadcrumbs_v1_report__fileId__download_get","security":[{"APIKeyHeader":[]},{"OAuth2":["time_clock.read"]}],"parameters":[{"name":"fileId","in":"path","required":true,"schema":{"title":"Fileid","description":"The request ID from the report endpoint","type":"string"},"description":"The request ID from the report endpoint"}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/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"}}}}}},"put":{"tags":["Pay Rates:v1:Pay Rates:v1:PayRates"],"summary":"Set pay rates","description":"Creates or updates pay rates for one or more users. If a pay rate exists for the same effective date, it is replaced; otherwise, a new entry is added to the pay rate history. The effective date cannot be on or after any approved or locked timesheet days. If such days exist, the request fails with HAS_LOCKED_DAYS. For bulk requests with resource rates enabled, the system validates user eligibility and tracks all changes. When isResourceRateEnabled is true, resourcesRates must include all resources with custom rates.","operationId":"set_pay_rates_pay_rates_v1_pay_rates_put","security":[{"APIKeyHeader":[]},{"OAuth2":["pay_rates.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Pay Rates Request","description":"The pay rates to set","allOf":[{"$ref":"#/components/schemas/PayRatesPutRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_PayRatePutResponse_"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"examples":{"invalid_rate_value":{"summary":"Rate must be >= 0","value":{"details":{"error_message":"Request body is invalid","error_code":1002},"error":{"body.payRatesByUsers.0.payRate.defaultRate":{"message":"ensure this value is greater than or equal to 0","type":"value_error.number.not_ge"}},"path":"/pay-rates/v1/pay-rates","request_id":"550e8400-e29b-41d4-a716-446655440000"}},"missing_default_rate":{"summary":"defaultRate required when enabled","value":{"details":{"error_message":"Request body is invalid","error_code":1002},"error":{"__root__":{"message":"defaultRate is required when isDefaultRateEnabled is true","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 body is invalid","error_code":1002},"error":{"body.payRatesByUsers.0.payRate.effectiveDate":{"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"}},"user_not_found":{"summary":"User ID(s) don't exist","value":{"details":{"error_message":"Request is invalid","error_code":1004},"error":"Users: [12345, 67890] not exists","path":"/pay-rates/v1/pay-rates","request_id":"550e8400-e29b-41d4-a716-446655440000"}}},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"409":{"description":"The effective date conflicts with approved or locked timesheet days. Cannot create, update, or delete pay rates that would affect finalized timesheets","content":{"application/json":{"example":{"details":{"error_message":"Cannot modify pay rate","error_code":"HAS_LOCKED_DAYS"},"error":"Cannot modify pay rate that affects locked or approved timesheet days","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"}}}}}}},"/pay-rates/v1/pay-rates/users/{userId}/{effectiveDate}":{"delete":{"tags":["Pay Rates:v1:Pay Rates:v1:PayRates"],"summary":"Delete pay rate","description":"Deletes a specific pay rate entry for a user. The pay rate is identified by the user ID and effective date. This operation cannot be undone. The system validates that the effective date does not affect any approved or locked timesheet days. If the user has any approved or locked days on or after this effective date, the delete request will fail with error code HAS_LOCKED_DAYS. You cannot delete pay rates that are currently being used for finalized payroll calculations. Additionally, at least one pay rate must remain for each user (if required by company policy).","operationId":"delete_pay_rate_pay_rates_v1_pay_rates_users__userId___effectiveDate__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["pay_rates.delete"]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","description":"The ID of the user","title":"Userid"},"description":"The ID of the user"},{"name":"effectiveDate","in":"path","required":true,"schema":{"type":"string","description":"The effective date of the pay rate (format: YYYY-MM-DD)","title":"Effectivedate"},"description":"The effective date of the pay rate (format: YYYY-MM-DD)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_PayRateDeleteResponse_"}}}},"404":{"description":"Pay rate not found for given user ID and effective date","content":{"application/json":{"example":{"error":"Pay rate not found for user 12345 on effective date 2024-01-01","path":"/pay-rates/v1/pay-rates/users/12345/2024-01-01","request_id":"550e8400-e29b-41d4-a716-446655440000"},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"409":{"description":"The effective date conflicts with approved or locked timesheet days. Cannot create, update, or delete pay rates that would affect finalized timesheets","content":{"application/json":{"example":{"details":{"error_message":"Cannot delete pay rate","error_code":"HAS_LOCKED_DAYS"},"error":"Cannot delete pay rate that affects locked or approved timesheet days","path":"/pay-rates/v1/pay-rates/users/12345/2024-01-01","request_id":"550e8400-e29b-41d4-a716-446655440000"},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}":{"delete":{"tags":["Tasks:v1:Tasks:TasksBoards"],"summary":"Delete task","description":"Delete quick task under a specified task board","operationId":"delete_task_tasks_v1_taskboards__taskBoardId__tasks__taskId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["quick_tasks.delete"]}],"parameters":[{"name":"taskId","in":"path","required":true,"schema":{"title":"Taskid","description":"The unique identifier of the task","type":"string"},"description":"The unique identifier of the task"},{"name":"taskBoardId","in":"path","required":true,"schema":{"title":"Taskboardid","description":"The unique identifier of the taskBoard","type":"string"},"description":"The unique identifier of the taskBoard"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_DeleteTaskResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Tasks:v1:Tasks:TasksBoards"],"summary":"Update task","description":"Update a quick task under a specified task board. Any new attachments will replace the existing ones.","operationId":"update_task_tasks_v1_taskboards__taskBoardId__tasks__taskId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["quick_tasks.write"]}],"parameters":[{"name":"taskId","in":"path","required":true,"schema":{"title":"Taskid","description":"The unique identifier of the task.","type":"string"},"description":"The unique identifier of the task."},{"name":"taskBoardId","in":"path","required":true,"schema":{"title":"Taskboardid","description":"The unique identifier of the taskBoard","type":"string"},"description":"The unique identifier of the taskBoard"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Update Task Request","allOf":[{"$ref":"#/components/schemas/UpdateTaskRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_UpdateTaskResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tasks/v1/taskboards/{taskBoardId}/tasks":{"get":{"tags":["Tasks:v1:Tasks:TasksBoards"],"summary":"Get tasks","description":"Retrieves a list of tasks under a specified task board","operationId":"get_tasks_tasks_v1_taskboards__taskBoardId__tasks_get","security":[{"APIKeyHeader":[]},{"OAuth2":["quick_tasks.read"]}],"parameters":[{"name":"taskBoardId","in":"path","required":true,"schema":{"title":"Taskboardid","description":"The unique identifier of the taskBoard","type":"string"},"description":"The unique identifier of the taskBoard"},{"name":"taskIds","in":"query","required":false,"schema":{"title":"Taskids","description":"List of task IDs to filter by","type":"array","items":{"type":"string"}},"description":"List of task IDs to filter by"},{"name":"labelIds","in":"query","required":false,"schema":{"title":"Labelids","description":"List of label IDs to filter by. Tasks retrieved will include the specified label(s), but may also include additional labels.","type":"array","items":{"type":"string"}},"description":"List of label IDs to filter by. Tasks retrieved will include the specified label(s), but may also include additional labels."},{"name":"userIds","in":"query","required":false,"schema":{"title":"Userids","description":"List of assigned user IDs on the task to filter by. Group tasks will be also included in the results.","type":"array","items":{"type":"integer"}},"description":"List of assigned user IDs on the task to filter by. Group tasks will be also included in the results."},{"name":"status","in":"query","required":false,"schema":{"description":"draft/published/completed/all - all is by default","default":"all","allOf":[{"$ref":"#/components/schemas/TaskStatusFilter"}]},"description":"draft/published/completed/all - all is by default"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":100,"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_TasksResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Tasks:v1:Tasks:TasksBoards"],"summary":"Create task","description":"Create quick task for specified users by their ID, detailing information such as title, due date and description. Attachments for the quick task must first be uploaded via the attachments endpoint.","operationId":"create_task_tasks_v1_taskboards__taskBoardId__tasks_post","security":[{"APIKeyHeader":[]},{"OAuth2":["quick_tasks.write"]}],"parameters":[{"name":"taskBoardId","in":"path","required":true,"schema":{"title":"Taskboardid","description":"The unique identifier of the taskBoard","type":"string"},"description":"The unique identifier of the taskBoard"}],"requestBody":{"content":{"application/json":{"schema":{"title":"Create Task Request","allOf":[{"$ref":"#/components/schemas/CreateTaskRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_CreateTaskResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tasks/v1/taskboards":{"get":{"tags":["Tasks:v1:TaskBoards"],"summary":"Get task boards","description":"Retrieve a list of task boards associated with the account","operationId":"get_tasks_boards_tasks_v1_taskboards_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_GetTasksBoardsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["quick_tasks.read"]}]}},"/tasks/v1/taskboards/{taskBoardId}/labels":{"get":{"tags":["Tasks:v1:TaskLabels"],"summary":"Get task labels","description":"Retrieve a list of task labels associated with the account","operationId":"get_task_labels_tasks_v1_taskboards__taskBoardId__labels_get","security":[{"APIKeyHeader":[]},{"OAuth2":["quick_tasks.read"]}],"parameters":[{"name":"taskBoardId","in":"path","required":true,"schema":{"title":"Taskboardid","description":"The unique identifier of the task board to filter by","type":"string"},"description":"The unique identifier of the task board to filter by"},{"name":"title","in":"query","required":false,"schema":{"title":"Title","description":"The title (name) of the label to filter by","type":"string"},"description":"The title (name) of the label to filter by"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":100,"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_TaskLabelsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}/sub-tasks":{"get":{"tags":["Tasks:v1:SubTasks:Tasks:TaskBoards"],"summary":"Get sub-tasks","description":"Retrieve a list of sub-tasks under a specified parent task","operationId":"get_subtasks_tasks_v1_taskboards__taskBoardId__tasks__taskId__sub_tasks_get","security":[{"APIKeyHeader":[]},{"OAuth2":["quick_tasks.read"]}],"parameters":[{"name":"taskBoardId","in":"path","required":true,"schema":{"title":"Taskboardid","description":"The unique identifier of the task board","type":"string"},"description":"The unique identifier of the task board"},{"name":"taskId","in":"path","required":true,"schema":{"title":"Taskid","description":"The unique identifier of the parent task","type":"string"},"description":"The unique identifier of the parent task"},{"name":"subtaskIds","in":"query","required":false,"schema":{"title":"Subtaskids","description":"Optional list of subtask IDs to filter by","type":"array","items":{"type":"string"}},"description":"Optional list of subtask IDs to filter by"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":100,"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_SubTasksResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Tasks:v1:SubTasks:Tasks:TaskBoards"],"summary":"Create sub-task","description":"Create a single sub-task under a specified parent task","operationId":"create_subtask_tasks_v1_taskboards__taskBoardId__tasks__taskId__sub_tasks_post","security":[{"APIKeyHeader":[]},{"OAuth2":["quick_tasks.write"]}],"parameters":[{"name":"taskBoardId","in":"path","required":true,"schema":{"title":"Taskboardid","description":"The unique identifier of the task board","type":"string"},"description":"The unique identifier of the task board"},{"name":"taskId","in":"path","required":true,"schema":{"title":"Taskid","description":"The unique identifier of the parent task","type":"string"},"description":"The unique identifier of the parent task"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Create Request","allOf":[{"$ref":"#/components/schemas/SubTaskCreateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_SubTaskCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}/sub-tasks/{subTaskId}":{"put":{"tags":["Tasks:v1:SubTasks:Tasks:TaskBoards"],"summary":"Update sub-task","description":"Update a single sub-task under a specified parent task","operationId":"update_subtask_tasks_v1_taskboards__taskBoardId__tasks__taskId__sub_tasks__subTaskId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["quick_tasks.write"]}],"parameters":[{"name":"subTaskId","in":"path","required":true,"schema":{"title":"Subtaskid","description":"The unique identifier of the sub-task","type":"string"},"description":"The unique identifier of the sub-task"},{"name":"taskBoardId","in":"path","required":true,"schema":{"title":"Taskboardid","description":"The unique identifier of the task board","type":"string"},"description":"The unique identifier of the task board"},{"name":"taskId","in":"path","required":true,"schema":{"title":"Taskid","description":"The unique identifier of the parent task","type":"string"},"description":"The unique identifier of the parent task"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Update Request","allOf":[{"$ref":"#/components/schemas/SubTaskUpdateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_SubTaskUpdateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Tasks:v1:SubTasks:Tasks:TaskBoards"],"summary":"Delete sub-task","description":"Delete a single sub-task under a specified parent task","operationId":"delete_subtask_tasks_v1_taskboards__taskBoardId__tasks__taskId__sub_tasks__subTaskId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["quick_tasks.delete"]}],"parameters":[{"name":"subTaskId","in":"path","required":true,"schema":{"title":"Subtaskid","description":"The unique identifier of the sub-task","type":"string"},"description":"The unique identifier of the sub-task"},{"name":"taskBoardId","in":"path","required":true,"schema":{"title":"Taskboardid","description":"The unique identifier of the task board","type":"string"},"description":"The unique identifier of the task board"},{"name":"taskId","in":"path","required":true,"schema":{"title":"Taskid","description":"The unique identifier of the parent task","type":"string"},"description":"The unique identifier of the parent task"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_SubTaskDeleteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sales/v1/locations":{"get":{"tags":["Sales:Sales V1:Sales Locations"],"summary":"Get locations","description":"Retrieve a list of locations associated with the account","operationId":"get_locations_sales_v1_locations_get","security":[{"APIKeyHeader":[]},{"OAuth2":["sales_data.read"]}],"parameters":[{"name":"locationIds","in":"query","required":false,"schema":{"title":"Locationids","description":"List of location IDs to filter by","type":"array","items":{"type":"integer"}},"description":"List of location IDs to filter by"},{"name":"locationNames","in":"query","required":false,"schema":{"title":"Locationnames","description":"List of location names to filter by","type":"array","items":{"type":"string"}},"description":"List of location names to filter by"},{"name":"isActive","in":"query","required":false,"schema":{"title":"Isactive","description":"Filter by active status","type":"boolean"},"description":"Filter by active status"},{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":100,"minimum":1,"maximum":1000,"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/APIResponse_LocationsGetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Sales:Sales V1:Sales Locations"],"summary":"Create location","description":"Create a new location entity, which can be used to sync sales data with third-party systems. Location can represent a physical branch, store or facility.","operationId":"create_location_sales_v1_locations_post","security":[{"APIKeyHeader":[]},{"OAuth2":["sales_data.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/LocationRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_LocationResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sales/v1/locations/{locationId}/daily-sales":{"put":{"tags":["Sales:Sales V1:Sales Locations:Sales Daily"],"summary":"Set projected sales","description":"Set projected sales for a single location for one or more days in a single request. Each item in updates specifies a date and projectedSales value; each date may appear only once. This replaces the projected total for that day and does not modify totalSales. To record or change actual (totalSales) values, use the Create transactions endpoint. Location IDs are available from the Get locations endpoint.","operationId":"update_projected_sales_sales_v1_locations__locationId__daily_sales_put","security":[{"APIKeyHeader":[]},{"OAuth2":["sales_data.write"]}],"parameters":[{"name":"locationId","in":"path","required":true,"schema":{"title":"Locationid","description":"Unique identifier of the location (from the Get locations endpoint).","type":"integer"},"description":"Unique identifier of the location (from the Get locations endpoint)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/ProjectedSalesUpdateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_ProjectedSalesUpdateResponse_"}}}},"400":{"description":"Invalid parameters (e.g. location not found, duplicate dates in updates)."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sales/v1/transactions":{"post":{"tags":["Sales:Sales V1:Sales Transactions"],"summary":"Create transactions","description":"Create new sale transactions for specified locations.","operationId":"create_transactions_sales_v1_transactions_post","security":[{"APIKeyHeader":[]},{"OAuth2":["sales_data.write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/TransactionCreateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_TransactionCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Sales:Sales V1:Sales Transactions"],"summary":"Delete transactions","description":"Delete transactions within a specified time period. All transactions during this period will be permanently removed.","operationId":"delete_transactions_by_period_sales_v1_transactions_delete","security":[{"APIKeyHeader":[]},{"OAuth2":["sales_data.delete"]}],"parameters":[{"name":"locationId","in":"query","required":true,"schema":{"title":"Locationid","description":"The location ID derived from the locations API","type":"integer"},"description":"The location ID derived from the locations API"},{"name":"startTime","in":"query","required":true,"schema":{"title":"Starttime","description":"The start time of the specified period in UNIX timestamp","type":"integer"},"description":"The start time of the specified period in UNIX timestamp"},{"name":"endTime","in":"query","required":true,"schema":{"title":"Endtime","description":"The end time of the specified period in UNIX timestamp","type":"integer"},"description":"The end time of the specified period in UNIX timestamp"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sales/v1/transactions/{transactionId}":{"delete":{"tags":["Sales:Sales V1:Sales Transactions"],"summary":"Delete transaction","description":"Delete single transaction by its ID","operationId":"delete_transaction_sales_v1_transactions__transactionId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["sales_data.delete"]}],"parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"title":"Transactionid","description":"The unique identifier of the transaction","type":"string"},"description":"The unique identifier of the transaction"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/sales/v1/daily-sales":{"get":{"tags":["Sales:Sales V1:Sales Daily"],"summary":"Get daily sales","description":"Retrieve daily sales totals per location for a date range. Each entry includes totalSales (aggregated from transactions) and projectedSales (set via Set projected sales). Required query parameters: startDate and endDate (ISO 8601, YYYY-MM-DD). Optionally filter by locationIds; if omitted, all account locations are included. Only days with stored daily aggregation data are returned; days with no data are omitted (not returned as zero). To record or change actual sales, use the Create transactions endpoint.","operationId":"get_daily_sales_sales_v1_daily_sales_get","security":[{"APIKeyHeader":[]},{"OAuth2":["sales_data.read"]}],"parameters":[{"name":"startDate","in":"query","required":true,"schema":{"title":"Startdate","description":"Start of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Must be used with endDate.","type":"string"},"description":"Start of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Must be used with endDate."},{"name":"endDate","in":"query","required":true,"schema":{"title":"Enddate","description":"End of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Must be on or after startDate.","type":"string"},"description":"End of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Must be on or after startDate."},{"name":"locationIds","in":"query","required":false,"schema":{"title":"Locationids","description":"Filter by location IDs from the Get locations endpoint. Omit to include all account locations. If any ID is invalid, the request fails.","type":"array","items":{"type":"integer"}},"description":"Filter by location IDs from the Get locations endpoint. Omit to include all account locations. If any ID is invalid, the request fails."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_DailySalesGetResponse_"}}}},"400":{"description":"Invalid parameters (e.g. endDate before startDate, unknown locationIds)."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/daily-info/v1/daily-note/{noteId}":{"get":{"tags":["DailyNote:v1:DailyNote"],"summary":"Get note","description":"Get a single note by its unique identifier","operationId":"get_note_daily_info_v1_daily_note__noteId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["daily_note.read"]}],"parameters":[{"name":"noteId","in":"path","required":true,"schema":{"title":"Noteid","description":"The unique identifier of the note","type":"integer"},"description":"The unique identifier of the note"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_DailyNoteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["DailyNote:v1:DailyNote"],"summary":"Update note","description":"Update a single note by its unique identifier","operationId":"update_note_daily_info_v1_daily_note__noteId__put","security":[{"APIKeyHeader":[]},{"OAuth2":["daily_note.write"]}],"parameters":[{"name":"noteId","in":"path","required":true,"schema":{"title":"Noteid","description":"The unique identifier of the note","type":"integer"},"description":"The unique identifier of the note"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Note Request","allOf":[{"$ref":"#/components/schemas/DailyNoteUpdateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_DailyNoteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["DailyNote:v1:DailyNote"],"summary":"Delete note","description":"Delete a single note by its unique identifier","operationId":"delete_note_daily_info_v1_daily_note__noteId__delete","security":[{"APIKeyHeader":[]},{"OAuth2":["daily_note.delete"]}],"parameters":[{"name":"noteId","in":"path","required":true,"schema":{"title":"Noteid","description":"The unique identifier of the note","type":"integer"},"description":"The unique identifier of the note"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_DeleteDailyNoteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/daily-info/v1/daily-notes":{"post":{"tags":["DailyNote:v1:DailyNotes"],"summary":"Create daily note","description":"Create a note under a specified schedule for a specific date","operationId":"create_note_daily_info_v1_daily_notes_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DailyNoteCreateRequest"}],"title":"Note Request","description":"Request model for the new note"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_DailyNoteResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["daily_note.write"]}]}},"/chat/v1/conversations":{"post":{"tags":["Chat:v1:Conversations"],"summary":"Create conversation","description":"Creates a team chat or channel as the authenticated user. Members are assigned via userIds (individual users) and/or smartGroupIds (dynamic cohorts) - at least one assignment is required. Use type: \"team\" for a collaborative chat where members can send messages, or type: \"channel\" for a broadcast group where only admins post. A custom publisher can subsequently post into the created group via POST /chat/v1/conversations/{conversationId}/message.","operationId":"create_conversation_chat_v1_conversations_post","security":[{"APIKeyHeader":[]},{"OAuth2":["chat.write"]}],"requestBody":{"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/ConversationMutationRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_ConversationMutationResponse_"}}}},"404":{"description":"Conversation could not be resolved after creation","content":{"application/json":{"example":{"error":"Conversation b7e2c1a4-8f3d-4c9a-a1b2-3c4d5e6f7a8b not found","path":"/chat/v1/conversations","request_id":"550e8400-e29b-41d4-a716-446655440000"},"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Chat:v1:Conversations"],"summary":"Get conversations","description":"Retrieves a list of team chats and/or channels associated with the account. The list excludes private conversations.","operationId":"get_conversations_chat_v1_conversations_get","security":[{"APIKeyHeader":[]},{"OAuth2":["chat.read"]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":100,"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_ConversationsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/chat/v1/conversations/{conversationId}/message":{"post":{"tags":["Chat:v1:Conversations"],"summary":"Send message","description":"Sends a new message to a specific chat, whether it’s channel or a team chat","operationId":"send_message_to_conversation_chat_v1_conversations__conversationId__message_post","security":[{"APIKeyHeader":[]},{"OAuth2":["chat.write"]}],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"title":"Conversationid","description":"The unique identifier of the conversation","type":"string"},"description":"The unique identifier of the conversation"}],"requestBody":{"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/ConversationPostMessageRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/chat/v1/conversations/privateMessage/{userId}":{"post":{"tags":["Chat:v1:Conversations"],"summary":"Send private message","description":"Send a private message to a specified user within the account. The sender will be a custom publisher. If a conversation between the custom publisher and the addressed user already exists, it will send the message to the same conversation, if not, it will create a new conversation with the specified user.","operationId":"send_message_to_private_conversation_chat_v1_conversations_privateMessage__userId__post","security":[{"APIKeyHeader":[]},{"OAuth2":["chat.write"]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"title":"Userid","description":"The unique identifier of the user","type":"integer"},"description":"The unique identifier of the user"}],"requestBody":{"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/ConversationPostMessageRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_BaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/publishers/v1/publishers":{"get":{"tags":["Publishers:v1:Publishers"],"summary":"Get publishers","description":"Retrieves a list of custom publishers associated with the account.","operationId":"get_publishers_publishers_v1_publishers_get","security":[{"APIKeyHeader":[]},{"OAuth2":["publishers.read"]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"title":"Limit","description":"The maximum number of results to display per page","default":10,"minimum":1,"maximum":100,"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_PublishersResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/assets/v1/asset/{assetId}":{"get":{"tags":["Assets:v1:Asset"],"summary":"Get asset metadata","description":"Retrieve all metadata associated with a specified asset.","operationId":"get_metadata_per_asset_assets_v1_asset__assetId__get","security":[{"APIKeyHeader":[]},{"OAuth2":["assets.read"]}],"parameters":[{"name":"assetId","in":"path","required":true,"schema":{"title":"Assetid","description":"The unique identifier of the asset.","type":"integer"},"description":"The unique identifier of the asset."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_AssetResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/onboarding/v1/packs":{"get":{"tags":["Onboarding:v1:Onboarding:Packs"],"summary":"Get onboarding packs","description":"Retrieve all onboarding packs for the company","operationId":"get_packs_onboarding_v1_packs_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_PacksListResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]},{"OAuth2":["onboarding.read"]}]}},"/onboarding/v1/packs/{packId}/assignments":{"get":{"tags":["Onboarding:v1:Onboarding:Assignments"],"summary":"Get pack assignments","description":"Retrieve all user assignments for a specific onboarding pack","operationId":"get_pack_assignments_onboarding_v1_packs__packId__assignments_get","security":[{"APIKeyHeader":[]},{"OAuth2":["onboarding.read"]}],"parameters":[{"name":"packId","in":"path","required":true,"schema":{"title":"Packid","description":"The onboarding pack ID","type":"integer"},"description":"The onboarding pack ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_AssignmentsGetResponse_"}}}},"404":{"description":"Onboarding pack not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Onboarding:v1:Onboarding:Assignments"],"summary":"Assign users to pack","description":"Assign one or more users to a specific onboarding pack. All-or-nothing: if any user ID is invalid, no assignments are created.","operationId":"create_pack_assignments_onboarding_v1_packs__packId__assignments_post","security":[{"APIKeyHeader":[]},{"OAuth2":["onboarding.write"]}],"parameters":[{"name":"packId","in":"path","required":true,"schema":{"title":"Packid","description":"The onboarding pack ID","type":"integer"},"description":"The onboarding pack ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request","allOf":[{"$ref":"#/components/schemas/AssignmentsCreateRequest"}]}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIResponse_AssignmentsCreateResponse_"}}}},"404":{"description":"Onboarding pack not found"},"422":{"description":"Validation error"}}}},"/oauth/v1/token":{"post":{"tags":["OAuth"],"summary":"Issue Access Token","description":"Issue an OAuth access token using client credentials grant. Use HTTP Basic Authentication with your client_id and client_secret.","operationId":"oauth_token_docs_oauth_v1_token_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_oauth_token_docs_oauth_v1_token_post"}}}},"responses":{"200":{"description":"Successfully issued access token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenResponse"}}}},"400":{"description":"Invalid grant type"},"401":{"description":"Invalid client credentials"},"403":{"description":"Unauthorized scopes requested"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBasic":[]}]}}},"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":{"APIResponseV2_AutoAssignResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/AutoAssignResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[AutoAssignResponse]"},"APIResponseV2_AutoAssignStatusResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/AutoAssignStatusResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[AutoAssignStatusResponse]"},"APIResponseV2_DeleteJobResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/DeleteJobResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[DeleteJobResponse]"},"APIResponseV2_GetSchedulerShiftLayersResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetSchedulerShiftLayersResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[GetSchedulerShiftLayersResponse]"},"APIResponseV2_GetUnavailabilitiesResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetUnavailabilitiesResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[GetUnavailabilitiesResponse]"},"APIResponseV2_JobResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/JobResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[JobResponse]"},"APIResponseV2_JobsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/JobsResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[JobsResponse]"},"APIResponseV2_MeResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/MeResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[MeResponse]"},"APIResponseV2_PublicBaseWebhookResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/PublicBaseWebhookResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[PublicBaseWebhookResponse]"},"APIResponseV2_SchedulersResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/SchedulersResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[SchedulersResponse]"},"APIResponseV2_ShiftBulkDeleteResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ShiftBulkDeleteResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[ShiftBulkDeleteResponse]"},"APIResponseV2_ShiftBulkResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ShiftBulkResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[ShiftBulkResponse]"},"APIResponseV2_ShiftDeleteResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ShiftDeleteResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[ShiftDeleteResponse]"},"APIResponseV2_ShiftResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/v2__features__shiftscheduler__external_api__v1__schedulers__scheduler__shifts__models__shift_response__ShiftResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[ShiftResponse]"},"APIResponseV2_ShiftUpdateBulkResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ShiftUpdateBulkResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[ShiftUpdateBulkResponse]"},"APIResponseV2_UnavailabilityCreateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/UnavailabilityCreateResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[UnavailabilityCreateResponse]"},"APIResponseV2_UnavailabilityDeleteResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/UnavailabilityDeleteResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[UnavailabilityDeleteResponse]"},"APIResponseV2_WebhookDeleteResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/WebhookDeleteResponse"}},"type":"object","required":["data"],"title":"APIResponseV2[WebhookDeleteResponse]"},"APIResponse_AddDropdownOptionsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/AddDropdownOptionsResponse"}},"type":"object","required":["data"],"title":"APIResponse[AddDropdownOptionsResponse]"},"APIResponse_ArchiveUsersResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ArchiveUsersResponse"}},"type":"object","required":["data"],"title":"APIResponse[ArchiveUsersResponse]"},"APIResponse_AssetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/AssetResponse"}},"type":"object","required":["data"],"title":"APIResponse[AssetResponse]"},"APIResponse_AssignmentsCreateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/AssignmentsCreateResponse"}},"type":"object","required":["data"],"title":"APIResponse[AssignmentsCreateResponse]"},"APIResponse_AssignmentsGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/AssignmentsGetResponse"}},"type":"object","required":["data"],"title":"APIResponse[AssignmentsGetResponse]"},"APIResponse_AssignmentsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/AssignmentsResponse"}},"type":"object","required":["data"],"title":"APIResponse[AssignmentsResponse]"},"APIResponse_BaseResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/BaseResponse"}},"type":"object","required":["data"],"title":"APIResponse[BaseResponse]"},"APIResponse_BreadcrumbsReportResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/BreadcrumbsReportResponse"}},"type":"object","required":["data"],"title":"APIResponse[BreadcrumbsReportResponse]"},"APIResponse_BreadcrumbsReportStatusResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/BreadcrumbsReportStatusResponse"}},"type":"object","required":["data"],"title":"APIResponse[BreadcrumbsReportStatusResponse]"},"APIResponse_BulkDeleteCustomFieldResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/BulkDeleteCustomFieldResponse"}},"type":"object","required":["data"],"title":"APIResponse[BulkDeleteCustomFieldResponse]"},"APIResponse_ClockInResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ClockInResponse"}},"type":"object","required":["data"],"title":"APIResponse[ClockInResponse]"},"APIResponse_ClockOutResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ClockOutResponse"}},"type":"object","required":["data"],"title":"APIResponse[ClockOutResponse]"},"APIResponse_ConversationMutationResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ConversationMutationResponse"}},"type":"object","required":["data"],"title":"APIResponse[ConversationMutationResponse]"},"APIResponse_CreateTaskResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/CreateTaskResponse"}},"type":"object","required":["data"],"title":"APIResponse[CreateTaskResponse]"},"APIResponse_CreateUsersResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/CreateUsersResponse"}},"type":"object","required":["data"],"title":"APIResponse[CreateUsersResponse]"},"APIResponse_DailyNoteResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/DailyNoteResponse"}},"type":"object","required":["data"],"title":"APIResponse[DailyNoteResponse]"},"APIResponse_DailySalesGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/DailySalesGetResponse"}},"type":"object","required":["data"],"title":"APIResponse[DailySalesGetResponse]"},"APIResponse_DeleteDailyNoteResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/DeleteDailyNoteResponse"}},"type":"object","required":["data"],"title":"APIResponse[DeleteDailyNoteResponse]"},"APIResponse_DeleteDropdownOptionResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/DeleteDropdownOptionResponse"}},"type":"object","required":["data"],"title":"APIResponse[DeleteDropdownOptionResponse]"},"APIResponse_DeleteTaskResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/DeleteTaskResponse"}},"type":"object","required":["data"],"title":"APIResponse[DeleteTaskResponse]"},"APIResponse_DropdownCustomFieldOptionResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/DropdownCustomFieldOptionResponse"}},"type":"object","required":["data"],"title":"APIResponse[DropdownCustomFieldOptionResponse]"},"APIResponse_EditUsersResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/EditUsersResponse"}},"type":"object","required":["data"],"title":"APIResponse[EditUsersResponse]"},"APIResponse_FileCompleteUploadResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/FileCompleteUploadResponse"}},"type":"object","required":["data"],"title":"APIResponse[FileCompleteUploadResponse]"},"APIResponse_FileDownloadURLResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/FileDownloadURLResponse"}},"type":"object","required":["data"],"title":"APIResponse[FileDownloadURLResponse]"},"APIResponse_FileURLResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/FileURLResponse"}},"type":"object","required":["data"],"title":"APIResponse[FileURLResponse]"},"APIResponse_FormResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/FormResponse"}},"type":"object","required":["data"],"title":"APIResponse[FormResponse]"},"APIResponse_FormsSubmissionGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/FormsSubmissionGetResponse"}},"type":"object","required":["data"],"title":"APIResponse[FormsSubmissionGetResponse]"},"APIResponse_FormsSubmissionPutResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/FormsSubmissionPutResponse"}},"type":"object","required":["data"],"title":"APIResponse[FormsSubmissionPutResponse]"},"APIResponse_GeoFenceWithFenceIdEntity_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GeoFenceWithFenceIdEntity"}},"type":"object","required":["data"],"title":"APIResponse[GeoFenceWithFenceIdEntity]"},"APIResponse_GeoFencesCreatedResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GeoFencesCreatedResponse"}},"type":"object","required":["data"],"title":"APIResponse[GeoFencesCreatedResponse]"},"APIResponse_GeoFencesGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GeoFencesGetResponse"}},"type":"object","required":["data"],"title":"APIResponse[GeoFencesGetResponse]"},"APIResponse_GetCustomFieldsSettingsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetCustomFieldsSettingsResponse"}},"type":"object","required":["data"],"title":"APIResponse[GetCustomFieldsSettingsResponse]"},"APIResponse_GetFileURLResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetFileURLResponse"}},"type":"object","required":["data"],"title":"APIResponse[GetFileURLResponse]"},"APIResponse_GetPendingUsersResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetPendingUsersResponse"}},"type":"object","required":["data"],"title":"APIResponse[GetPendingUsersResponse]"},"APIResponse_GetSmartGroupsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetSmartGroupsResponse"}},"type":"object","required":["data"],"title":"APIResponse[GetSmartGroupsResponse]"},"APIResponse_GetTasksBoardsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetTasksBoardsResponse"}},"type":"object","required":["data"],"title":"APIResponse[GetTasksBoardsResponse]"},"APIResponse_LocationResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/LocationResponse"}},"type":"object","required":["data"],"title":"APIResponse[LocationResponse]"},"APIResponse_LocationsGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/LocationsGetResponse"}},"type":"object","required":["data"],"title":"APIResponse[LocationsGetResponse]"},"APIResponse_LockDaysPutResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/LockDaysPutResponse"}},"type":"object","required":["data"],"title":"APIResponse[LockDaysPutResponse]"},"APIResponse_ManualBreakClockInResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ManualBreakClockInResponse"}},"type":"object","required":["data"],"title":"APIResponse[ManualBreakClockInResponse]"},"APIResponse_ManualBreakClockOutResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ManualBreakClockOutResponse"}},"type":"object","required":["data"],"title":"APIResponse[ManualBreakClockOutResponse]"},"APIResponse_ManualBreaksGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ManualBreaksGetResponse"}},"type":"object","required":["data"],"title":"APIResponse[ManualBreaksGetResponse]"},"APIResponse_NoteCreateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/NoteCreateResponse"}},"type":"object","required":["data"],"title":"APIResponse[NoteCreateResponse]"},"APIResponse_PacksListResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/PacksListResponse"}},"type":"object","required":["data"],"title":"APIResponse[PacksListResponse]"},"APIResponse_PayRateDeleteResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/PayRateDeleteResponse"}},"type":"object","required":["data"],"title":"APIResponse[PayRateDeleteResponse]"},"APIResponse_PayRatePutResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/PayRatePutResponse"}},"type":"object","required":["data"],"title":"APIResponse[PayRatePutResponse]"},"APIResponse_PayRuleAssignmentResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/PayRuleAssignmentResponse"}},"type":"object","required":["data"],"title":"APIResponse[PayRuleAssignmentResponse]"},"APIResponse_PayRulePoliciesResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/PayRulePoliciesResponse"}},"type":"object","required":["data"],"title":"APIResponse[PayRulePoliciesResponse]"},"APIResponse_PayslipCreateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/PayslipCreateResponse"}},"type":"object","required":["data"],"title":"APIResponse[PayslipCreateResponse]"},"APIResponse_PendingUsersResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/PendingUsersResponse"}},"type":"object","required":["data"],"title":"APIResponse[PendingUsersResponse]"},"APIResponse_PerformanceUpdateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/PerformanceUpdateResponse"}},"type":"object","required":["data"],"title":"APIResponse[PerformanceUpdateResponse]"},"APIResponse_ProjectedSalesUpdateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ProjectedSalesUpdateResponse"}},"type":"object","required":["data"],"title":"APIResponse[ProjectedSalesUpdateResponse]"},"APIResponse_ShiftAttachmentsGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ShiftAttachmentsGetResponse"}},"type":"object","required":["data"],"title":"APIResponse[ShiftAttachmentsGetResponse]"},"APIResponse_SmartGroupCreateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/SmartGroupCreateResponse"}},"type":"object","required":["data"],"title":"APIResponse[SmartGroupCreateResponse]"},"APIResponse_SmartGroupSegmentCreateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/SmartGroupSegmentCreateResponse"}},"type":"object","required":["data"],"title":"APIResponse[SmartGroupSegmentCreateResponse]"},"APIResponse_SmartGroupSegmentsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/SmartGroupSegmentsResponse"}},"type":"object","required":["data"],"title":"APIResponse[SmartGroupSegmentsResponse]"},"APIResponse_SmartGroupUpdateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/SmartGroupUpdateResponse"}},"type":"object","required":["data"],"title":"APIResponse[SmartGroupUpdateResponse]"},"APIResponse_SubTaskCreateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/SubTaskCreateResponse"}},"type":"object","required":["data"],"title":"APIResponse[SubTaskCreateResponse]"},"APIResponse_SubTaskDeleteResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/SubTaskDeleteResponse"}},"type":"object","required":["data"],"title":"APIResponse[SubTaskDeleteResponse]"},"APIResponse_SubTaskUpdateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/SubTaskUpdateResponse"}},"type":"object","required":["data"],"title":"APIResponse[SubTaskUpdateResponse]"},"APIResponse_TimeActivitiesCreateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeActivitiesCreateResponse"}},"type":"object","required":["data"],"title":"APIResponse[TimeActivitiesCreateResponse]"},"APIResponse_TimeActivitiesGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeActivitiesGetResponse"}},"type":"object","required":["data"],"title":"APIResponse[TimeActivitiesGetResponse]"},"APIResponse_TimeActivitiesUpdateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeActivitiesUpdateResponse"}},"type":"object","required":["data"],"title":"APIResponse[TimeActivitiesUpdateResponse]"},"APIResponse_TimeClocksResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeClocksResponse"}},"type":"object","required":["data"],"title":"APIResponse[TimeClocksResponse]"},"APIResponse_TimeOffAssignPolicyResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeOffAssignPolicyResponse"}},"type":"object","required":["data"],"title":"APIResponse[TimeOffAssignPolicyResponse]"},"APIResponse_TimeOffGetPolicyTypesResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeOffGetPolicyTypesResponse"}},"type":"object","required":["data"],"title":"APIResponse[TimeOffGetPolicyTypesResponse]"},"APIResponse_TimeOffPutUserBalanceResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeOffPutUserBalanceResponse"}},"type":"object","required":["data"],"title":"APIResponse[TimeOffPutUserBalanceResponse]"},"APIResponse_TimeOffRequestCreateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeOffRequestCreateResponse"}},"type":"object","required":["data"],"title":"APIResponse[TimeOffRequestCreateResponse]"},"APIResponse_TimeOffRequestUpdateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeOffRequestUpdateResponse"}},"type":"object","required":["data"],"title":"APIResponse[TimeOffRequestUpdateResponse]"},"APIResponse_TimesheetTotalHoursGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimesheetTotalHoursGetResponse"}},"type":"object","required":["data"],"title":"APIResponse[TimesheetTotalHoursGetResponse]"},"APIResponse_TransactionCreateResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TransactionCreateResponse"}},"type":"object","required":["data"],"title":"APIResponse[TransactionCreateResponse]"},"APIResponse_UpdateDropdownOptionResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/UpdateDropdownOptionResponse"}},"type":"object","required":["data"],"title":"APIResponse[UpdateDropdownOptionResponse]"},"APIResponse_UpdatePendingUserResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/UpdatePendingUserResponse"}},"type":"object","required":["data"],"title":"APIResponse[UpdatePendingUserResponse]"},"APIResponse_UpdateTaskResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/UpdateTaskResponse"}},"type":"object","required":["data"],"title":"APIResponse[UpdateTaskResponse]"},"AbsenceType":{"type":"string","enum":["unavailability","timeOff"],"title":"AbsenceType"},"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"},"AddDropdownOption":{"properties":{"value":{"type":"string","title":"Value","description":"The dropdown value"}},"type":"object","required":["value"],"title":"AddDropdownOption"},"AddDropdownOptionRequest":{"properties":{"dropdownOptions":{"items":{"$ref":"#/components/schemas/AddDropdownOption"},"type":"array","title":"Dropdownoptions","description":"The dropdown options"}},"type":"object","required":["dropdownOptions"],"title":"AddDropdownOptionRequest"},"AddDropdownOptionsResponse":{"properties":{"options":{"items":{"$ref":"#/components/schemas/v2__features__workflow__external_api__v1__form_dropdown_options__models__dropdown_options__DropdownOptionResponse"},"type":"array","title":"Options","description":"The dropdown options."}},"type":"object","required":["options"],"title":"AddDropdownOptionsResponse"},"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"},"ArchiveUsersResponse":{"properties":{"success":{"type":"boolean","title":"Success","description":"Whether the users were deleted successfully."}},"type":"object","required":["success"],"title":"ArchiveUsersResponse"},"AssetAssignments":{"properties":{"userIds":{"items":{"type":"integer"},"type":"array","title":"Userids","description":"The unique identifiers of the assigned users to the asset"},"smartGroups":{"items":{"type":"string"},"type":"array","title":"Smartgroups","description":"The unique identifiers of the assigned smart groups to the asset"}},"type":"object","required":["userIds","smartGroups"],"title":"AssetAssignments"},"AssetInstance":{"properties":{"id":{"type":"integer","title":"Id","description":"Asset id"},"type":{"type":"string","title":"Type","description":"Asset type"}},"type":"object","required":["type","id"],"title":"AssetInstance"},"AssetPermissions":{"properties":{"userId":{"type":"integer","title":"Userid","description":"The unique identifiers who have permissions to the asset"},"deepPermission":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Deeppermission","description":"Granular per-feature permissions for this user on this asset. Keys depend on the feature (e.g. shift scheduler exposes view, add_and_edit_shifts, publish_shifts, edit_settings). Omitted entirely for assets whose feature has no granular permissions. Owners always receive a full-access object (every flag = true)."}},"type":"object","required":["userId"],"title":"AssetPermissions"},"AssetResponse":{"properties":{"permissions":{"items":{"$ref":"#/components/schemas/AssetPermissions"},"type":"array","title":"Permissions","description":"The details of user IDs with access permissions to the asset.","default":[]},"assignments":{"allOf":[{"$ref":"#/components/schemas/AssetAssignments"}],"title":"Assignments","description":"The details of the assignments of the asset"}},"type":"object","required":["assignments"],"title":"AssetResponse"},"AssignDataApi":{"properties":{"type":{"anyOf":[{"$ref":"#/components/schemas/AssignDataTypes"},{"type":"null"}],"description":"The type of the assign data (users, groups, both), default is both.","default":"both"},"userIds":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Userids","description":"The user ids to assign to this entity (if assigning type is users)."},"groupIds":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Groupids","description":"The group ids to assign to this entity (if assigning type is groups)."}},"type":"object","title":"AssignDataApi"},"AssignDataIn":{"properties":{"type":{"$ref":"#/components/schemas/AssignDataTypes","description":"The type of the assign data (users, groups, both), default is both.","default":"both"},"userIds":{"anyOf":[{"items":{"type":"integer","minimum":1.0,"description":"Integer with minimum value of 1"},"type":"array"},{"type":"null"}],"title":"Userids","description":"The user ids to assign to this entity (if assigning type is users)."},"groupIds":{"anyOf":[{"items":{"type":"integer","minimum":1.0,"description":"Integer with minimum value of 1"},"type":"array"},{"type":"null"}],"title":"Groupids","description":"The group ids to assign to this entity (if assigning type is groups)."}},"type":"object","title":"AssignDataIn"},"AssignDataTypes":{"type":"string","enum":["users","groups","both"],"title":"AssignDataTypes"},"AssignmentResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"Assignment ID"},"userId":{"type":"integer","title":"Userid","description":"Assigned user ID"},"status":{"allOf":[{"$ref":"#/components/schemas/OnboardingStatus"}],"description":"Onboarding status: \"in_progress\", \"completed\""},"isWaitingApproval":{"type":"boolean","title":"Iswaitingapproval","description":"True when the user has completed all required steps and is waiting for admin approval. "}},"type":"object","required":["id","userId","status","isWaitingApproval"],"title":"AssignmentResponse"},"AssignmentsCreateRequest":{"properties":{"userIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Userids","description":"List of user IDs to assign (max: 500)"}},"type":"object","required":["userIds"],"title":"AssignmentsCreateRequest"},"AssignmentsCreateResponse":{"properties":{},"type":"object","title":"AssignmentsCreateResponse"},"AssignmentsGetResponse":{"properties":{"assignments":{"items":{"$ref":"#/components/schemas/AssignmentResponse"},"type":"array","title":"Assignments","description":"List of pack assignments"}},"type":"object","required":["assignments"],"title":"AssignmentsGetResponse"},"AssignmentsResponse":{"properties":{"smartGroups":{"items":{"$ref":"#/components/schemas/SmartGroupInstance"},"type":"array","title":"Smartgroups","description":"The unique identifiers of the smart group Ids the user is assigned to","default":[]},"assets":{"items":{"$ref":"#/components/schemas/AssetInstance"},"type":"array","title":"Assets","description":"The unique identifiers for the specified assets","default":[]}},"type":"object","title":"AssignmentsResponse"},"AttachmentsFeatureTypeEnum":{"type":"string","enum":["chat","shiftscheduler","users","quicktasks"],"title":"AttachmentsFeatureTypeEnum","description":"An enumeration."},"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"},"AudioRecordingQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["audioRecording"],"title":"Questiontype","description":"The type of the question"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType"],"title":"AudioRecordingQuestion"},"AutoAssignRequest":{"properties":{"shiftsIds":{"items":{"type":"string"},"type":"array","title":"Shiftsids","description":"List of shift IDs to start a request to auto assign. The shifts must be within the same week period (according to the schedule settings)."},"isForceQualification":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isforcequalification","description":"Determines whether to take into consideration the qualifications of users.","default":true},"isForceUnavailability":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isforceunavailability","description":"Determines whether to consider users' unavailabilities.","default":true},"isForceLimitations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isforcelimitations","description":"Determines whether to consider users' limitations.","default":true},"isForceOpenShiftRequests":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isforceopenshiftrequests","description":"Determines whether to assign open shifts exclusively to requesters. If set to false, it first prioritizes requesters, then assigns the remaining.","default":false}},"type":"object","required":["shiftsIds"],"title":"AutoAssignRequest"},"AutoAssignResponse":{"properties":{"autoAssignRequestId":{"type":"string","title":"Autoassignrequestid","description":"The unique identifier of the auto assign request"}},"type":"object","required":["autoAssignRequestId"],"title":"AutoAssignResponse"},"AutoAssignStatusResponse":{"properties":{"autoAssignRequestId":{"type":"string","title":"Autoassignrequestid","description":"The unique identifier of the auto assign request"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"The status of the request"},"assignedShiftIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Assignedshiftids","description":"List of shift IDs that were successfully assigned"},"unassignedShiftIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Unassignedshiftids","description":"List of shift IDs that were not successfully assigned"}},"type":"object","required":["autoAssignRequestId"],"title":"AutoAssignStatusResponse"},"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.0,"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.0,"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.0,"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"},"BaseCustomField":{"properties":{"customFieldId":{"type":"integer","minimum":1.0,"title":"Customfieldid","description":"The custom field unique id"},"value":{"title":"Value","description":"The value of the custom field. Our real-time API documentation experience does not support custom fields of the dropdown type.To update dropdown fields value(s), pass an array of objects with the IDs of the selected dropdown values (e.g., [{id: 1}, {id: 2}])."}},"type":"object","required":["customFieldId","value"],"title":"BaseCustomField"},"BaseCustomFieldV2":{"properties":{"customFieldId":{"type":"integer","minimum":1.0,"title":"Customfieldid","description":"The custom field unique id"},"value":{"title":"Value","description":"The value of the custom field. Our real-time API documentation experience does not support custom fields of the dropdown type.To update dropdown fields value(s), pass an array of objects with the IDs of the selected dropdown values (e.g., [{id: 1}, {id: 2}])."}},"type":"object","required":["customFieldId","value"],"title":"BaseCustomFieldV2"},"BaseJobResponse":{"properties":{"jobId":{"type":"string","title":"Jobid","description":"The job ID"},"title":{"type":"string","title":"Title","description":"The title of the Job"},"code":{"type":"string","title":"Code","description":"The code of the Job."},"color":{"type":"string","title":"Color","description":"The color associated with the job"},"customFields":{"items":{"$ref":"#/components/schemas/CustomFieldResponseV2"},"type":"array","title":"Customfields","description":"The job's custom fields"},"description":{"type":"string","title":"Description","description":"The job description"},"fenceSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fencesize","description":"The geofence size of the job"},"gps":{"anyOf":[{"$ref":"#/components/schemas/GpsDataV2"},{"type":"null"}],"description":"GPS data associated with the job"},"isDeleted":{"type":"boolean","title":"Isdeleted","description":"Indicates whether the job is deleted or not","default":false},"assign":{"$ref":"#/components/schemas/AssignDataApi","description":"Data related to job assignment"},"useParentData":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Useparentdata","description":"Indicates whether to use the parent job's data or not"},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentid","description":"The ID of the parent job, if any"},"subJobs":{"anyOf":[{"items":{"$ref":"#/components/schemas/BaseJobResponse"},"type":"array"},{"type":"null"}],"title":"Subjobs","description":"The sub jobs of the parent job, if any"},"instanceIds":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Instanceids","description":"The instance IDs associated with the job"}},"type":"object","required":["jobId","title","code","color","description","assign"],"title":"BaseJobResponse"},"BaseResponse":{"properties":{},"type":"object","title":"BaseResponse"},"Body_create_custom_fields_users_v1_custom_fields_post":{"properties":{"customFields":{"items":{"anyOf":[{"$ref":"#/components/schemas/DropdownCustomFieldCreateRequest"},{"$ref":"#/components/schemas/CustomFieldCreateRequest"}]},"type":"array","maxItems":100,"title":"Customfields","description":"The custom fields."}},"type":"object","required":["customFields"],"title":"Body_create_custom_fields_users_v1_custom_fields_post"},"Body_delete_custom_fields_users_v1_custom_fields_delete":{"properties":{"customFieldIds":{"items":{"type":"integer"},"type":"array","maxItems":100,"title":"Customfieldids","description":"The custom fields IDs to delete"}},"type":"object","required":["customFieldIds"],"title":"Body_delete_custom_fields_users_v1_custom_fields_delete"},"Body_oauth_token_docs_oauth_v1_token_post":{"properties":{"grant_type":{"type":"string","title":"Grant Type","description":"OAuth 2.0 grant type (must be 'client_credentials')","default":"client_credentials"},"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope","description":"Space-separated list of requested scopes"}},"type":"object","title":"Body_oauth_token_docs_oauth_v1_token_post"},"Body_update_custom_fields_users_v1_custom_fields_put":{"properties":{"customFields":{"items":{"$ref":"#/components/schemas/CustomFieldBulkEditRequest"},"type":"array","maxItems":100,"title":"Customfields","description":"The custom fields."}},"type":"object","required":["customFields"],"title":"Body_update_custom_fields_users_v1_custom_fields_put"},"BreadcrumbsReportRequest":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Date for which to generate breadcrumbs report (YYYY-MM-DD)"}},"type":"object","required":["date"],"title":"BreadcrumbsReportRequest"},"BreadcrumbsReportResponse":{"properties":{"fileId":{"type":"string","title":"Fileid","description":"Request ID for tracking the report task"}},"type":"object","required":["fileId"],"title":"BreadcrumbsReportResponse"},"BreadcrumbsReportStatusResponse":{"properties":{"status":{"type":"string","title":"Status","description":"Task status: in_queue, in_progress, completed, error, or canceled"},"errorMsg":{"type":"string","title":"Errormsg","description":"Error message when status is error"}},"type":"object","required":["status"],"title":"BreadcrumbsReportStatusResponse"},"BulkDeleteCustomFieldResponse":{"properties":{"customFieldIds":{"items":{"type":"integer"},"type":"array","title":"Customfieldids","description":"The deleted custom fields ids"},"success":{"type":"boolean","title":"Success","description":"Whether the custom field were deleted successfully."}},"type":"object","required":["customFieldIds","success"],"title":"BulkDeleteCustomFieldResponse"},"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"},"ClockInRequest":{"properties":{"userId":{"type":"integer","title":"Userid","description":"The unique identifier of the user. Make sure the user is assigned to the specified time clock."},"jobId":{"type":"string","title":"Jobid","description":"The unique identifier of the associated job or sub-job. Make sure the job is assigned to the specified time clock. This field is required if the setting to enforce job assignment for time clock usage is enabled."},"timezone":{"type":"string","title":"Timezone","description":"The timezone in Tz format (e.g. America/New_York). If timezone is not specified, it will use the default timezone in the time clock settings."},"schedulerShiftId":{"type":"string","title":"Schedulershiftid","description":"The scheduled shift from the schedule associated with the clocking in event"},"timestamp":{"type":"integer","minimum":1.0,"title":"Timestamp","description":"The clock-in time in Unix format (in seconds). If omitted, the server captures the time when the request is received. Must be no more than 12 hours in the past and not in the future. Use to record a clock-in that already happened - typically when a physical clock device is flushing queued punches after recovering from offline mode."},"locationData":{"allOf":[{"$ref":"#/components/schemas/GpsData"}],"title":"Locationdata","description":"GPS data associated with the clocking in event"}},"type":"object","required":["userId"],"title":"ClockInRequest"},"ClockInResponse":{"properties":{"shift":{"allOf":[{"$ref":"#/components/schemas/v2__features__punchclock__external_api__v1__time_clocks__models__shift_response__ShiftResponse"}],"title":"Shift","description":"The created shift"}},"type":"object","required":["shift"],"title":"ClockInResponse"},"ClockOutRequest":{"properties":{"userId":{"type":"integer","title":"Userid","description":"The unique identifier of the user. Make sure the user is assigned to the specified time clock."},"timezone":{"type":"string","title":"Timezone","description":"The timezone in Tz format (e.g. America/New_York). If timezone is not specified, it will use the default timezone in the time clock settings."},"timestamp":{"type":"integer","minimum":1.0,"title":"Timestamp","description":"The clock-out time in Unix format (in seconds). If omitted, the server captures the time when the request is received. Must be no more than 12 hours in the past, not in the future, and after the open shift's clock-in time. Use to record a clock-out that already happened - typically when a physical clock device is flushing queued punches after recovering from offline mode."},"locationData":{"allOf":[{"$ref":"#/components/schemas/GpsData"}],"title":"Locationdata","description":"GPS data associated with the clocking out event"}},"type":"object","required":["userId"],"title":"ClockOutRequest"},"ClockOutResponse":{"properties":{"shift":{"allOf":[{"$ref":"#/components/schemas/v2__features__punchclock__external_api__v1__time_clocks__models__shift_response__ShiftResponse"}],"title":"Shift","description":"The created shift"}},"type":"object","required":["shift"],"title":"ClockOutResponse"},"ConversationDetailsResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the conversation. Use for sending messages and follow-up calls."},"title":{"type":"string","title":"Title","description":"The conversation title"},"type":{"allOf":[{"$ref":"#/components/schemas/ConversationType"}],"description":"The conversation type (team or channel)"},"assignedUserIds":{"items":{"type":"integer"},"type":"array","title":"Assigneduserids","description":"Individual user IDs assigned to the conversation"},"assignedSmartGroupIds":{"items":{"type":"integer"},"type":"array","title":"Assignedsmartgroupids","description":"Smart group IDs assigned to the conversation"},"adminUserIds":{"items":{"type":"integer"},"type":"array","title":"Adminuserids","description":"User IDs with admin privileges in the conversation"},"isLocked":{"type":"boolean","title":"Islocked","description":"Whether the conversation is locked"},"isMembersHidden":{"type":"boolean","title":"Ismembershidden","description":"Whether the member list is hidden","default":false},"description":{"items":{"type":"object"},"type":"array","title":"Description","description":"Structured conversation description blocks"}},"type":"object","required":["id","title","type","assignedUserIds","assignedSmartGroupIds","adminUserIds"],"title":"ConversationDetailsResponse"},"ConversationMutationRequest":{"properties":{"title":{"type":"string","title":"Title","description":"The conversation title shown in the chat clients. Must be non-empty after trimming whitespace."},"type":{"allOf":[{"$ref":"#/components/schemas/ConversationType"}],"description":"The conversation type. team = collaborative chat, all members can send messages. channel = broadcast group, only admins can send messages."},"assignedUserIds":{"items":{"type":"integer"},"type":"array","title":"Assigneduserids","description":"Individual user IDs assigned as members. At least one of assignedUserIds or assignedSmartGroupIds must be provided. Defaults to an empty array."},"assignedSmartGroupIds":{"items":{"type":"integer"},"type":"array","title":"Assignedsmartgroupids","description":"Smart group (dynamic cohort) IDs assigned to the conversation. Membership follows the smart group's rules. At least one of assignedUserIds or assignedSmartGroupIds must be provided. Defaults to an empty array."},"adminUserIds":{"items":{"type":"integer"},"type":"array","title":"Adminuserids","description":"User IDs granted admin privileges in the conversation (manage members/settings; for channels, the only users who can post). An admin id must also be an assigned member (via assignedUserIds or an assigned smart group) to take effect. If omitted, defaults are applied."},"isLocked":{"type":"boolean","title":"Islocked","description":"Whether the conversation is created locked (members cannot send messages until an admin unlocks it). Defaults to unlocked."},"isMembersHidden":{"type":"boolean","title":"Ismembershidden","description":"Whether the member list is hidden from members in the chat clients. Defaults to false.","default":false},"description":{"items":{"type":"object"},"type":"array","title":"Description","description":"Ordered list of structured rich-text blocks shown in the conversation details (not a chat message). Each block is a typed object, e.g. {\"type\":\"html\",\"html\":\"<div>...</div>\"}. Defaults to an empty array."}},"type":"object","required":["title","type"],"title":"ConversationMutationRequest"},"ConversationMutationResponse":{"properties":{"conversation":{"allOf":[{"$ref":"#/components/schemas/ConversationDetailsResponse"}],"title":"Conversation","description":"The created or updated conversation"}},"type":"object","required":["conversation"],"title":"ConversationMutationResponse"},"ConversationPostMessageRequest":{"properties":{"senderId":{"type":"integer","title":"Senderid","description":"The unique identifier of the sender (custom publisher). The custom publishers page can be found in the UI under Settings -> Feed settings."},"text":{"type":"string","maxLength":1000,"title":"Text","description":"Specifies the text content of the message. Must be in UTF-8 and less than 500 characters."},"attachments":{"items":{"oneOf":[{"$ref":"#/components/schemas/ImageAttachmentRequest"},{"$ref":"#/components/schemas/FileAttachmentRequest"}],"discriminator":{"propertyName":"type","mapping":{"image":"#/components/schemas/ImageAttachmentRequest","file":"#/components/schemas/FileAttachmentRequest"}}},"type":"array","title":"Attachments","description":"List of attachments to be associated with the message.","default":[]}},"type":"object","required":["senderId","text"],"title":"ConversationPostMessageRequest"},"ConversationResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the conversation"},"title":{"type":"string","title":"Title","description":"The title of the conversation"},"type":{"allOf":[{"$ref":"#/components/schemas/ConversationTypeResponse"}],"description":"The type of the conversation"},"conversationSource":{"type":"string","title":"Conversationsource","description":"Origin of the conversation"}},"type":"object","required":["id","title","type","conversationSource"],"title":"ConversationResponse"},"ConversationType":{"type":"string","enum":["team","channel"],"title":"ConversationType","description":"An enumeration."},"ConversationTypeResponse":{"enum":["team","channel"],"title":"ConversationTypeResponse","description":"An enumeration."},"ConversationsResponse":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/ConversationResponse"},"type":"array","title":"Conversations","description":"The list of conversations"}},"type":"object","required":["conversations"],"title":"ConversationsResponse"},"CreateDropdownCustomFieldOption":{"properties":{"value":{"type":"string","title":"Value","description":"The value to be added as the option"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"Indicates if this option is disabled","default":false}},"type":"object","required":["value"],"title":"CreateDropdownCustomFieldOption"},"CreateTaskRequest":{"properties":{"userIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Userids","description":"List of user IDs to assign the task to. If more than one user ID is specified, it will be treated as a group task. To assign the task to multiple users individually, separate the requests. If this field remains empty the status field must be 'draft' and not archived."},"status":{"allOf":[{"$ref":"#/components/schemas/TaskStatus"}],"description":"The status of the task"},"title":{"type":"string","title":"Title","description":"The title of the task"},"startTime":{"type":"integer","title":"Starttime","description":"The start time of the task in Unix format (in seconds)"},"dueDate":{"type":"integer","title":"Duedate","description":"The due date of the task in Unix format (in seconds)"},"labelIds":{"items":{"type":"string"},"type":"array","title":"Labelids","description":"List of labels IDs associated with the task"},"type":{"allOf":[{"$ref":"#/components/schemas/TaskType"}],"description":"The type of the task. Currently set to 'oneTime' by default.","default":"oneTime"},"isArchived":{"type":"boolean","title":"Isarchived","description":"Indicates if the task is archived","default":false},"subTasks":{"items":{"$ref":"#/components/schemas/SubTaskRequest"},"type":"array","title":"Subtasks","description":"List of subtasks associated with the task"},"description":{"allOf":[{"$ref":"#/components/schemas/TaskDescription"}],"title":"Description","description":"Specifies additional description on the task"}},"type":"object","required":["userIds","status","title"],"title":"CreateTaskRequest"},"CreateTaskResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the task"},"userIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Userids","description":"List of user IDs to assign the task to. If more than one user ID is specified, it will be treated as a group task. To assign the task to multiple users individually, separate the requests. If this field remains empty the status field must be 'draft' and not archived."},"status":{"allOf":[{"$ref":"#/components/schemas/TaskStatus"}],"description":"The status of the task"},"title":{"type":"string","title":"Title","description":"The title of the task"},"startTime":{"type":"integer","title":"Starttime","description":"The start time of the task in Unix format (in seconds)"},"dueDate":{"type":"integer","title":"Duedate","description":"The due date of the task in Unix format (in seconds)"},"labelIds":{"items":{"type":"string"},"type":"array","title":"Labelids","description":"List of labels IDs associated with the task"},"type":{"allOf":[{"$ref":"#/components/schemas/TaskType"}],"description":"The type of the task. Currently set to 'oneTime' by default.","default":"oneTime"},"isArchived":{"type":"boolean","title":"Isarchived","description":"Indicates if the task is archived","default":false},"subTasks":{"items":{"$ref":"#/components/schemas/SubTaskResponse"},"type":"array","title":"Subtasks","description":"List of subtasks associated with the task"},"description":{"allOf":[{"$ref":"#/components/schemas/TaskDescription"}],"title":"Description","description":"Specifies additional description on the task"}},"type":"object","required":["userIds","status","title","id"],"title":"CreateTaskResponse"},"CreateUsersResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/User"},"type":"array","title":"Results","description":"The created users."}},"type":"object","required":["results"],"title":"CreateUsersResponse"},"CustomFieldBulkEditRequest":{"properties":{"id":{"type":"integer","title":"Id","description":"The custom fields id"},"name":{"type":"string","maxLength":100,"title":"Name","description":"The name of the custom field"},"isRequired":{"type":"boolean","title":"Isrequired","description":"Indicates whether the custom field is required"},"categoryId":{"type":"integer","title":"Categoryid","description":"The unique identifier of the custom field category"},"isVisibleToAllAdmins":{"type":"boolean","title":"Isvisibletoalladmins","description":"Indicates whether the custom field is visible to all admins"},"viewAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Viewaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to view this custom field, owners can always see all custom fields.\nApplicable only to custom fields that are not visible to all admins."},"isEditableForAllAdmins":{"type":"boolean","title":"Iseditableforalladmins","description":"Indicates whether the custom field is editable by all admins"},"editAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Editaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to edit this custom field, owners can always edit all custom fields.\nApplicable only to custom fields that are not editable by all admins."},"isVisibleToUsers":{"type":"boolean","title":"Isvisibletousers","description":"Indicates whether the custom field is visible to users"},"isEditableForUsers":{"type":"boolean","title":"Iseditableforusers","description":"Indicates whether the custom field is editable by users.\nApplicable only to custom fields that are visible to users."},"isMultiSelect":{"type":"boolean","title":"Ismultiselect","description":"Indicates whether multiple selections are allowed in the dropdown.\nApplicable only to custom fields configured as dropdown types."},"dropdownOptions":{"items":{"$ref":"#/components/schemas/EditDropdownCustomFieldOption"},"type":"array","title":"Dropdownoptions","description":"The options available for selection in the dropdown field.\nApplicable only to custom fields configured as dropdown types."}},"type":"object","required":["id"],"title":"CustomFieldBulkEditRequest"},"CustomFieldCategoriesResponse":{"properties":{"categories":{"items":{"$ref":"#/components/schemas/CustomFieldCategory"},"type":"array","title":"Categories","description":"The custom fields categories"}},"type":"object","required":["categories"],"title":"CustomFieldCategoriesResponse"},"CustomFieldCategoriesSortExternal":{"enum":["id","name"],"title":"CustomFieldCategoriesSortExternal","description":"An enumeration."},"CustomFieldCategory":{"properties":{"id":{"type":"integer","title":"Id","description":"The category's id"},"name":{"type":"string","title":"Name","description":"The category's name"}},"type":"object","required":["id","name"],"title":"CustomFieldCategory"},"CustomFieldCreateRequest":{"properties":{"name":{"type":"string","maxLength":100,"title":"Name","description":"The name of the custom field"},"isRequired":{"type":"boolean","title":"Isrequired","description":"Indicates whether the custom field is required"},"categoryId":{"type":"integer","title":"Categoryid","description":"The unique identifier of the custom field category"},"isVisibleToAllAdmins":{"type":"boolean","title":"Isvisibletoalladmins","description":"Indicates whether the custom field is visible to all admins"},"viewAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Viewaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to view this custom field, owners can always see all custom fields.\nApplicable only to custom fields that are not visible to all admins."},"isEditableForAllAdmins":{"type":"boolean","title":"Iseditableforalladmins","description":"Indicates whether the custom field is editable by all admins"},"editAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Editaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to edit this custom field, owners can always edit all custom fields.\nApplicable only to custom fields that are not editable by all admins."},"isVisibleToUsers":{"type":"boolean","title":"Isvisibletousers","description":"Indicates whether the custom field is visible to users"},"isEditableForUsers":{"type":"boolean","title":"Iseditableforusers","description":"Indicates whether the custom field is editable by users.\nApplicable only to custom fields that are visible to users."},"type":{"type":"string","enum":["email","date","phone","number","str","file","directManager","birthday","link","location"],"title":"Type","description":"The type of the custom field: Email, Date, Number, Text, Phone number, File."}},"type":"object","required":["name","isRequired","categoryId","isVisibleToAllAdmins","isEditableForAllAdmins","isVisibleToUsers","isEditableForUsers","type"],"title":"CustomFieldCreateRequest"},"CustomFieldOptionsResponse":{"properties":{"options":{"items":{"$ref":"#/components/schemas/DropdownCustomFieldOptionResponse"},"type":"array","title":"Options","description":"The custom field options"}},"type":"object","required":["options"],"title":"CustomFieldOptionsResponse"},"CustomFieldResponse":{"properties":{"customFieldId":{"type":"integer","minimum":1.0,"title":"Customfieldid","description":"The custom field unique id"},"value":{"title":"Value","description":"The value of the custom field. Our real-time API documentation experience does not support custom fields of the dropdown type.To update dropdown fields value(s), pass an array of objects with the IDs of the selected dropdown values (e.g., [{id: 1}, {id: 2}])."},"type":{"allOf":[{"$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":"CustomFieldResponse"},"CustomFieldResponseV2":{"properties":{"customFieldId":{"type":"integer","minimum":1.0,"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"},"CustomFieldSettingsResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The custom fields id"},"name":{"type":"string","maxLength":100,"title":"Name","description":"The name of the custom field"},"isRequired":{"type":"boolean","title":"Isrequired","description":"Indicates whether the custom field is required"},"categoryId":{"type":"integer","title":"Categoryid","description":"The unique identifier of the custom field category"},"isVisibleToAllAdmins":{"type":"boolean","title":"Isvisibletoalladmins","description":"Indicates whether the custom field is visible to all admins"},"viewAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Viewaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to view this custom field, owners can always see all custom fields.\nApplicable only to custom fields that are not visible to all admins."},"isEditableForAllAdmins":{"type":"boolean","title":"Iseditableforalladmins","description":"Indicates whether the custom field is editable by all admins"},"editAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Editaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to edit this custom field, owners can always edit all custom fields.\nApplicable only to custom fields that are not editable by all admins."},"isVisibleToUsers":{"type":"boolean","title":"Isvisibletousers","description":"Indicates whether the custom field is visible to users"},"isEditableForUsers":{"type":"boolean","title":"Iseditableforusers","description":"Indicates whether the custom field is editable by users.\nApplicable only to custom fields that are visible to users."},"type":{"allOf":[{"$ref":"#/components/schemas/UserCustomFields"}],"description":"The type of the custom field: Email, Date, Number, Text, Phone number, Dropdown, File."}},"type":"object","required":["name","isRequired","categoryId","isVisibleToAllAdmins","isEditableForAllAdmins","isVisibleToUsers","isEditableForUsers","id","type"],"title":"CustomFieldSettingsResponse"},"CustomFieldsSortExternal":{"enum":["id","name","type"],"title":"CustomFieldsSortExternal","description":"An enumeration."},"DailyNoteCreateRequest":{"properties":{"title":{"type":"string","title":"Title","description":"The title of the note"},"qualifiedUserIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Qualifieduserids","description":"The users qualified to see the note","default":[]},"qualifiedGroupIds":{"items":{"type":"integer"},"type":"array","title":"Qualifiedgroupids","description":"The groups qualified to see the note","default":[]},"date":{"type":"string","title":"Date","description":"The date for the note in ISO 8601 format (e.g. YYYY-MM-DD)"},"instanceId":{"type":"integer","title":"Instanceid","description":"The unique identifier of the schedule"}},"type":"object","required":["title","date","instanceId"],"title":"DailyNoteCreateRequest"},"DailyNoteResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The note ID"},"title":{"type":"string","title":"Title","description":"The title of the note"},"qualifiedUserIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Qualifieduserids","description":"The users qualified to see the note","default":[]},"qualifiedGroupIds":{"items":{"type":"integer"},"type":"array","title":"Qualifiedgroupids","description":"The groups qualified to see the note","default":[]},"dates":{"items":{"type":"string"},"type":"array","title":"Dates","description":"Dates the note is relevant for in ISO 8601 format (e.g. YYYY-MM-DD)"}},"type":"object","required":["id","title","dates"],"title":"DailyNoteResponse"},"DailyNoteUpdateRequest":{"properties":{"title":{"type":"string","title":"Title","description":"The title of the note"},"qualifiedUserIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Qualifieduserids","description":"The users qualified to see the note"},"qualifiedGroupIds":{"items":{"type":"integer"},"type":"array","title":"Qualifiedgroupids","description":"The groups qualified to see the note"}},"type":"object","title":"DailyNoteUpdateRequest"},"DailyRecordResponse":{"properties":{"date":{"type":"string","title":"Date","description":"The date of the record in ISO 8601 format (YYYY-MM-DD)"},"dailyTotalHours":{"type":"number","title":"Dailytotalhours","description":"The total hours for the day"},"dailyTotalWorkHours":{"type":"number","title":"Dailytotalworkhours","description":"The total work hours for the day"},"dailyTotalPaidBreakHours":{"type":"number","title":"Dailytotalpaidbreakhours","description":"The total paid break hours for the day"},"dailyTotalUnpaidBreakHours":{"type":"number","title":"Dailytotalunpaidbreakhours","description":"The total unpaid break hours for the day"},"isApproved":{"type":"boolean","title":"Isapproved","description":"Indicates whether the daily record is approved"},"isSubmitted":{"type":"boolean","title":"Issubmitted","description":"Indicates whether the daily record is submitted"},"isLocked":{"type":"boolean","title":"Islocked","description":"Indicates whether the daily record is locked"},"payItems":{"items":{"$ref":"#/components/schemas/PayItemResponse"},"type":"array","title":"Payitems","description":"The aggregated pay items for the entire day"},"records":{"items":{"$ref":"#/components/schemas/ShiftEntryResponse"},"type":"array","title":"Records","description":"The hour entries for this date"},"dailyScheduledDetails":{"allOf":[{"$ref":"#/components/schemas/DailyScheduledDetailsResponse"}],"title":"Dailyscheduleddetails","description":"Plan vs Actual scheduled details for the day. Present only when includePlanVsActual=true."}},"type":"object","required":["date","dailyTotalHours","dailyTotalWorkHours","dailyTotalPaidBreakHours","dailyTotalUnpaidBreakHours","isApproved","isSubmitted","isLocked","payItems","records"],"title":"DailyRecordResponse"},"DailySalesEntry":{"properties":{"date":{"type":"string","title":"Date","description":"Calendar date for the entry, in ISO 8601 format (YYYY-MM-DD)."},"locationId":{"type":"integer","title":"Locationid","description":"Unique identifier of the location (from the Get locations endpoint)."},"totalSales":{"type":"number","title":"Totalsales","description":"Total sales for the day, aggregated from transactions. May be null when no transactions exist for that day. To change this value, use the Create transactions endpoint."},"projectedSales":{"type":"number","title":"Projectedsales","description":"Projected sales target for the day. Set via Set projected sales. May be null if not set."}},"type":"object","required":["date","locationId"],"title":"DailySalesEntry"},"DailySalesGetResponse":{"properties":{"dailySales":{"items":{"$ref":"#/components/schemas/DailySalesEntry"},"type":"array","title":"Dailysales","description":"List of daily sales entries. Only days with stored aggregation data are included; the list is not a full calendar grid for every location in the range."}},"type":"object","required":["dailySales"],"title":"DailySalesGetResponse"},"DailyScheduledDetailsResponse":{"properties":{"dailyScheduledHours":{"type":"number","title":"Dailyscheduledhours","description":"Total planned/scheduled hours for the day"},"dailyScheduledDifferenceHours":{"type":"number","title":"Dailyscheduleddifferencehours","description":"Difference between timesheet paid hours and planned hours for the day"},"dailyScheduledShifts":{"type":"integer","title":"Dailyscheduledshifts","description":"Number of planned/scheduled shifts for the day"},"shifts":{"items":{"$ref":"#/components/schemas/ScheduledShiftDetailResponse"},"type":"array","title":"Shifts","description":"Planned/scheduled shift details for the day. Currently includes only the shift id."}},"type":"object","required":["dailyScheduledHours","dailyScheduledDifferenceHours","dailyScheduledShifts","shifts"],"title":"DailyScheduledDetailsResponse"},"DateManagerField":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The Manager Field's ID"},"name":{"type":"string","title":"Name","description":"The Manager Field's name"},"mobileUsersCanSee":{"type":"boolean","title":"Mobileuserscansee","description":"Indication if mobile users can see the Manager Field"},"mobileUsersNotifyWhenChanges":{"type":"boolean","title":"Mobileusersnotifywhenchanges","description":"Indication if mobile users will be notified if the Manager Field changes"},"adminsWhoCanEdit":{"allOf":[{"$ref":"#/components/schemas/LimitAdminsWhoCanEdit"}],"title":"Adminswhocanedit","description":" Limit the admins who can edit this manager field. Owners can always edit the manager field."},"managerFieldType":{"type":"string","enum":["date"],"title":"Managerfieldtype","description":"The Manager Field's type"}},"type":"object","required":["managerFieldId","name","mobileUsersCanSee","mobileUsersNotifyWhenChanges","adminsWhoCanEdit","managerFieldType"],"title":"DateManagerField"},"DateQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["datetime"],"title":"Questiontype","description":"The type of the question"},"isDateActive":{"type":"boolean","title":"Isdateactive","description":"Indication if selecting a date is enabled"},"isTimeActive":{"type":"boolean","title":"Istimeactive","description":"Indication if selecting a time is enabled"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","isDateActive","isTimeActive"],"title":"DateQuestion"},"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"},"DeleteDailyNoteResponse":{"properties":{},"type":"object","title":"DeleteDailyNoteResponse"},"DeleteDropdownOptionResponse":{"properties":{},"type":"object","title":"DeleteDropdownOptionResponse"},"DeleteJobResponse":{"properties":{},"type":"object","title":"DeleteJobResponse"},"DeletePendingUsersRequest":{"properties":{"ids":{"items":{"type":"integer"},"type":"array","title":"Ids","description":"List of pending user IDs to delete"}},"type":"object","required":["ids"],"title":"DeletePendingUsersRequest"},"DeleteTaskResponse":{"properties":{},"type":"object","title":"DeleteTaskResponse"},"DeletionType":{"type":"string","enum":["archive","delete"],"title":"DeletionType","description":"Deletion type for user deletion endpoint"},"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"},"DescriptionQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"questionType":{"type":"string","enum":["description"],"title":"Questiontype","description":"The type of the question"}},"type":"object","required":["questionId","title","description","questionType"],"title":"DescriptionQuestion"},"DropdownCustomFieldCreateRequest":{"properties":{"name":{"type":"string","maxLength":100,"title":"Name","description":"The name of the custom field"},"isRequired":{"type":"boolean","title":"Isrequired","description":"Indicates whether the custom field is required"},"categoryId":{"type":"integer","title":"Categoryid","description":"The unique identifier of the custom field category"},"isVisibleToAllAdmins":{"type":"boolean","title":"Isvisibletoalladmins","description":"Indicates whether the custom field is visible to all admins"},"viewAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Viewaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to view this custom field, owners can always see all custom fields.\nApplicable only to custom fields that are not visible to all admins."},"isEditableForAllAdmins":{"type":"boolean","title":"Iseditableforalladmins","description":"Indicates whether the custom field is editable by all admins"},"editAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Editaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to edit this custom field, owners can always edit all custom fields.\nApplicable only to custom fields that are not editable by all admins."},"isVisibleToUsers":{"type":"boolean","title":"Isvisibletousers","description":"Indicates whether the custom field is visible to users"},"isEditableForUsers":{"type":"boolean","title":"Iseditableforusers","description":"Indicates whether the custom field is editable by users.\nApplicable only to custom fields that are visible to users."},"isMultiSelect":{"type":"boolean","title":"Ismultiselect","description":"Indicates whether multiple selections are allowed in the dropdown.\nApplicable only to custom fields configured as dropdown types."},"dropdownOptions":{"items":{"$ref":"#/components/schemas/CreateDropdownCustomFieldOption"},"type":"array","title":"Dropdownoptions","description":"The options available for selection in the dropdown field.\nApplicable only to custom fields configured as dropdown types."},"type":{"type":"string","enum":["dropdown"],"title":"Type","description":"The type of the custom field: Dropdown","default":"dropdown"}},"type":"object","required":["name","isRequired","categoryId","isVisibleToAllAdmins","isEditableForAllAdmins","isVisibleToUsers","isEditableForUsers","isMultiSelect"],"title":"DropdownCustomFieldCreateRequest"},"DropdownCustomFieldOption":{"properties":{"id":{"type":"integer","title":"Id","description":"The id of this option"},"value":{"type":"string","title":"Value","description":"The name of this option"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"Indicates if this option is disabled","default":false},"isDeleted":{"type":"boolean","title":"Isdeleted","description":"Indicates if this option is deleted\n(this will still be returned in case someone already chose this option so you can see the value).","default":false}},"type":"object","required":["id","value"],"title":"DropdownCustomFieldOption"},"DropdownCustomFieldOptionResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The id of this option"},"value":{"type":"string","title":"Value","description":"The name of this option"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"Indicates if this option is disabled","default":false},"isDeleted":{"type":"boolean","title":"Isdeleted","description":"Indicates if this option is deleted\n(this will still be returned in case someone already chose this option so you can see the value).","default":false}},"type":"object","required":["id","value"],"title":"DropdownCustomFieldOptionResponse"},"DropdownCustomFieldSettingsResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The custom fields id"},"name":{"type":"string","maxLength":100,"title":"Name","description":"The name of the custom field"},"isRequired":{"type":"boolean","title":"Isrequired","description":"Indicates whether the custom field is required"},"categoryId":{"type":"integer","title":"Categoryid","description":"The unique identifier of the custom field category"},"isVisibleToAllAdmins":{"type":"boolean","title":"Isvisibletoalladmins","description":"Indicates whether the custom field is visible to all admins"},"viewAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Viewaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to view this custom field, owners can always see all custom fields.\nApplicable only to custom fields that are not visible to all admins."},"isEditableForAllAdmins":{"type":"boolean","title":"Iseditableforalladmins","description":"Indicates whether the custom field is editable by all admins"},"editAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Editaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to edit this custom field, owners can always edit all custom fields.\nApplicable only to custom fields that are not editable by all admins."},"isVisibleToUsers":{"type":"boolean","title":"Isvisibletousers","description":"Indicates whether the custom field is visible to users"},"isEditableForUsers":{"type":"boolean","title":"Iseditableforusers","description":"Indicates whether the custom field is editable by users.\nApplicable only to custom fields that are visible to users."},"isMultiSelect":{"type":"boolean","title":"Ismultiselect","description":"Indicates whether multiple selections are allowed in the dropdown.\nApplicable only to custom fields configured as dropdown types."},"dropdownOptions":{"items":{"$ref":"#/components/schemas/DropdownCustomFieldOption"},"type":"array","title":"Dropdownoptions","description":"The options available for selection in the dropdown field.\nApplicable only to custom fields configured as dropdown types."},"type":{"type":"string","enum":["dropdown"],"title":"Type","description":"The type of the custom field: Email, Date, Number, Text, Phone number, Dropdown, File.","default":"dropdown"}},"type":"object","required":["name","isRequired","categoryId","isVisibleToAllAdmins","isEditableForAllAdmins","isVisibleToUsers","isEditableForUsers","isMultiSelect","dropdownOptions","id"],"title":"DropdownCustomFieldSettingsResponse"},"DropdownFilter":{"properties":{"fieldId":{"type":"integer","title":"Fieldid","description":"The ID of the custom field to filter by"},"optionIds":{"items":{"type":"integer"},"type":"array","title":"Optionids","description":"List of dropdown option IDs to match"}},"type":"object","required":["fieldId","optionIds"],"title":"DropdownFilter"},"DropdownResourceCustomFieldSettingsResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The resource custom field id"},"name":{"type":"string","maxLength":100,"title":"Name","description":"The name of the custom field"},"isRequired":{"type":"boolean","title":"Isrequired","description":"Indicates whether the custom field is required"},"categoryId":{"type":"integer","title":"Categoryid","description":"The unique identifier of the custom field category"},"isVisibleToAllAdmins":{"type":"boolean","title":"Isvisibletoalladmins","description":"Indicates whether the custom field is visible to all admins"},"viewAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Viewaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to view this custom field, owners can always see all custom fields.\nApplicable only to custom fields that are not visible to all admins."},"isEditableForAllAdmins":{"type":"boolean","title":"Iseditableforalladmins","description":"Indicates whether the custom field is editable by all admins"},"editAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Editaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to edit this custom field, owners can always edit all custom fields.\nApplicable only to custom fields that are not editable by all admins."},"isVisibleToUsers":{"type":"boolean","title":"Isvisibletousers","description":"Indicates whether the custom field is visible to users"},"isEditableForUsers":{"type":"boolean","title":"Iseditableforusers","description":"Indicates whether the custom field is editable by users.\nApplicable only to custom fields that are visible to users."},"isMultiSelect":{"type":"boolean","title":"Ismultiselect","description":"Indicates whether multiple selections are allowed in the dropdown.\nApplicable only to custom fields configured as dropdown types."},"dropdownOptions":{"items":{"$ref":"#/components/schemas/DropdownCustomFieldOption"},"type":"array","title":"Dropdownoptions","description":"The options available for selection in the dropdown field.\nApplicable only to custom fields configured as dropdown types."},"type":{"type":"string","enum":["dropdown"],"title":"Type","description":"The type of the custom field: Text, Phone number, Dropdown.","default":"dropdown"}},"type":"object","required":["name","isRequired","isVisibleToAllAdmins","isEditableForAllAdmins","isVisibleToUsers","isEditableForUsers","isMultiSelect","dropdownOptions","id"],"title":"DropdownResourceCustomFieldSettingsResponse"},"DropdownShiftCustomFieldSettingsResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The shift custom field id"},"name":{"type":"string","title":"Name","description":"The name of the custom field"},"type":{"type":"string","title":"Type","description":"The type of the custom field: Dropdown","default":"dropdown"},"isMultiSelect":{"type":"boolean","title":"Ismultiselect","description":"Whether the dropdown allows multiple selections","default":false},"dropdownOptions":{"items":{"$ref":"#/components/schemas/v2__features__shiftscheduler__external_api__v1__schedulers__scheduler__custom_fields__models__shift_custom_field_settings_response__DropdownOptionResponse"},"type":"array","title":"Dropdownoptions","description":"The dropdown options"}},"type":"object","required":["id","name"],"title":"DropdownShiftCustomFieldSettingsResponse"},"EditDropdownCustomFieldOption":{"properties":{"id":{"type":"integer","title":"Id","description":"The id of this option"},"value":{"type":"string","title":"Value","description":"The name of this option"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"Indicates if this option is disabled","default":false},"isDeleted":{"type":"boolean","title":"Isdeleted","description":"Indicates if this option is deleted\n(this will still be returned in case someone already chose this option so you can see the value).","default":false}},"type":"object","title":"EditDropdownCustomFieldOption"},"EditSingleDropdownCustomFieldOption":{"properties":{"value":{"type":"string","title":"Value","description":"The value to be added as the option"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"Indicates if this option is disabled","default":false}},"type":"object","title":"EditSingleDropdownCustomFieldOption"},"EditUsersResponse":{"properties":{"count":{"type":"integer","title":"Count","description":"The number of users edited."},"users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","title":"Users","description":"The edited users."}},"type":"object","required":["count","users"],"title":"EditUsersResponse"},"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"},"EmailQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["emailAddress"],"title":"Questiontype","description":"The type of the question"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType"],"title":"EmailQuestion"},"EndTimeResponse":{"properties":{"timestamp":{"type":"integer","minimum":1.0,"title":"Timestamp","description":"The end time of the shift"},"timezone":{"type":"string","title":"Timezone","description":"The timezone of the shift"},"locationData":{"allOf":[{"$ref":"#/components/schemas/GpsData"}],"title":"Locationdata","description":"The location data"},"source":{"allOf":[{"$ref":"#/components/schemas/PunchSourceResponse"}],"title":"Source","description":"Describes the origin from which the punch was created"}},"type":"object","title":"EndTimeResponse"},"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"},"ExitGeofenceAction":{"type":"string","enum":["noAction","sendNotification","autoClockOut"],"title":"ExitGeofenceAction","description":"An enumeration."},"FileAttachmentRequest":{"properties":{"type":{"type":"string","enum":["file"],"title":"Type","description":"The type of the attachment."},"fileId":{"type":"string","title":"Fileid","description":"The unique identifier of the file."}},"type":"object","required":["type","fileId"],"title":"FileAttachmentRequest"},"FileCompleteUploadResponse":{"properties":{"fileId":{"type":"string","title":"Fileid","description":"The unique identifier for the file"}},"type":"object","required":["fileId"],"title":"FileCompleteUploadResponse"},"FileDownloadURLRequest":{"properties":{"fileUrl":{"type":"string","title":"Fileurl","description":"The full URL of the file to generate a download URL for"},"expirationInSeconds":{"type":"integer","maximum":86400.0,"minimum":5.0,"title":"Expirationinseconds","description":"The expiration time of the URL in seconds (min: 5, max: 86400 / 24 hours)","default":3600}},"type":"object","required":["fileUrl"],"title":"FileDownloadURLRequest"},"FileDownloadURLResponse":{"properties":{"url":{"type":"string","title":"Url","description":"The URL for downloading the file."},"expiresInSeconds":{"type":"integer","title":"Expiresinseconds","description":"The expiration time of the URL in seconds"}},"type":"object","required":["url","expiresInSeconds"],"title":"FileDownloadURLResponse"},"FileManagerField":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The Manager Field's ID"},"name":{"type":"string","title":"Name","description":"The Manager Field's name"},"mobileUsersCanSee":{"type":"boolean","title":"Mobileuserscansee","description":"Indication if mobile users can see the Manager Field"},"mobileUsersNotifyWhenChanges":{"type":"boolean","title":"Mobileusersnotifywhenchanges","description":"Indication if mobile users will be notified if the Manager Field changes"},"adminsWhoCanEdit":{"allOf":[{"$ref":"#/components/schemas/LimitAdminsWhoCanEdit"}],"title":"Adminswhocanedit","description":" Limit the admins who can edit this manager field. Owners can always edit the manager field."},"managerFieldType":{"type":"string","enum":["file"],"title":"Managerfieldtype","description":"The Manager Field's type"}},"type":"object","required":["managerFieldId","name","mobileUsersCanSee","mobileUsersNotifyWhenChanges","adminsWhoCanEdit","managerFieldType"],"title":"FileManagerField"},"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"},"FileQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["files"],"title":"Questiontype","description":"The type of the question"},"isMultipleFileUploadAllowed":{"type":"boolean","title":"Ismultiplefileuploadallowed","description":"Indicates if multiple file uploads is enabled"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","isMultipleFileUploadAllowed"],"title":"FileQuestion"},"FileURLCreateRequest":{"properties":{"fileName":{"type":"string","title":"Filename","description":"The name of the attachment you want to upload"},"fileTypeHint":{"type":"string","title":"Filetypehint","description":"The MIME type or format of the attachment (e.g. image/jpeg, application/pdf)"},"featureType":{"allOf":[{"$ref":"#/components/schemas/AttachmentsFeatureTypeEnum"}],"description":"The specific feature or context where the attachment will be linked"}},"type":"object","required":["fileName","featureType"],"title":"FileURLCreateRequest"},"FileURLResponse":{"properties":{"fileId":{"type":"string","title":"Fileid","description":"The unique identifier for the file"},"uploadFileUrl":{"type":"string","maxLength":65536,"minLength":1,"format":"uri","title":"Uploadfileurl","description":"The pre-signed URL for uploading the file to the cloud storage"}},"type":"object","required":["fileId","uploadFileUrl"],"title":"FileURLResponse"},"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"},"FormResponse":{"properties":{"formId":{"type":"integer","title":"Formid","description":"The Form's ID"},"formName":{"type":"string","title":"Formname","description":"The Form's title"},"createdAt":{"type":"integer","title":"Createdat","description":"Form's creation timestamp"},"lastUpdatedAt":{"type":"integer","title":"Lastupdatedat","description":"The Form's last update timestamp"},"questions":{"items":{"oneOf":[{"$ref":"#/components/schemas/MultipleChoiceQuestion"},{"$ref":"#/components/schemas/NumberQuestion"},{"$ref":"#/components/schemas/PhoneNumberQuestion"},{"$ref":"#/components/schemas/OpenEndedQuestion"},{"$ref":"#/components/schemas/EmailQuestion"},{"$ref":"#/components/schemas/YesNoQuestion"},{"$ref":"#/components/schemas/ImageSelectionQuestion"},{"$ref":"#/components/schemas/ImageQuestion"},{"$ref":"#/components/schemas/ScannerQuestion"},{"$ref":"#/components/schemas/LocationQuestion"},{"$ref":"#/components/schemas/AudioRecordingQuestion"},{"$ref":"#/components/schemas/VideoQuestion"},{"$ref":"#/components/schemas/TaskQuestion"},{"$ref":"#/components/schemas/DateQuestion"},{"$ref":"#/components/schemas/RatingQuestion"},{"$ref":"#/components/schemas/SignatureQuestion"},{"$ref":"#/components/schemas/FileQuestion"},{"$ref":"#/components/schemas/SliderQuestion"},{"$ref":"#/components/schemas/FormulaQuestion"},{"$ref":"#/components/schemas/DescriptionQuestion"},{"$ref":"#/components/schemas/GroupQuestion"}],"discriminator":{"propertyName":"questionType","mapping":{"multipleChoice":"#/components/schemas/MultipleChoiceQuestion","number":"#/components/schemas/NumberQuestion","phoneNumber":"#/components/schemas/PhoneNumberQuestion","openEnded":"#/components/schemas/OpenEndedQuestion","emailAddress":"#/components/schemas/EmailQuestion","yesNo":"#/components/schemas/YesNoQuestion","imageSelection":"#/components/schemas/ImageSelectionQuestion","image":"#/components/schemas/ImageQuestion","scanDocument":"#/components/schemas/ScannerQuestion","location":"#/components/schemas/LocationQuestion","audioRecording":"#/components/schemas/AudioRecordingQuestion","video":"#/components/schemas/VideoQuestion","task":"#/components/schemas/TaskQuestion","datetime":"#/components/schemas/DateQuestion","rating":"#/components/schemas/RatingQuestion","signature":"#/components/schemas/SignatureQuestion","files":"#/components/schemas/FileQuestion","slider":"#/components/schemas/SliderQuestion","formula":"#/components/schemas/FormulaQuestion","description":"#/components/schemas/DescriptionQuestion","group":"#/components/schemas/GroupQuestion"}}},"type":"array","title":"Questions","description":"List of the Form's questions"},"settings":{"allOf":[{"$ref":"#/components/schemas/FormSettings"}],"title":"Settings","description":"The Form's settings"}},"type":"object","required":["formId","formName","createdAt","lastUpdatedAt","questions","settings"],"title":"FormResponse"},"FormSettings":{"properties":{"enableUsersToDownloadPdf":{"type":"boolean","title":"Enableuserstodownloadpdf","description":"Indication if users can download a PDF of the entry"},"limitTotalEntries":{"allOf":[{"$ref":"#/components/schemas/LimitTotalEntries"}],"title":"Limittotalentries","description":"The settings for the total number of entries limit"},"limitEntriesPerUser":{"allOf":[{"$ref":"#/components/schemas/LimitEntriesPerUser"}],"title":"Limitentriesperuser","description":"The settings for the total number of entries per user limit"},"limitEntriesUntilTimestamp":{"allOf":[{"$ref":"#/components/schemas/LimitEntriesUntilTimestamp"}],"title":"Limitentriesuntiltimestamp","description":"The settings for time limit indicating until when entries can be submitted"},"isAnonymous":{"type":"boolean","title":"Isanonymous","description":"Indication if the form submissions are anonymous"},"managerFields":{"items":{"oneOf":[{"$ref":"#/components/schemas/FileManagerField"},{"$ref":"#/components/schemas/SignatureManagerField"},{"$ref":"#/components/schemas/DateManagerField"},{"$ref":"#/components/schemas/OwnerManagerField"},{"$ref":"#/components/schemas/NoteManagerField"},{"$ref":"#/components/schemas/StatusManagerField"}],"discriminator":{"propertyName":"managerFieldType","mapping":{"file":"#/components/schemas/FileManagerField","signature":"#/components/schemas/SignatureManagerField","date":"#/components/schemas/DateManagerField","owner":"#/components/schemas/OwnerManagerField","note":"#/components/schemas/NoteManagerField","status":"#/components/schemas/StatusManagerField"}}},"type":"array","title":"Managerfields","description":"List of manager fields in the form"}},"type":"object","required":["enableUsersToDownloadPdf","limitTotalEntries","limitEntriesPerUser","limitEntriesUntilTimestamp","isAnonymous","managerFields"],"title":"FormSettings"},"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"},"FormSubmissionPutRequest":{"properties":{"managerFields":{"items":{"oneOf":[{"$ref":"#/components/schemas/ManagerFieldFileRequest"},{"$ref":"#/components/schemas/ManagerFieldDateRequest"},{"$ref":"#/components/schemas/ManagerFieldSignatureRequest"},{"$ref":"#/components/schemas/ManagerFieldOwnerRequest"},{"$ref":"#/components/schemas/ManagerFieldStatusRequest"},{"$ref":"#/components/schemas/ManagerFieldNoteRequest"}],"discriminator":{"propertyName":"managerFieldType","mapping":{"file":"#/components/schemas/ManagerFieldFileRequest","date":"#/components/schemas/ManagerFieldDateRequest","signature":"#/components/schemas/ManagerFieldSignatureRequest","owner":"#/components/schemas/ManagerFieldOwnerRequest","status":"#/components/schemas/ManagerFieldStatusRequest","note":"#/components/schemas/ManagerFieldNoteRequest"}}},"type":"array","title":"Managerfields","description":"The manager fields to update"}},"type":"object","required":["managerFields"],"title":"FormSubmissionPutRequest"},"FormSubmissionResponse":{"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."},"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."},"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","managerFields","answers","submissionStartTimestamp"],"title":"FormSubmissionResponse"},"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"},"FormYesNoOptionModel":{"properties":{"yesNoOptionId":{"type":"integer","title":"Yesnooptionid","description":"The answer option ID"},"text":{"type":"string","title":"Text","description":"The answer text"}},"type":"object","required":["yesNoOptionId","text"],"title":"FormYesNoOptionModel"},"FormsGetResponse":{"properties":{"forms":{"items":{"$ref":"#/components/schemas/FormResponse"},"type":"array","title":"Forms","description":"List of company's forms"}},"type":"object","required":["forms"],"title":"FormsGetResponse"},"FormsSubmissionGetResponse":{"properties":{"formSubmission":{"allOf":[{"$ref":"#/components/schemas/FormSubmissionResponse"}],"title":"Formsubmission","description":"The form submission."}},"type":"object","required":["formSubmission"],"title":"FormsSubmissionGetResponse"},"FormsSubmissionPutResponse":{"properties":{"formSubmission":{"items":{"$ref":"#/components/schemas/FormSubmissionResponse"},"type":"array","title":"Formsubmission","description":"A list of form submissions."}},"type":"object","required":["formSubmission"],"title":"FormsSubmissionPutResponse"},"FormsSubmissionsGetResponse":{"properties":{"formSubmissions":{"items":{"$ref":"#/components/schemas/FormSubmissionResponse"},"type":"array","title":"Formsubmissions","description":"A list of form submissions."}},"type":"object","required":["formSubmissions"],"title":"FormsSubmissionsGetResponse"},"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"},"FormulaQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["formula"],"title":"Questiontype","description":"The type of the question"},"formulaExpression":{"type":"string","title":"Formulaexpression","description":"The mathematical expression to calculate the result"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","formulaExpression"],"title":"FormulaQuestion"},"FromImageSelectionOptionModel":{"properties":{"imageSelectionOptionId":{"type":"string","title":"Imageselectionoptionid","description":"The answer selection option ID"},"text":{"type":"string","title":"Text","description":"The option text"},"image":{"type":"string","title":"Image","description":"The URL to the image"},"isDeleted":{"type":"boolean","title":"Isdeleted","description":"Indication if this option is deleted"}},"type":"object","required":["imageSelectionOptionId","text","image","isDeleted"],"title":"FromImageSelectionOptionModel"},"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"},"GeoFenceCreatedEntity":{"properties":{"fenceId":{"type":"string","title":"Fenceid","description":"Geo fence resource ID"},"name":{"type":"string","title":"Name","description":"Geo fence name"}},"type":"object","required":["fenceId","name"],"title":"GeoFenceCreatedEntity"},"GeoFenceEntity":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"The name of the geofence"},"isEnabled":{"type":"boolean","title":"Isenabled","description":"Indicates whether the geofence is enabled upon creation","default":true},"fenceSize":{"type":"integer","maximum":1524.0,"minimum":75.0,"title":"Fencesize","description":"The radius size (in meters) of the geofence. Must be a value between 75-1524 meters"},"jobIds":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Jobids","description":"List of job IDs to apply the geofence. If the job contains sub-jobs, pass only the parent job ID. If jobs are not required in the account settings, pass an empty array.(It is empty by default)"},"onGeofenceExitAction":{"allOf":[{"$ref":"#/components/schemas/ExitGeofenceAction"}],"description":"Determines the action to be made when a clocked in user exits a geofenced area.","default":"noAction"},"location":{"allOf":[{"$ref":"#/components/schemas/GpsLocation"}],"title":"Location","description":"The location of the geo fence"}},"type":"object","required":["name","location"],"title":"GeoFenceEntity"},"GeoFenceWithFenceIdEntity":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the geofence"},"name":{"type":"string","minLength":1,"title":"Name","description":"The name of the geofence"},"isEnabled":{"type":"boolean","title":"Isenabled","description":"Indicates whether the geofence is enabled upon creation","default":true},"fenceSize":{"type":"integer","maximum":1524.0,"minimum":75.0,"title":"Fencesize","description":"The radius size (in meters) of the geofence. Must be a value between 75-1524 meters"},"jobIds":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Jobids","description":"List of job IDs to apply the geofence. If the job contains sub-jobs, pass only the parent job ID. If jobs are not required in the account settings, pass an empty array.(It is empty by default)"},"onGeofenceExitAction":{"allOf":[{"$ref":"#/components/schemas/ExitGeofenceAction"}],"description":"Determines the action to be made when a clocked in user exits a geofenced area.","default":"noAction"},"location":{"allOf":[{"$ref":"#/components/schemas/GpsLocation"}],"title":"Location","description":"The location of the geo fence"}},"type":"object","required":["id","name","location"],"title":"GeoFenceWithFenceIdEntity"},"GeoFencesCreateRequest":{"properties":{"geofences":{"items":{"$ref":"#/components/schemas/GeoFenceEntity"},"type":"array","maxItems":1000,"title":"Geofences","description":"List of geo fences to create"}},"type":"object","required":["geofences"],"title":"GeoFencesCreateRequest"},"GeoFencesCreatedResponse":{"properties":{"geofences":{"items":{"$ref":"#/components/schemas/GeoFenceCreatedEntity"},"type":"array","title":"Geofences","description":"Geofences list"}},"type":"object","required":["geofences"],"title":"GeoFencesCreatedResponse"},"GeoFencesGetResponse":{"properties":{"geofences":{"items":{"$ref":"#/components/schemas/GeoFenceWithFenceIdEntity"},"type":"array","title":"Geofences","description":"Geofences list"}},"type":"object","required":["geofences"],"title":"GeoFencesGetResponse"},"GetCustomFieldsSettingsResponse":{"properties":{"customFields":{"items":{"anyOf":[{"$ref":"#/components/schemas/DropdownCustomFieldSettingsResponse"},{"$ref":"#/components/schemas/CustomFieldSettingsResponse"}]},"type":"array","title":"Customfields","description":"The custom fields."}},"type":"object","required":["customFields"],"title":"GetCustomFieldsSettingsResponse"},"GetDropdownOptionsResponse":{"properties":{"options":{"items":{"$ref":"#/components/schemas/v2__features__workflow__external_api__v1__form_dropdown_options__models__dropdown_options__DropdownOptionResponse"},"type":"array","title":"Options","description":"The dropdown options."}},"type":"object","required":["options"],"title":"GetDropdownOptionsResponse"},"GetFileURLResponse":{"properties":{"fileId":{"type":"string","title":"Fileid","description":"The unique identifier for the file"},"fileUrl":{"type":"string","maxLength":65536,"minLength":1,"format":"uri","title":"Fileurl","description":"The file URL"},"uploadCompleted":{"type":"boolean","title":"Uploadcompleted","description":"Indicates whether the upload process for the file has been successfully completed"},"fileType":{"type":"string","title":"Filetype","description":"The MIME type or format of the file"},"featureType":{"type":"string","title":"Featuretype","description":"Feature type"}},"type":"object","required":["fileId","uploadCompleted","fileType","featureType"],"title":"GetFileURLResponse"},"GetIndicatorsBaseResponse":{"properties":{"indicators":{"items":{"$ref":"#/components/schemas/IndicatorResponse"},"type":"array","title":"Indicators","description":"List of performance indicators"}},"type":"object","required":["indicators"],"title":"GetIndicatorsBaseResponse","description":"Base response model for getting indicators."},"GetPendingUsersResponse":{"properties":{"pendingUsers":{"items":{"$ref":"#/components/schemas/PendingUserDataResponse"},"type":"array","title":"Pendingusers","description":"List of pending user data"}},"type":"object","required":["pendingUsers"],"title":"GetPendingUsersResponse"},"GetResourceCustomFieldsSettingsResponse":{"properties":{"customFields":{"items":{"anyOf":[{"$ref":"#/components/schemas/DropdownResourceCustomFieldSettingsResponse"},{"$ref":"#/components/schemas/ResourceCustomFieldSettingsResponse"}]},"type":"array","title":"Customfields","description":"The resource custom fields."}},"type":"object","required":["customFields"],"title":"GetResourceCustomFieldsSettingsResponse"},"GetSchedulerShiftLayerValuesResponse":{"properties":{"values":{"items":{"$ref":"#/components/schemas/SchedulerShiftLayerValueOutput"},"type":"array","title":"Values","description":"The values associated to the shift layer"}},"type":"object","required":["values"],"title":"GetSchedulerShiftLayerValuesResponse"},"GetSchedulerShiftLayersResponse":{"properties":{"shiftLayers":{"items":{"$ref":"#/components/schemas/SchedulerShiftLayerOutput"},"type":"array","title":"Shiftlayers","description":"The various layers of information associated with shifts in this schedule"}},"type":"object","title":"GetSchedulerShiftLayersResponse"},"GetShiftCustomFieldsSettingsResponse":{"properties":{"customFields":{"items":{"anyOf":[{"$ref":"#/components/schemas/DropdownShiftCustomFieldSettingsResponse"},{"$ref":"#/components/schemas/ShiftCustomFieldSettingsResponse"}]},"type":"array","title":"Customfields","description":"The shift custom fields"}},"type":"object","required":["customFields"],"title":"GetShiftCustomFieldsSettingsResponse"},"GetSmartGroupsResponse":{"properties":{"groups":{"items":{"$ref":"#/components/schemas/SmartGroup"},"type":"array","title":"Groups","description":"The smart groups "}},"type":"object","required":["groups"],"title":"GetSmartGroupsResponse"},"GetTasksBoardsResponse":{"properties":{"taskBoards":{"items":{"$ref":"#/components/schemas/TasksBoard"},"type":"array","title":"Taskboards","description":"All tasks boards in your account"}},"type":"object","required":["taskBoards"],"title":"GetTasksBoardsResponse"},"GetUnavailabilitiesResponse":{"properties":{"userUnavailabilities":{"items":{"$ref":"#/components/schemas/UserUnavailabilityItem"},"type":"array","title":"Userunavailabilities","description":"List of users with unavailabilities"}},"type":"object","required":["userUnavailabilities"],"title":"GetUnavailabilitiesResponse"},"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.0,"minimum":-180.0,"description":"The longitude coordinate."},{"type":"null"}],"title":"Longitude","description":"The longitude coordinate."},"latitude":{"anyOf":[{"type":"number","maximum":90.0,"minimum":-90.0,"description":"The latitude coordinate."},{"type":"null"}],"title":"Latitude","description":"The latitude coordinate."}},"type":"object","title":"GpsDataV2"},"GpsLocation":{"properties":{"address":{"type":"string","title":"Address","description":"address"},"latitude":{"type":"string","title":"Latitude","description":"latitude, number format"},"longitude":{"type":"string","title":"Longitude","description":"longitude, number format"}},"type":"object","required":["address","latitude","longitude"],"title":"GpsLocation"},"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"},"GroupQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"questionType":{"type":"string","enum":["group"],"title":"Questiontype","description":"The type of the question"},"isAdditionalAnswersEnabled":{"type":"boolean","title":"Isadditionalanswersenabled","description":"Can you submit multiple answers of this group?","default":false},"questions":{"items":{"oneOf":[{"$ref":"#/components/schemas/MultipleChoiceQuestion"},{"$ref":"#/components/schemas/NumberQuestion"},{"$ref":"#/components/schemas/PhoneNumberQuestion"},{"$ref":"#/components/schemas/OpenEndedQuestion"},{"$ref":"#/components/schemas/EmailQuestion"},{"$ref":"#/components/schemas/YesNoQuestion"},{"$ref":"#/components/schemas/ImageSelectionQuestion"},{"$ref":"#/components/schemas/ImageQuestion"},{"$ref":"#/components/schemas/ScannerQuestion"},{"$ref":"#/components/schemas/LocationQuestion"},{"$ref":"#/components/schemas/AudioRecordingQuestion"},{"$ref":"#/components/schemas/VideoQuestion"},{"$ref":"#/components/schemas/TaskQuestion"},{"$ref":"#/components/schemas/DateQuestion"},{"$ref":"#/components/schemas/RatingQuestion"},{"$ref":"#/components/schemas/SignatureQuestion"},{"$ref":"#/components/schemas/FileQuestion"},{"$ref":"#/components/schemas/SliderQuestion"},{"$ref":"#/components/schemas/FormulaQuestion"},{"$ref":"#/components/schemas/DescriptionQuestion"}],"discriminator":{"propertyName":"questionType","mapping":{"multipleChoice":"#/components/schemas/MultipleChoiceQuestion","number":"#/components/schemas/NumberQuestion","phoneNumber":"#/components/schemas/PhoneNumberQuestion","openEnded":"#/components/schemas/OpenEndedQuestion","emailAddress":"#/components/schemas/EmailQuestion","yesNo":"#/components/schemas/YesNoQuestion","imageSelection":"#/components/schemas/ImageSelectionQuestion","image":"#/components/schemas/ImageQuestion","scanDocument":"#/components/schemas/ScannerQuestion","location":"#/components/schemas/LocationQuestion","audioRecording":"#/components/schemas/AudioRecordingQuestion","video":"#/components/schemas/VideoQuestion","task":"#/components/schemas/TaskQuestion","datetime":"#/components/schemas/DateQuestion","rating":"#/components/schemas/RatingQuestion","signature":"#/components/schemas/SignatureQuestion","files":"#/components/schemas/FileQuestion","slider":"#/components/schemas/SliderQuestion","formula":"#/components/schemas/FormulaQuestion","description":"#/components/schemas/DescriptionQuestion"}}},"type":"array","title":"Questions","description":"The questions that are in the group","default":[]}},"type":"object","required":["questionId","title","description","questionType"],"title":"GroupQuestion"},"HTMLDescription":{"properties":{"type":{"type":"string","title":"Type","description":"HTML note type","default":"html"},"html":{"type":"string","title":"Html","description":"The HTML content of the task"}},"type":"object","required":["html"],"title":"HTMLDescription"},"HTMLNoteData":{"properties":{"html":{"type":"string","title":"Html","description":"The HTML content of the note"}},"type":"object","required":["html"],"title":"HTMLNoteData"},"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"},"ImageAttachmentRequest":{"properties":{"type":{"type":"string","enum":["image"],"title":"Type","description":"The type of the attachment."},"fileId":{"type":"string","title":"Fileid","description":"The unique identifier of the image."}},"type":"object","required":["type","fileId"],"title":"ImageAttachmentRequest"},"ImageNoteDataOut":{"properties":{"url":{"type":"string","title":"Url","description":"The url of the file to upload"}},"type":"object","required":["url"],"title":"ImageNoteDataOut"},"ImageQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["image"],"title":"Questiontype","description":"The type of the question"},"isMultipleImageUploadAllowed":{"type":"boolean","title":"Ismultipleimageuploadallowed","description":"Indicates if multiple uploads is enabled"},"isCameraEnabled":{"type":"boolean","title":"Iscameraenabled","description":"Indicates if taking a picture through camera is enabled"},"isGalleryEnabled":{"type":"boolean","title":"Isgalleryenabled","description":"Indicates if choosing a picture through gallery is enabled"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","isMultipleImageUploadAllowed","isCameraEnabled","isGalleryEnabled"],"title":"ImageQuestion"},"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"},"ImageSelectionQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["imageSelection"],"title":"Questiontype","description":"The type of the question"},"isMultipleSelection":{"type":"boolean","title":"Ismultipleselection","description":"Indication if multiple selection is enabled"},"options":{"items":{"$ref":"#/components/schemas/FromImageSelectionOptionModel"},"type":"array","title":"Options","description":"List of image selection options"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","isMultipleSelection","options"],"title":"ImageSelectionQuestion"},"IndicatorResponse":{"properties":{"id":{"type":"integer","minimum":1.0,"title":"Id","description":"The unique identifier of the indicator"},"name":{"type":"string","title":"Name","description":"The name of the indicator"}},"type":"object","required":["id","name"],"title":"IndicatorResponse"},"InviteAdminsRequest":{"properties":{"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The unique identifier of the user to be promoted to admin"},"email":{"type":"string","title":"Email","description":"The email address of the user to be promoted. An invitation link will be sent to the specified email. Once the user acknowledges the email, the user will become an admin of the account."},"title":{"type":"string","title":"Title","description":"The title of the user to be promoted"}},"type":"object","required":["userId","email","title"],"title":"InviteAdminsRequest"},"JobCreateRequest":{"properties":{"instanceIds":{"items":{"type":"integer"},"type":"array","title":"Instanceids","description":"List of instance IDs (schedule id or time clock id)"},"title":{"type":"string","title":"Title","description":"The title of the job"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"The code of the job","default":""},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the job","default":""},"fenceSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fencesize","description":"The geofence size of the job"},"gps":{"anyOf":[{"$ref":"#/components/schemas/GpsDataV2"},{"type":"null"}],"description":"The GPS data of the job"},"assign":{"$ref":"#/components/schemas/AssignDataIn","description":"Settings related to job assignment"},"customFields":{"items":{"$ref":"#/components/schemas/BaseCustomFieldV2"},"type":"array","title":"Customfields","description":"The job's custom fields"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"The color associated with the job. Should be one of the following colors: ['#4B7AC5', '#801A1A', '#AE2121', '#DC7A7A', '#B0712E', '#D4985A', '#E4B37F', '#AE8E2D', '#CBA73A', '#D9B443', '#487037', '#6F9B5C', '#91B282', '#365C64', '#5687B3', '#7C9BA2', '#3968BB', '#85A6DA', '#225A8C', '#548CBE', '#81A8CC', '#4E3F75', '#604E8E', '#8679AA', '#983D73', '#A43778', '#D178AD', '#6B2E4C', '#925071', '#B57D9A', '#3a3a3a', '#616161', '#969696']","default":"#4B7AC5"},"subJobs":{"items":{"$ref":"#/components/schemas/SubJobCreateRequestInJob"},"type":"array","title":"Subjobs","description":"List of sub jobs to create"}},"type":"object","required":["title","instanceIds"],"title":"JobCreateRequest"},"JobResponse":{"properties":{"job":{"$ref":"#/components/schemas/BaseJobResponse","description":"The job"}},"type":"object","required":["job"],"title":"JobResponse"},"JobUpdateRequest":{"properties":{"title":{"type":"string","title":"Title","description":"The title of the job"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"The code of the job","default":""},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the job","default":""},"fenceSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fencesize","description":"The geofence size of the job"},"gps":{"anyOf":[{"$ref":"#/components/schemas/GpsDataV2"},{"type":"null"}],"description":"The GPS data of the job"},"assign":{"$ref":"#/components/schemas/AssignDataIn","description":"Settings related to job assignment"},"customFields":{"items":{"$ref":"#/components/schemas/BaseCustomFieldV2"},"type":"array","title":"Customfields","description":"The job's custom fields"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"The color associated with the job. Should be one of the following colors: ['#4B7AC5', '#801A1A', '#AE2121', '#DC7A7A', '#B0712E', '#D4985A', '#E4B37F', '#AE8E2D', '#CBA73A', '#D9B443', '#487037', '#6F9B5C', '#91B282', '#365C64', '#5687B3', '#7C9BA2', '#3968BB', '#85A6DA', '#225A8C', '#548CBE', '#81A8CC', '#4E3F75', '#604E8E', '#8679AA', '#983D73', '#A43778', '#D178AD', '#6B2E4C', '#925071', '#B57D9A', '#3a3a3a', '#616161', '#969696']","default":"#4B7AC5"},"instanceIds":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Instanceids","description":"List of instance ids (schedule id or time clock id) to assign the job to"}},"type":"object","required":["title"],"title":"JobUpdateRequest"},"JobsResponse":{"properties":{"jobs":{"items":{"$ref":"#/components/schemas/BaseJobResponse","description":"The job"},"type":"array","title":"Jobs","description":"The jobs"}},"type":"object","required":["jobs"],"title":"JobsResponse"},"JobsSortKeysExternal":{"type":"string","enum":["title"],"title":"JobsSortKeysExternal"},"LimitAdminsWhoCanEdit":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Indication if the limit of which admins can edit the Manager Field is enabled"},"directManagerPermitted":{"type":"boolean","title":"Directmanagerpermitted","description":"Indication if the direct manager of the user who submitted the form can edit the manager field"},"specificUsersEnabled":{"type":"boolean","title":"Specificusersenabled","description":"Indication if there are specific admins permitted to edit the manager field"},"adminsWhoCanEdit":{"items":{"type":"integer"},"type":"array","title":"Adminswhocanedit","description":"List of user IDs of admins that can change this Manager Field"}},"type":"object","required":["enabled","directManagerPermitted","specificUsersEnabled","adminsWhoCanEdit"],"title":"LimitAdminsWhoCanEdit"},"LimitEntriesPerUser":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Is total number of entries per user limit enabled"},"limitEntriesPerUser":{"type":"integer","title":"Limitentriesperuser","description":"The amount of entries that can be submitted per user"}},"type":"object","required":["enabled","limitEntriesPerUser"],"title":"LimitEntriesPerUser"},"LimitEntriesUntilTimestamp":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Is time limit until when entries can be submitted enabled"},"limitEntriesUntilTimestamp":{"type":"integer","title":"Limitentriesuntiltimestamp","description":"The time limit indicating until when entries can be submitted"}},"type":"object","required":["enabled","limitEntriesUntilTimestamp"],"title":"LimitEntriesUntilTimestamp"},"LimitTotalEntries":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Is total number of entries limit enabled"},"limitTotalEntries":{"type":"integer","title":"Limittotalentries","description":"The amount of entries that can be submitted"}},"type":"object","required":["enabled","limitTotalEntries"],"title":"LimitTotalEntries"},"Location":{"properties":{"id":{"type":"integer","title":"Id","description":"Unique identifier for the location"},"name":{"type":"string","title":"Name","description":"The location name"},"isActive":{"type":"boolean","title":"Isactive","description":"Indicates whether the location is active"}},"type":"object","required":["id","name","isActive"],"title":"Location"},"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"},"LocationQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["location"],"title":"Questiontype","description":"The type of the question"},"canSearchLocation":{"type":"boolean","title":"Cansearchlocation","description":"Indication if location search is enabled"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","canSearchLocation"],"title":"LocationQuestion"},"LocationRequest":{"properties":{"name":{"type":"string","title":"Name","description":"The location name"},"isActive":{"type":"boolean","title":"Isactive","description":"Indicates whether the location is active upon creation","default":true}},"type":"object","required":["name"],"title":"LocationRequest"},"LocationResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"Unique identifier for the location"},"name":{"type":"string","title":"Name","description":"The location name"},"isActive":{"type":"boolean","title":"Isactive","description":"Indicates whether the location is active"}},"type":"object","required":["id","name","isActive"],"title":"LocationResponse"},"LocationsGetResponse":{"properties":{"locations":{"items":{"$ref":"#/components/schemas/Location"},"type":"array","title":"Locations","description":"List of locations"}},"type":"object","required":["locations"],"title":"LocationsGetResponse"},"LockDaysPutRequest":{"properties":{"isLocked":{"type":"boolean","title":"Islocked","description":"Target lock state for the requested dates. true locks the dates (prevents further time-activity edits). false unlocks the dates. When omitted, defaults to true.","default":true},"dates":{"items":{"type":"string"},"type":"array","maxItems":50,"minItems":1,"title":"Dates","description":"Dates to update for this user, in YYYY-MM-DD format. Min 1 date, max 50 dates per request. Must be unique within the request."}},"type":"object","required":["dates"],"title":"LockDaysPutRequest"},"LockDaysPutResponse":{"properties":{"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The unique identifier of the user (echoed from the path)."},"isLocked":{"type":"boolean","title":"Islocked","description":"The state applied. Echoes the request value (true if locked, false if unlocked)."},"dates":{"items":{"type":"string"},"type":"array","title":"Dates","description":"Final state for the requested dates, in YYYY-MM-DD format. When isLocked is true, every date is now locked (including dates that were already locked). When isLocked is false, every date is now unlocked (including dates that were already unlocked)."}},"type":"object","required":["userId","isLocked","dates"],"title":"LockDaysPutResponse"},"LpidWithCoursesDisplayName":{"type":"string","enum":["quickTasks","events","quiz","knowledgeBase","updates","directory","timeClock","shiftscheduler","workflows","surveys","customize","suggestions","library","timeOff"],"title":"LpidWithCoursesDisplayName","description":"An enumeration."},"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"},"ManagerFieldDateRequest":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The manager field id"},"managerFieldType":{"type":"string","enum":["date"],"title":"Managerfieldtype","description":"The manager field type","default":"date"},"date":{"type":"string","title":"Date","description":"The date"}},"type":"object","required":["managerFieldId","date"],"title":"ManagerFieldDateRequest"},"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"},"ManagerFieldFileRequest":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The manager field id"},"managerFieldType":{"type":"string","enum":["file"],"title":"Managerfieldtype","description":"The manager field type","default":"file"},"files":{"items":{"$ref":"#/components/schemas/ManagerFieldFileModel"},"type":"array","title":"Files","description":"The files"}},"type":"object","required":["managerFieldId","files"],"title":"ManagerFieldFileRequest"},"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"},"ManagerFieldNoteRequest":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The manager field id"},"managerFieldType":{"type":"string","enum":["note"],"title":"Managerfieldtype","description":"The manager field type","default":"note"},"note":{"type":"string","title":"Note","description":"The note"}},"type":"object","required":["managerFieldId","note"],"title":"ManagerFieldNoteRequest"},"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"},"ManagerFieldOwnerRequest":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The manager field id"},"managerFieldType":{"type":"string","enum":["owner"],"title":"Managerfieldtype","description":"The manager field type","default":"owner"},"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The user id that is the value of the manager field"}},"type":"object","required":["managerFieldId","userId"],"title":"ManagerFieldOwnerRequest"},"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"},"ManagerFieldSignatureRequest":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The manager field id"},"managerFieldType":{"type":"string","enum":["signature"],"title":"Managerfieldtype","description":"The manager field type","default":"signature"},"image":{"type":"string","title":"Image","description":"The signature"},"signingUserId":{"type":"integer","minimum":1.0,"title":"Signinguserid","description":"The signing user id"},"signingTimestamp":{"type":"integer","minimum":1.0,"title":"Signingtimestamp","description":"The signing timestamp"}},"type":"object","required":["managerFieldId","image","signingUserId","signingTimestamp"],"title":"ManagerFieldSignatureRequest"},"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"},"ManagerFieldStatusRequest":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The manager field id"},"managerFieldType":{"type":"string","enum":["status"],"title":"Managerfieldtype","description":"The manager field type","default":"status"},"status":{"allOf":[{"$ref":"#/components/schemas/ManagerFieldStatusOption"}],"title":"Status","description":"The status"}},"type":"object","required":["managerFieldId","status"],"title":"ManagerFieldStatusRequest"},"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.0,"title":"Createdat","description":"The creation time of the time activity"},"modifiedAt":{"type":"integer","minimum":1.0,"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"},"ManualBreakClockInRequest":{"properties":{"userId":{"type":"integer","title":"Userid","description":"The unique identifier of the user. Make sure the user is assigned to the specified time clock."},"timezone":{"type":"string","title":"Timezone","description":"The timezone in Tz format (e.g. America/New_York). If not specified, the time clock's configured timezone is used."},"timestamp":{"type":"integer","minimum":1.0,"title":"Timestamp","description":"The break-start time in Unix format (in seconds). If omitted, the server captures the time when the request is received. Must be no more than 12 hours in the past and not in the future. Use to record a break that already started - typically when a physical clock device is flushing queued punches after recovering from offline mode."},"locationData":{"allOf":[{"$ref":"#/components/schemas/GpsData"}],"title":"Locationdata","description":"GPS data associated with the break start"}},"type":"object","required":["userId"],"title":"ManualBreakClockInRequest"},"ManualBreakClockInResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the break activity that was started"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeActivityTimePointResponse"}],"title":"Start","description":"The break start time recorded by the server"},"isSwitchFromShift":{"type":"boolean","title":"Isswitchfromshift","description":"true if an open shift was automatically closed to start this break; false if the employee was idle"},"closedShift":{"allOf":[{"$ref":"#/components/schemas/v2__features__punchclock__external_api__v1__time_clocks__models__shift_response__ShiftResponse"}],"title":"Closedshift","description":"The shift that was automatically closed to start this break. Present only when isSwitchFromShift is true."}},"type":"object","required":["id","start","isSwitchFromShift"],"title":"ManualBreakClockInResponse"},"ManualBreakClockOutRequest":{"properties":{"userId":{"type":"integer","title":"Userid","description":"The unique identifier of the user. Make sure the user is assigned to the specified time clock."},"timezone":{"type":"string","title":"Timezone","description":"The timezone in Tz format (e.g. America/New_York). If not specified, the time clock's configured timezone is used."},"timestamp":{"type":"integer","minimum":1.0,"title":"Timestamp","description":"The break-end time in Unix format (in seconds). If omitted, the server captures the time when the request is received. Must be no more than 12 hours in the past, not in the future, and after the open break's start time. For mandatory breaks, the elapsed time used for the early-return check is measured against this value."},"isResumeShift":{"type":"boolean","title":"Isresumeshift","description":"Controls what happens after the break ends. Defaults to true (mobile 'Return to job'). When true and the break was started from an open shift, the shift is re-opened on the same job. When the break is standalone, no shift is resumed. Set to false to end the break without resuming (mobile 'End shift'). The response returns the actual outcome, which may be false even when true was requested.","default":true},"locationData":{"allOf":[{"$ref":"#/components/schemas/GpsData"}],"title":"Locationdata","description":"GPS data associated with the break end"}},"type":"object","required":["userId"],"title":"ManualBreakClockOutRequest"},"ManualBreakClockOutResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the break activity that was ended"},"end":{"allOf":[{"$ref":"#/components/schemas/TimeActivityTimePointResponse"}],"title":"End","description":"The break end time recorded by the server"},"isResumeShift":{"type":"boolean","title":"Isresumeshift","description":"The actual outcome: true if a shift was re-opened after the break, false otherwise"},"resumedShift":{"allOf":[{"$ref":"#/components/schemas/v2__features__punchclock__external_api__v1__time_clocks__models__shift_response__ShiftResponse"}],"title":"Resumedshift","description":"The shift that was re-opened after the break ended. Present only when isResumeShift is true."}},"type":"object","required":["id","end","isResumeShift"],"title":"ManualBreakClockOutResponse"},"ManualBreakResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the manual break"},"name":{"type":"string","title":"Name","description":"The name of the manual break"},"isPaid":{"type":"boolean","title":"Ispaid","description":"Whether the manual break is paid"},"duration":{"type":"integer","title":"Duration","description":"The duration of the manual break in minutes"}},"type":"object","required":["id","name","isPaid","duration"],"title":"ManualBreakResponse"},"ManualBreaksGetResponse":{"properties":{"manualBreaks":{"items":{"$ref":"#/components/schemas/ManualBreakResponse"},"type":"array","title":"Manualbreaks","description":"The manual breaks"},"areManualBreaksEnabled":{"type":"boolean","title":"Aremanualbreaksenabled","description":"Whether manual breaks are enabled"}},"type":"object","required":["manualBreaks","areManualBreaksEnabled"],"title":"ManualBreaksGetResponse"},"MeResponse":{"properties":{"companyName":{"type":"string","title":"Companyname","description":"The name of the company"},"companyId":{"type":"string","title":"Companyid","description":"The unique identifier of the company"}},"type":"object","required":["companyName","companyId"],"title":"MeResponse"},"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"},"MultipleChoiceQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["multipleChoice"],"title":"Questiontype","description":"The type of the question"},"allAnswers":{"items":{"$ref":"#/components/schemas/FormMultipleChoiceOptionModel"},"type":"array","title":"Allanswers","description":"List of all the options, including deleted options"},"isMultipleSelect":{"type":"boolean","title":"Ismultipleselect","description":"Indication if multiple selection is enabled"},"displaySortedAnswers":{"type":"boolean","title":"Displaysortedanswers","description":"Indicates if display sorted answers is enabled"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","allAnswers","isMultipleSelect","displaySortedAnswers"],"title":"MultipleChoiceQuestion"},"NoteCreateRequest":{"properties":{"title":{"type":"string","title":"Title","description":"The title of the user note to be created"},"text":{"type":"string","maxLength":1000,"minLength":1,"title":"Text","description":"The text of the user note to be created"}},"type":"object","required":["text"],"title":"NoteCreateRequest"},"NoteCreateResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the note"},"title":{"type":"string","title":"Title","description":"The title of the note"},"text":{"type":"string","title":"Text","description":"Specifies the text content of the message. Must be in UTF-8 and less than 1000 characters."},"createdBy":{"type":"integer","title":"Createdby","description":"The user ID who created the note"},"modifiedBy":{"type":"integer","title":"Modifiedby","description":"The user ID who modified the note for the last time"},"createdAt":{"type":"integer","title":"Createdat","description":"The timestamp (in Unix) when the note was created"},"modifiedAt":{"type":"integer","title":"Modifiedat","description":"The timestamp (in Unix) when the note was recently modified"}},"type":"object","required":["id","text","createdBy","modifiedBy","createdAt","modifiedAt"],"title":"NoteCreateResponse"},"NoteManagerField":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The Manager Field's ID"},"name":{"type":"string","title":"Name","description":"The Manager Field's name"},"mobileUsersCanSee":{"type":"boolean","title":"Mobileuserscansee","description":"Indication if mobile users can see the Manager Field"},"mobileUsersNotifyWhenChanges":{"type":"boolean","title":"Mobileusersnotifywhenchanges","description":"Indication if mobile users will be notified if the Manager Field changes"},"adminsWhoCanEdit":{"allOf":[{"$ref":"#/components/schemas/LimitAdminsWhoCanEdit"}],"title":"Adminswhocanedit","description":" Limit the admins who can edit this manager field. Owners can always edit the manager field."},"managerFieldType":{"type":"string","enum":["note"],"title":"Managerfieldtype","description":"The Manager Field's type"}},"type":"object","required":["managerFieldId","name","mobileUsersCanSee","mobileUsersNotifyWhenChanges","adminsWhoCanEdit","managerFieldType"],"title":"NoteManagerField"},"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"},"NumberQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["number"],"title":"Questiontype","description":"The type of the question"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType"],"title":"NumberQuestion"},"OAuthTokenResponse":{"properties":{"access_token":{"type":"string","title":"Access Token","description":"The access token issued by the authorization server"},"token_type":{"type":"string","title":"Token Type","description":"The type of token issued (always 'bearer')"},"expires_in":{"type":"integer","title":"Expires In","description":"The lifetime in seconds of the access token"},"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope","description":"Space-separated list of scopes granted"}},"type":"object","required":["access_token","token_type","expires_in"],"title":"OAuthTokenResponse","description":"OAuth2 token response following RFC 6749.\nOverrides alias_generator to keep snake_case field names (not camelCase)."},"OnboardingStatus":{"enum":["in_progress","completed"],"title":"OnboardingStatus","description":"An enumeration."},"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"},"OpenEndedQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["openEnded"],"title":"Questiontype","description":"The type of the question"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType"],"title":"OpenEndedQuestion"},"OwnerManagerField":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The Manager Field's ID"},"name":{"type":"string","title":"Name","description":"The Manager Field's name"},"mobileUsersCanSee":{"type":"boolean","title":"Mobileuserscansee","description":"Indication if mobile users can see the Manager Field"},"mobileUsersNotifyWhenChanges":{"type":"boolean","title":"Mobileusersnotifywhenchanges","description":"Indication if mobile users will be notified if the Manager Field changes"},"adminsWhoCanEdit":{"allOf":[{"$ref":"#/components/schemas/LimitAdminsWhoCanEdit"}],"title":"Adminswhocanedit","description":" Limit the admins who can edit this manager field. Owners can always edit the manager field."},"managerFieldType":{"type":"string","enum":["owner"],"title":"Managerfieldtype","description":"The Manager Field's type"}},"type":"object","required":["managerFieldId","name","mobileUsersCanSee","mobileUsersNotifyWhenChanges","adminsWhoCanEdit","managerFieldType"],"title":"OwnerManagerField"},"PackResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"Pack ID"},"name":{"type":"string","title":"Name","description":"Pack name"},"description":{"type":"string","title":"Description","description":"Pack description"},"isDefault":{"type":"boolean","title":"Isdefault","description":"Whether this is the default pack"}},"type":"object","required":["id","name","isDefault"],"title":"PackResponse"},"PacksListResponse":{"properties":{"packs":{"items":{"$ref":"#/components/schemas/PackResponse"},"type":"array","title":"Packs","description":"List of onboarding packs"}},"type":"object","required":["packs"],"title":"PacksListResponse"},"PaginatedBaseResponseV2_GetSchedulerShiftLayerValuesResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetSchedulerShiftLayerValuesResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModelV2"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponseV2[GetSchedulerShiftLayerValuesResponse]"},"PaginatedBaseResponseV2_GetShiftCustomFieldsSettingsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetShiftCustomFieldsSettingsResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModelV2"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponseV2[GetShiftCustomFieldsSettingsResponse]"},"PaginatedBaseResponseV2_JobsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/JobsResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModelV2"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponseV2[JobsResponse]"},"PaginatedBaseResponseV2_ShiftBulkResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ShiftBulkResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModelV2"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponseV2[ShiftBulkResponse]"},"PaginatedBaseResponseV2_UnavailabilitiesListGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/UnavailabilitiesListGetResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModelV2"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponseV2[UnavailabilitiesListGetResponse]"},"PaginatedBaseResponseV2_WebhookListResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/WebhookListResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModelV2"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponseV2[WebhookListResponse]"},"PaginatedBaseResponse_ConversationsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/ConversationsResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[ConversationsResponse]"},"PaginatedBaseResponse_CustomFieldCategoriesResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/CustomFieldCategoriesResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[CustomFieldCategoriesResponse]"},"PaginatedBaseResponse_CustomFieldOptionsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/CustomFieldOptionsResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[CustomFieldOptionsResponse]"},"PaginatedBaseResponse_FormsGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/FormsGetResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[FormsGetResponse]"},"PaginatedBaseResponse_FormsSubmissionsGetResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/FormsSubmissionsGetResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[FormsSubmissionsGetResponse]"},"PaginatedBaseResponse_GetCustomFieldsSettingsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetCustomFieldsSettingsResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[GetCustomFieldsSettingsResponse]"},"PaginatedBaseResponse_GetDropdownOptionsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetDropdownOptionsResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[GetDropdownOptionsResponse]"},"PaginatedBaseResponse_GetIndicatorsBaseResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetIndicatorsBaseResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[GetIndicatorsBaseResponse]"},"PaginatedBaseResponse_GetResourceCustomFieldsSettingsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/GetResourceCustomFieldsSettingsResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[GetResourceCustomFieldsSettingsResponse]"},"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]"},"PaginatedBaseResponse_PublishersResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/PublishersResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[PublishersResponse]"},"PaginatedBaseResponse_SubTasksResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/SubTasksResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[SubTasksResponse]"},"PaginatedBaseResponse_TaskLabelsResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TaskLabelsResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[TaskLabelsResponse]"},"PaginatedBaseResponse_TasksResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TasksResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[TasksResponse]"},"PaginatedBaseResponse_TimeOffGetUserBalancesResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeOffGetUserBalancesResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[TimeOffGetUserBalancesResponse]"},"PaginatedBaseResponse_TimeOffRequestsListResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/TimeOffRequestsListResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[TimeOffRequestsListResponse]"},"PaginatedBaseResponse_UsersResponse_":{"properties":{"requestId":{"type":"string","title":"Requestid"},"data":{"$ref":"#/components/schemas/UsersResponse"},"paging":{"$ref":"#/components/schemas/PagingResponseModel"}},"type":"object","required":["data","paging"],"title":"PaginatedBaseResponse[UsersResponse]"},"PagingResponseModel":{"properties":{"offset":{"type":"integer","minimum":0.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.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"},"PagingResponseModelV2":{"properties":{"offset":{"type":"integer","minimum":0.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":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"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":"PagingResponseModelV2"},"PayItemResponse":{"properties":{"hours":{"type":"number","title":"Hours","description":"The number of hours worked"},"payRule":{"allOf":[{"$ref":"#/components/schemas/PayRuleResponse"}],"title":"Payrule","description":"The pay rule information"},"actualPayRate":{"type":"number","title":"Actualpayrate","description":"The actual pay rate applied"},"totalPay":{"type":"number","title":"Totalpay","description":"The total pay for the shift"}},"type":"object","required":["hours","payRule"],"title":"PayItemResponse"},"PayRateByUserRequest":{"properties":{"userId":{"type":"integer","title":"Userid","description":"The unique identifier of the user to create/update pay rate for"},"payRate":{"allOf":[{"$ref":"#/components/schemas/PayRateRequest"}],"title":"Payrate","description":"Pay rate configuration for this user"}},"type":"object","required":["userId","payRate"],"title":"PayRateByUserRequest"},"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"},"PayRateDeleteResponse":{"properties":{"success":{"type":"boolean","title":"Success","description":"Indicates whether the deletion was successful"}},"type":"object","required":["success"],"title":"PayRateDeleteResponse"},"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"},"PayRatePutResponse":{"properties":{"payRatesByUsers":{"items":{"$ref":"#/components/schemas/PayRateByUserResponse"},"type":"array","title":"Payratesbyusers","description":"Array of user records with their updated pay rate configurations"}},"type":"object","required":["payRatesByUsers"],"title":"PayRatePutResponse"},"PayRateRequest":{"properties":{"effectiveDate":{"type":"string","title":"Effectivedate","description":"The date this pay rate becomes effective (YYYY-MM-DD). Cannot be on or before any approved/locked timesheet days for this user"},"rateType":{"allOf":[{"$ref":"#/components/schemas/WageTypesEnum"}],"description":"Type of rate: hourly, monthly, or yearly"},"isDefaultRateEnabled":{"type":"boolean","title":"Isdefaultrateenabled","description":"Whether to enable the default rate","default":true},"defaultRate":{"type":"number","minimum":0.0,"title":"Defaultrate","description":"The default rate amount. Must be >= 0 ($0 is allowed for unpaid/volunteer work). Required when isDefaultRateEnabled is true"},"isResourceRateEnabled":{"type":"boolean","title":"Isresourcerateenabled","description":"Whether to enable resource-specific rates","default":false},"isApplyDefaultRateToNewResource":{"type":"boolean","title":"Isapplydefaultratetonewresource","description":"Auto-apply default rate to new resources and parent rate to new sub-resources","default":true},"resourcesRates":{"items":{"$ref":"#/components/schemas/ResourceRateRequest"},"type":"array","title":"Resourcesrates","description":"Array of resource-specific rate configurations. Include ALL resources that should have custom rates"}},"type":"object","required":["effectiveDate","rateType"],"title":"PayRateRequest"},"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"},"PayRatesPutRequest":{"properties":{"payRatesByUsers":{"items":{"$ref":"#/components/schemas/PayRateByUserRequest"},"type":"array","maxItems":500,"title":"Payratesbyusers","description":"Array of user pay rate configurations. Max 500 users per request"}},"type":"object","required":["payRatesByUsers"],"title":"PayRatesPutRequest"},"PayRuleAssignmentRequest":{"properties":{"userId":{"type":"integer","title":"Userid","description":"The unique identifier of the user"},"effectiveDate":{"type":"string","format":"date","title":"Effectivedate","description":"The date for the policy to take effect, specified in ISO 8601 format (e.g., 2025-01-25)"}},"type":"object","required":["userId","effectiveDate"],"title":"PayRuleAssignmentRequest"},"PayRuleAssignmentResponse":{"properties":{"assignmentId":{"type":"integer","title":"Assignmentid","description":"The unique identifier of the assignment record"}},"type":"object","required":["assignmentId"],"title":"PayRuleAssignmentResponse"},"PayRulePoliciesResponse":{"properties":{"payRulesPolicies":{"items":{"$ref":"#/components/schemas/PayRulePolicy"},"type":"array","title":"Payrulespolicies","description":"List of company pay rule policies"}},"type":"object","required":["payRulesPolicies"],"title":"PayRulePoliciesResponse"},"PayRulePolicy":{"properties":{"id":{"type":"integer","title":"Id","description":"The pay rule policy id"},"name":{"type":"string","title":"Name","description":"The pay rule policy name"}},"type":"object","required":["id","name"],"title":"PayRulePolicy"},"PayRuleResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the pay rule"},"code":{"type":"string","title":"Code","description":"The code of the pay rule"},"type":{"type":"string","title":"Type","description":"The type of the pay rule"}},"type":"object","required":["id","code","type"],"title":"PayRuleResponse"},"PayslipCreateRequest":{"properties":{"fileId":{"type":"string","title":"Fileid","description":"The unique identifier of the payslip attachment"},"startDate":{"type":"string","title":"Startdate","description":"The start date for the payslip in ISO 8601 format (YYYY-MM-DD)"},"endDate":{"type":"string","title":"Enddate","description":"The end date for the payslip in ISO 8601 format (YYYY-MM-DD)"}},"type":"object","required":["fileId","startDate","endDate"],"title":"PayslipCreateRequest","description":"Request model for creating a payslip"},"PayslipCreateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the created payslip"}},"type":"object","required":["id"],"title":"PayslipCreateResponse","description":"Response model for payslip creation"},"PendingUserDataResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"Pending user request ID"},"userFields":{"type":"object","title":"Userfields","description":"User profile fields submitted with the request"},"rawFields":{"type":"object","title":"Rawfields","description":"Raw unprocessed fields from the source"},"source":{"type":"string","title":"Source","description":"Origin source of the pending user request"},"sourceIcon":{"type":"string","title":"Sourceicon","description":"Icon representing the request source"},"userId":{"type":"integer","title":"Userid","description":"Associated user ID if the request was approved"},"externalUserId":{"type":"string","title":"Externaluserid","description":"External system user identifier"},"suggestedUserId":{"type":"integer","title":"Suggesteduserid","description":"Suggested matching user ID"},"integrationId":{"type":"integer","title":"Integrationid","description":"Integration that created this request"},"linkId":{"type":"integer","title":"Linkid","description":"Invite link ID associated with this request"},"status":{"type":"string","title":"Status","description":"Current status of the pending user request"}},"type":"object","required":["id","userFields","status"],"title":"PendingUserDataResponse"},"PendingUserRequest":{"properties":{"firstName":{"type":"string","maxLength":100,"title":"Firstname","description":"The user's first name"},"lastName":{"type":"string","maxLength":100,"title":"Lastname","description":"The user's last name"},"phoneNumber":{"type":"string","title":"Phonenumber","description":"The user's phone number"},"email":{"type":"string","title":"Email","description":"The user's email (mandatory for managers and owners)"},"customFields":{"items":{"$ref":"#/components/schemas/BaseCustomField"},"type":"array","title":"Customfields","description":"The user's custom fields","default":[]},"rawFields":{"type":"object","title":"Rawfields","description":"The user's raw fields"},"linkId":{"type":"integer","title":"Linkid","description":"The id of the invite link"},"source":{"type":"string","title":"Source","description":"The source of the user"},"userId":{"type":"integer","title":"Userid","description":"Connecteam user id of the user"},"suggestedUserId":{"type":"integer","title":"Suggesteduserid","description":"Connecteam user id of the user for the admin to match"},"sourceIcon":{"type":"string","title":"Sourceicon","description":"The icon of the external system if users come from integration"},"externalUserId":{"type":"string","title":"Externaluserid","description":"The user ID from external system"},"integrationId":{"type":"integer","title":"Integrationid","description":"The integration ID from the integration service"},"extraFields":{"type":"object","title":"Extrafields","description":"Extra fields from integration"},"profilePictureFileId":{"type":"string","title":"Profilepicturefileid","description":"The file ID obtained from the upload attachment endpoint (POST /attachments/v1/files/generate-upload-url) with featureType set to 'users'. The file must be finalized via the complete-upload endpoint before use."}},"type":"object","required":["firstName","lastName"],"title":"PendingUserRequest"},"PendingUserStatusRequest":{"properties":{"id":{"type":"integer","title":"Id","description":"Join request ID"},"status":{"allOf":[{"$ref":"#/components/schemas/UserJoinRequestStatus"}],"description":"New status for the pending user"}},"type":"object","required":["id","status"],"title":"PendingUserStatusRequest"},"PendingUsersRequest":{"properties":{"users":{"items":{"$ref":"#/components/schemas/PendingUserRequest"},"type":"array","title":"Users","description":"list of pending users"}},"type":"object","required":["users"],"title":"PendingUsersRequest"},"PendingUsersResponse":{"properties":{"ids":{"items":{"type":"integer"},"type":"array","title":"Ids","description":"new pending users"}},"type":"object","required":["ids"],"title":"PendingUsersResponse","description":"Response model for creating user pending requests."},"PerformanceDataRequest":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PerformanceDataValue"},"type":"array","title":"Items","description":"List of performance data values to update"}},"type":"object","required":["items"],"title":"PerformanceDataRequest","description":"Request model for updating performance data."},"PerformanceDataValue":{"properties":{"indicatorId":{"type":"integer","minimum":1.0,"title":"Indicatorid","description":"ID of the performance indicator/metric"},"value":{"type":"number","title":"Value","description":"Value for the performance indicator/metric"}},"type":"object","required":["indicatorId","value"],"title":"PerformanceDataValue","description":"Model for a single performance data value."},"PerformanceUpdateResponse":{"properties":{"recordsAffected":{"type":"integer","title":"Recordsaffected","description":"Number of records affected by the update operation"}},"type":"object","required":["recordsAffected"],"title":"PerformanceUpdateResponse","description":"Response model for performance data update endpoint."},"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"},"PhoneNumberQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["phoneNumber"],"title":"Questiontype","description":"The type of the question"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType"],"title":"PhoneNumberQuestion"},"PolicyUnitsEnum":{"type":"string","enum":["hours","days"],"title":"PolicyUnitsEnum","description":"An enumeration."},"ProjectedSalesUpdateItem":{"properties":{"date":{"type":"string","title":"Date","description":"Calendar date to update, in ISO 8601 format (YYYY-MM-DD)."},"projectedSales":{"type":"number","title":"Projectedsales","description":"Projected sales total for the day. Replaces any existing projected value for that date."}},"type":"object","required":["date","projectedSales"],"title":"ProjectedSalesUpdateItem"},"ProjectedSalesUpdateRequest":{"properties":{"updates":{"items":{"$ref":"#/components/schemas/ProjectedSalesUpdateItem"},"type":"array","minItems":1,"title":"Updates","description":"List of projected sales updates for this location. Minimum one item. Each date may appear only once in the request."}},"type":"object","required":["updates"],"title":"ProjectedSalesUpdateRequest"},"ProjectedSalesUpdateResponse":{"properties":{"daysAffected":{"type":"integer","title":"Daysaffected","description":"Number of days successfully updated in this request."},"updatedDays":{"items":{"$ref":"#/components/schemas/DailySalesEntry"},"type":"array","title":"Updateddays","description":"List of daily sales entries after the update, one per date in the request."}},"type":"object","required":["daysAffected","updatedDays"],"title":"ProjectedSalesUpdateResponse"},"PublicBaseWebhookResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the webhook"},"name":{"type":"string","title":"Name","description":"The name of the webhook"},"userId":{"type":"integer","title":"Userid","description":"Webhook creator's user id"},"timeCreated":{"type":"integer","title":"Timecreated","description":"The timestamp when the webhook was created"},"url":{"type":"string","minLength":1,"format":"uri","title":"Url","description":"The webhook's URL"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"The webhook's disabled status"},"featureType":{"type":"string","title":"Featuretype","description":"The webhook's feature type"},"entityId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entityid","description":"The webhook's entity id as a string. `null` for broadcast webhooks."},"objectId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Objectid","description":"Deprecated. The legacy numeric object id for this webhook.","deprecated":true},"retryLimit":{"type":"integer","title":"Retrylimit","description":"The webhook's retry limit"},"eventTypes":{"items":{"type":"string"},"type":"array","title":"Eventtypes","description":"The webhook's event types"},"webhookVersion":{"type":"integer","title":"Webhookversion","description":"The version of the webhook payload schema","default":1}},"type":"object","required":["id","name","userId","timeCreated","url","isDisabled","featureType","retryLimit","eventTypes"],"title":"PublicBaseWebhookResponse"},"PublisherResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the publisher"},"name":{"type":"string","title":"Name","description":"The name of the publisher"},"imageUrl":{"type":"string","title":"Imageurl","description":"The image url of the publisher"}},"type":"object","required":["id","name","imageUrl"],"title":"PublisherResponse"},"PublishersResponse":{"properties":{"publishers":{"items":{"$ref":"#/components/schemas/PublisherResponse"},"type":"array","title":"Publishers","description":"The list of publishers"}},"type":"object","required":["publishers"],"title":"PublishersResponse"},"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"},"RatingQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["rating"],"title":"Questiontype","description":"The type of the question"},"minValue":{"type":"integer","title":"Minvalue","description":"Minimum rating value"},"maxValue":{"type":"integer","title":"Maxvalue","description":"Maximum rating value"},"minValueText":{"type":"string","title":"Minvaluetext","description":"Minimum rating value text"},"maxValueText":{"type":"string","title":"Maxvaluetext","description":"Maximum rating value text"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","minValue","maxValue","minValueText","maxValueText"],"title":"RatingQuestion"},"ResourceCustomFieldSettingsResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The resource custom field id"},"name":{"type":"string","maxLength":100,"title":"Name","description":"The name of the custom field"},"isRequired":{"type":"boolean","title":"Isrequired","description":"Indicates whether the custom field is required"},"categoryId":{"type":"integer","title":"Categoryid","description":"The unique identifier of the custom field category"},"isVisibleToAllAdmins":{"type":"boolean","title":"Isvisibletoalladmins","description":"Indicates whether the custom field is visible to all admins"},"viewAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Viewaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to view this custom field, owners can always see all custom fields.\nApplicable only to custom fields that are not visible to all admins."},"isEditableForAllAdmins":{"type":"boolean","title":"Iseditableforalladmins","description":"Indicates whether the custom field is editable by all admins"},"editAccessAdminIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Editaccessadminids","description":"A list of unique identifiers of the admins who will be granted access to edit this custom field, owners can always edit all custom fields.\nApplicable only to custom fields that are not editable by all admins."},"isVisibleToUsers":{"type":"boolean","title":"Isvisibletousers","description":"Indicates whether the custom field is visible to users"},"isEditableForUsers":{"type":"boolean","title":"Iseditableforusers","description":"Indicates whether the custom field is editable by users.\nApplicable only to custom fields that are visible to users."},"type":{"allOf":[{"$ref":"#/components/schemas/UserCustomFields"}],"description":"The type of the custom field: Text, Phone number, Dropdown."}},"type":"object","required":["name","isRequired","isVisibleToAllAdmins","isEditableForAllAdmins","isVisibleToUsers","isEditableForUsers","id","type"],"title":"ResourceCustomFieldSettingsResponse"},"ResourceCustomFields":{"type":"string","enum":["str","phone","dropdown"],"title":"ResourceCustomFields","description":"An enumeration."},"ResourceCustomFieldsSortExternal":{"type":"string","enum":["name","type"],"title":"ResourceCustomFieldsSortExternal","description":"An enumeration."},"ResourceRateRequest":{"properties":{"resourceId":{"type":"string","title":"Resourceid","description":"The unique identifier of the resource"},"rate":{"type":"number","minimum":0.0,"title":"Rate","description":"The rate amount for this resource. Must be >= 0 ($0 is allowed for unpaid work)"},"useDefaultRate":{"type":"boolean","title":"Usedefaultrate","description":"Use default rate instead of resource-specific rate. When true, the rate field is not required","default":false},"subResourcesRates":{"items":{"$ref":"#/components/schemas/SubResourceRateRequest"},"type":"array","title":"Subresourcesrates","description":"Array of sub-resource rate configurations"}},"type":"object","required":["resourceId"],"title":"ResourceRateRequest"},"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"},"ResourceResponse":{"properties":{"resourceId":{"type":"string","title":"Resourceid","description":"The unique identifier of the resource/job"},"subResourceId":{"type":"string","title":"Subresourceid","description":"The unique identifier of the sub resource/job"}},"type":"object","title":"ResourceResponse"},"ResponseTask":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the task"},"userIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Userids","description":"List of user IDs to assign the task to. If more than one user ID is specified, it will be treated as a group task. To assign the task to multiple users individually, separate the requests. If this field remains empty the status field must be 'draft' and not archived."},"status":{"allOf":[{"$ref":"#/components/schemas/TaskStatus"}],"description":"The status of the task"},"title":{"type":"string","title":"Title","description":"The title of the task"},"startTime":{"type":"integer","title":"Starttime","description":"The start time of the task in Unix format (in seconds)"},"dueDate":{"type":"integer","title":"Duedate","description":"The due date of the task in Unix format (in seconds)"},"labelIds":{"items":{"type":"string"},"type":"array","title":"Labelids","description":"List of labels IDs associated with the task"},"type":{"allOf":[{"$ref":"#/components/schemas/TaskType"}],"description":"The type of the task. Currently set to 'oneTime' by default.","default":"oneTime"},"isArchived":{"type":"boolean","title":"Isarchived","description":"Indicates if the task is archived","default":false},"subTasks":{"items":{"$ref":"#/components/schemas/SubTaskResponse"},"type":"array","title":"Subtasks","description":"List of subtasks associated with the task"},"description":{"items":{"$ref":"#/components/schemas/HTMLDescription"},"type":"array","title":"Description","description":"The description of the task"}},"type":"object","required":["userIds","status","title","subTasks","id","description"],"title":"ResponseTask","description":"Response model for task data that includes the task ID"},"SaleType":{"type":"string","enum":["SALE","VOID","RECALL","REFUND","SPLIT","UPDATE","TRANSFER","FLOAT","TRANSITORY","CROSS_BL","CANCEL","MANUAL"],"title":"SaleType","description":"An enumeration."},"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"},"ScannerQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["scanDocument"],"title":"Questiontype","description":"The type of the question"},"isMultipleImageUploadAllowed":{"type":"boolean","title":"Ismultipleimageuploadallowed","description":"Indicates if multiple uploads is enabled"},"isCameraEnabled":{"type":"boolean","title":"Iscameraenabled","description":"Indicates if taking a picture through camera is enabled"},"isGalleryEnabled":{"type":"boolean","title":"Isgalleryenabled","description":"Indicates if choosing a picture through gallery is enabled"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","isMultipleImageUploadAllowed","isCameraEnabled","isGalleryEnabled"],"title":"ScannerQuestion"},"ScheduledShiftDetailResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the planned/scheduled shift"}},"type":"object","required":["id"],"title":"ScheduledShiftDetailResponse"},"SchedulerResponse":{"properties":{"schedulerId":{"type":"integer","minimum":1.0,"title":"Schedulerid","description":"The unique identifier of the schedule"},"name":{"type":"string","title":"Name","description":"The name of the schedule"},"isArchived":{"type":"boolean","title":"Isarchived","description":"Indicates whether the schedule is archived"},"timezone":{"type":"string","title":"Timezone","description":"The timezone of the schedule in Tz format"}},"type":"object","required":["schedulerId","name","isArchived","timezone"],"title":"SchedulerResponse"},"SchedulerShiftLayerOutput":{"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"}},"type":"object","required":["id","title"],"title":"SchedulerShiftLayerOutput"},"SchedulerShiftLayerValueOutput":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the shift layer instance"},"displayName":{"type":"string","title":"Displayname","description":"The display name of the shift layer instance"}},"type":"object","required":["id","displayName"],"title":"SchedulerShiftLayerValueOutput"},"SchedulerUnavailabilityResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the unavailability"},"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The ID of the user to which the unavailability is assigned"},"isAllDay":{"type":"boolean","title":"Isallday","description":"Whether the unavailability is for the entire day"},"unavailabilityDate":{"type":"string","title":"Unavailabilitydate","description":"The date of the unavailability in ISO format (YYYY-MM-DD)"},"startTime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starttime","description":"The start time of the unavailability in ISO format (HH:MM:SS)"},"endTime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endtime","description":"The end time of the unavailability in ISO format (HH:MM:SS)"},"timezone":{"type":"string","title":"Timezone","description":"The timezone of the unavailability in Tz format (e.g. America/New_York)"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Optional note with additional details about the unavailability"}},"type":"object","required":["id","userId","isAllDay","unavailabilityDate","timezone"],"title":"SchedulerUnavailabilityResponse"},"SchedulersResponse":{"properties":{"schedulers":{"items":{"$ref":"#/components/schemas/SchedulerResponse"},"type":"array","title":"Schedulers","description":"The schedules"}},"type":"object","required":["schedulers"],"title":"SchedulersResponse"},"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.0,"title":"Createdat","description":"The creation time of the time activity"},"modifiedAt":{"type":"integer","minimum":1.0,"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"},"ShiftAttachmentDropDownListItemSettingsResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the dropdown list item"},"name":{"type":"string","title":"Name","description":"The name of the dropdown list item"},"isEnabled":{"type":"boolean","title":"Isenabled","description":"Whether the dropdown list item is enabled"}},"type":"object","required":["id","name","isEnabled"],"title":"ShiftAttachmentDropDownListItemSettingsResponse"},"ShiftAttachmentDropDownListSettingsResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the shift attachment"},"type":{"allOf":[{"$ref":"#/components/schemas/ShiftAttachmentType"}],"description":"The type of the shift attachment"},"name":{"type":"string","title":"Name","description":"The name of the shift attachment"},"isRequired":{"type":"boolean","title":"Isrequired","description":"Whether the shift attachment is required"},"isEnabled":{"type":"boolean","title":"Isenabled","description":"Whether the shift attachment is enabled"},"items":{"items":{"$ref":"#/components/schemas/ShiftAttachmentDropDownListItemSettingsResponse"},"type":"array","title":"Items","description":"The dropdown list items"}},"type":"object","required":["id","type","name","isRequired","isEnabled","items"],"title":"ShiftAttachmentDropDownListSettingsResponse"},"ShiftAttachmentSettingsResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the shift attachment"},"type":{"allOf":[{"$ref":"#/components/schemas/ShiftAttachmentType"}],"description":"The type of the shift attachment"},"name":{"type":"string","title":"Name","description":"The name of the shift attachment"},"isRequired":{"type":"boolean","title":"Isrequired","description":"Whether the shift attachment is required"},"isEnabled":{"type":"boolean","title":"Isenabled","description":"Whether the shift attachment is enabled"}},"type":"object","required":["id","type","name","isRequired","isEnabled"],"title":"ShiftAttachmentSettingsResponse"},"ShiftAttachmentType":{"type":"string","enum":["freeText","dropdownList","number","image","file","signature"],"title":"ShiftAttachmentType","description":"An enumeration."},"ShiftAttachmentsGetResponse":{"properties":{"shiftAttachments":{"items":{"anyOf":[{"$ref":"#/components/schemas/ShiftAttachmentDropDownListSettingsResponse"},{"$ref":"#/components/schemas/ShiftAttachmentSettingsResponse"}]},"type":"array","title":"Shiftattachments","description":"The shift attachments"}},"type":"object","required":["shiftAttachments"],"title":"ShiftAttachmentsGetResponse"},"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.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.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"},"ShiftBulkDeleteRequest":{"properties":{"shiftsIds":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Shiftsids","description":"The unique identifiers of the shifts to delete"}},"type":"object","required":["shiftsIds"],"title":"ShiftBulkDeleteRequest"},"ShiftBulkDeleteResponse":{"properties":{"shiftsIds":{"items":{"type":"string"},"type":"array","title":"Shiftsids","description":"The IDs of the deleted shifts"}},"type":"object","required":["shiftsIds"],"title":"ShiftBulkDeleteResponse"},"ShiftBulkResponse":{"properties":{"shifts":{"items":{"$ref":"#/components/schemas/v2__features__shiftscheduler__external_api__v1__schedulers__scheduler__shifts__models__shift_response__ShiftResponse"},"type":"array","title":"Shifts","description":"The shifts"}},"type":"object","required":["shifts"],"title":"ShiftBulkResponse"},"ShiftCreateBreakDataApi":{"properties":{"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.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.0,"title":"Duration","description":"The time the break lasts in minutes"}},"type":"object","required":["name","type","duration"],"title":"ShiftCreateBreakDataApi"},"ShiftCreateRequest":{"properties":{"startTime":{"type":"integer","minimum":1.0,"title":"Starttime","description":"The start time of the shift in Unix format (in seconds)"},"endTime":{"type":"integer","minimum":1.0,"title":"Endtime","description":"The end time of the shift in Unix format (in seconds)"},"isOpenShift":{"type":"boolean","title":"Isopenshift","description":"Indicates whether the shift is an open shift. Creates only with 1 open spot","default":false},"openSpots":{"anyOf":[{"type":"integer","minimum":0.0,"description":"Integer with minimum value of 0"},{"type":"null"}],"title":"Openspots","description":"The number of open spots for the shift. Can only be set for open shifts."},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","description":"The timezone of the shift in Tz format (e.g. America/New_York). If not specified, it uses the timezone configured in the app settings"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The title of the shift, If this field remains empty, the jobId field must be specified."},"isPublished":{"type":"boolean","title":"Ispublished","description":"Indicates whether the shift is published","default":false},"jobId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobid","description":"The ID of the associated job"},"locationData":{"anyOf":[{"$ref":"#/components/schemas/LocationDataAPI"},{"type":"null"}],"description":"The location data for the shift"},"isRequireAdminApproval":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isrequireadminapproval","description":"Indicates whether admin approval is required for claiming the shift. Can only be set if the shift is an open shift"},"assignedUserIds":{"items":{"type":"integer","minimum":1.0,"description":"Integer with minimum value of 1"},"type":"array","title":"Assigneduserids","description":"The list of assigned user IDs for the shift. When vision is enabled, multiple user IDs can be specified. Otherwise, only one user ID can be specified. If the shift is open, this list should remain empty."},"notes":{"items":{"$ref":"#/components/schemas/HTMLNoteData"},"type":"array","title":"Notes","description":"Additional notes for the shift"},"statuses":{"items":{"$ref":"#/components/schemas/StatusDataCreate"},"type":"array","title":"Statuses","description":"The list of statuses associated with the shift"},"breaks":{"items":{"$ref":"#/components/schemas/ShiftCreateBreakDataApi"},"type":"array","title":"Breaks","description":"A list of breaks to create for the shift"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"The color associated with the shift, defaults to the color of the job linked to the shift. If a specific color is provided, it will override the default job color. Defaults to #4B7AC5. Should be one of the following colors: ['#4B7AC5', '#801A1A', '#AE2121', '#DC7A7A', '#B0712E', '#D4985A', '#E4B37F', '#AE8E2D', '#CBA73A', '#D9B443', '#487037', '#6F9B5C', '#91B282', '#365C64', '#5687B3', '#7C9BA2', '#3968BB', '#85A6DA', '#225A8C', '#548CBE', '#81A8CC', '#4E3F75', '#604E8E', '#8679AA', '#983D73', '#A43778', '#D178AD', '#6B2E4C', '#925071', '#B57D9A', '#3a3a3a', '#616161', '#969696']"},"shiftDetails":{"anyOf":[{"$ref":"#/components/schemas/ShiftDetailsInput"},{"type":"null"}],"description":"The additional details on the shift, if applicable."},"customFields":{"items":{"$ref":"#/components/schemas/BaseCustomFieldV2"},"type":"array","title":"Customfields","description":"Custom field values for the shift"}},"type":"object","required":["startTime","endTime"],"title":"ShiftCreateRequest"},"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.0,"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"},"ShiftCustomFieldSettingsResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The shift custom field id"},"name":{"type":"string","title":"Name","description":"The name of the custom field"},"type":{"$ref":"#/components/schemas/ShiftCustomFields","description":"The type of the custom field: String or Dropdown"}},"type":"object","required":["id","name","type"],"title":"ShiftCustomFieldSettingsResponse"},"ShiftCustomFields":{"type":"string","enum":["str","dropdown"],"title":"ShiftCustomFields"},"ShiftDeleteResponse":{"properties":{"shiftId":{"type":"string","title":"Shiftid","description":"The ID of the deleted shift"}},"type":"object","required":["shiftId"],"title":"ShiftDeleteResponse"},"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.0,"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"},"ShiftDetailsInput":{"properties":{"shiftLayers":{"items":{"$ref":"#/components/schemas/ShiftLayerInput"},"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":"ShiftDetailsInput"},"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"},"ShiftEntryResponse":{"properties":{"timeActivityId":{"type":"string","title":"Timeactivityid","description":"The unique identifier of the time activity"},"start":{"allOf":[{"$ref":"#/components/schemas/StartTimeResponse"}],"title":"Start","description":"The start time of the shift"},"end":{"allOf":[{"$ref":"#/components/schemas/EndTimeResponse"}],"title":"End","description":"The end time of the shift"},"basePayRate":{"type":"number","title":"Basepayrate","description":"The base pay rate for the shift"},"resources":{"items":{"$ref":"#/components/schemas/ResourceResponse"},"type":"array","title":"Resources","description":"The resources assigned to this entry"}},"type":"object","required":["timeActivityId","start","end","resources"],"title":"ShiftEntryResponse"},"ShiftLayerInput":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the shift layer"},"value":{"$ref":"#/components/schemas/ShiftLayerInstanceInput","description":"The value of the shift layer"}},"type":"object","required":["id","value"],"title":"ShiftLayerInput"},"ShiftLayerInstanceInput":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the value"}},"type":"object","required":["id"],"title":"ShiftLayerInstanceInput"},"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"},"ShiftUpdateBreakDataApi":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"The unique identifier of the break. If this field is left empty, a new break will be created"},"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.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.0,"title":"Duration","description":"The time the break lasts in minutes"}},"type":"object","required":["name","type","duration"],"title":"ShiftUpdateBreakDataApi"},"ShiftUpdateBulkResponse":{"properties":{"shifts":{"items":{"$ref":"#/components/schemas/v2__features__shiftscheduler__external_api__v1__schedulers__scheduler__shifts__models__shift_response__ShiftResponse"},"type":"array","title":"Shifts","description":"The shifts"},"deletedShiftIds":{"items":{"type":"string"},"type":"array","title":"Deletedshiftids","description":"The IDs of the shifts that were deleted during the update operation"},"createdShifts":{"items":{"$ref":"#/components/schemas/v2__features__shiftscheduler__external_api__v1__schedulers__scheduler__shifts__models__shift_response__ShiftResponse"},"type":"array","title":"Createdshifts","description":"The shifts that were created during the update operation"}},"type":"object","required":["shifts"],"title":"ShiftUpdateBulkResponse"},"ShiftUpdateRequest":{"properties":{"shiftId":{"type":"string","title":"Shiftid","description":"The unique identifier of the shift"},"startTime":{"anyOf":[{"type":"integer","minimum":1.0,"description":"Integer with minimum value of 1"},{"type":"null"}],"title":"Starttime","description":"The start time of the shift in Unix format (in seconds)"},"endTime":{"anyOf":[{"type":"integer","minimum":1.0,"description":"Integer with minimum value of 1"},{"type":"null"}],"title":"Endtime","description":"The end time of the shift in Unix format (in seconds)"},"isOpenShift":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isopenshift","description":"Indicates whether the shift is an open shift. Creates only with 1 open spot"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","description":"The timezone in Tz format (e.g. America/New_York)"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The title of the shift"},"isPublished":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ispublished","description":"Indicates whether the shift is published"},"jobId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobid","description":"The ID of the associated job"},"locationData":{"anyOf":[{"$ref":"#/components/schemas/LocationDataAPI"},{"type":"null"}],"description":"The location data for the shift"},"isRequireAdminApproval":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isrequireadminapproval","description":"Indicates whether admin approval is required for the shift. Can only be set if the shift is an open shift"},"assignedUserIds":{"anyOf":[{"items":{"type":"integer","minimum":1.0,"description":"Integer with minimum value of 1"},"type":"array"},{"type":"null"}],"title":"Assigneduserids","description":"The list of assigned user IDs for the shift. Required for V2 Vision targeted base/group edits when isEditForAllUsers is explicitly false. When vision is enabled, multiple user IDs can be specified. Otherwise, only one user ID can be specified."},"notes":{"anyOf":[{"items":{"$ref":"#/components/schemas/HTMLNoteData"},"type":"array"},{"type":"null"}],"title":"Notes","description":"Additional notes for the shift"},"breaks":{"anyOf":[{"items":{"$ref":"#/components/schemas/ShiftUpdateBreakDataApi"},"type":"array"},{"type":"null"}],"title":"Breaks","description":"The list of breaks for the shift"},"isEditForAllUsers":{"type":"boolean","title":"Iseditforallusers","description":"Indicates whether the update should be applied to all users assigned to the shift","default":false},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"The color associated with the shift. Should be one of the following colors: ['#4B7AC5', '#801A1A', '#AE2121', '#DC7A7A', '#B0712E', '#D4985A', '#E4B37F', '#AE8E2D', '#CBA73A', '#D9B443', '#487037', '#6F9B5C', '#91B282', '#365C64', '#5687B3', '#7C9BA2', '#3968BB', '#85A6DA', '#225A8C', '#548CBE', '#81A8CC', '#4E3F75', '#604E8E', '#8679AA', '#983D73', '#A43778', '#D178AD', '#6B2E4C', '#925071', '#B57D9A', '#3a3a3a', '#616161', '#969696']"},"openSpots":{"anyOf":[{"type":"integer","minimum":0.0,"description":"Integer with minimum value of 0"},{"type":"null"}],"title":"Openspots","description":"The number of open spots for the shift. Can only be set for open shifts."},"customFields":{"anyOf":[{"items":{"$ref":"#/components/schemas/BaseCustomFieldV2"},"type":"array"},{"type":"null"}],"title":"Customfields","description":"Custom field values for the shift"}},"type":"object","required":["shiftId"],"title":"ShiftUpdateRequest"},"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.0,"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"},"ShiftsSortKeysExternal":{"type":"string","enum":["created_at","updated_at"],"title":"ShiftsSortKeysExternal"},"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"},"SignatureManagerField":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The Manager Field's ID"},"name":{"type":"string","title":"Name","description":"The Manager Field's name"},"mobileUsersCanSee":{"type":"boolean","title":"Mobileuserscansee","description":"Indication if mobile users can see the Manager Field"},"mobileUsersNotifyWhenChanges":{"type":"boolean","title":"Mobileusersnotifywhenchanges","description":"Indication if mobile users will be notified if the Manager Field changes"},"adminsWhoCanEdit":{"allOf":[{"$ref":"#/components/schemas/LimitAdminsWhoCanEdit"}],"title":"Adminswhocanedit","description":" Limit the admins who can edit this manager field. Owners can always edit the manager field."},"managerFieldType":{"type":"string","enum":["signature"],"title":"Managerfieldtype","description":"The Manager Field's type"}},"type":"object","required":["managerFieldId","name","mobileUsersCanSee","mobileUsersNotifyWhenChanges","adminsWhoCanEdit","managerFieldType"],"title":"SignatureManagerField"},"SignatureQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["signature"],"title":"Questiontype","description":"The type of the question"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType"],"title":"SignatureQuestion"},"SingleAbsence":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"The unique identifier of the unavailability"},"type":{"$ref":"#/components/schemas/AbsenceType","description":"The type of the unavailability"},"startTime":{"$ref":"#/components/schemas/TimestampWithTimezone","description":"The start time of the unavailability"},"endTime":{"$ref":"#/components/schemas/TimestampWithTimezone","description":"The end time of the unavailability"},"note":{"type":"string","title":"Note","description":"The note of the unavailability"},"policyName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Policyname","description":"The name of the policy (applicable only when unavailability type is timeOff)"},"instanceId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Instanceid","description":"The schedule id of the unavailability (applicable only when unavailability type is unavailability)"}},"type":"object","required":["type","startTime","endTime","note"],"title":"SingleAbsence"},"SingleShift":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the shift"},"startTime":{"$ref":"#/components/schemas/TimestampWithTimezone","description":"The start time of the shift"},"endTime":{"$ref":"#/components/schemas/TimestampWithTimezone","description":"The end time of the shift"},"instanceId":{"type":"integer","title":"Instanceid","description":"The unique identifier of the schedule instance"}},"type":"object","required":["id","startTime","endTime","instanceId"],"title":"SingleShift"},"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"},"SliderQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["slider"],"title":"Questiontype","description":"The type of the question"},"minValue":{"type":"integer","title":"Minvalue","description":"Minimum value in slider"},"maxValue":{"type":"integer","title":"Maxvalue","description":"Maximum value in slider"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","minValue","maxValue"],"title":"SliderQuestion"},"SmartGroup":{"properties":{"id":{"type":"integer","minimum":1.0,"title":"Id","description":"The unique identifier of the smart group"},"name":{"type":"string","title":"Name","description":"The name of the smart group"},"description":{"type":"string","title":"Description","description":"The description of the smart group"},"groupSegmentId":{"type":"integer","title":"Groupsegmentid","description":"The ID of the group segment this smart group belongs to"},"numberOfUsers":{"type":"integer","title":"Numberofusers","description":"The total number of users in the group (excluding admins)"},"isAutomaticallyCreated":{"type":"boolean","title":"Isautomaticallycreated","description":"Whether this smart group is automatically created and system-managed: generated from a dropdown custom field that has its 'create a group per option' setting turned on. Automatically created groups cannot be edited or deleted directly — their name and membership are owned by the field and its options. Change them by editing the source custom field instead.","default":false},"adminUserIds":{"items":{"type":"integer"},"type":"array","title":"Adminuserids","description":"User IDs of admins who can administer this group — every active owner plus every manager with an explicit per-cohort authorization. Populated only when the request includes the internal include_admin_user_ids flag; otherwise null."}},"type":"object","required":["id","name","groupSegmentId","numberOfUsers"],"title":"SmartGroup"},"SmartGroupCreateRequest":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the smart group"},"description":{"type":"string","title":"Description","description":"Description of the smart group"},"groupSegmentId":{"type":"integer","title":"Groupsegmentid","description":"The ID of the group segment this smart group belongs to"},"filters":{"allOf":[{"$ref":"#/components/schemas/SmartGroupFilters"}],"title":"Filters","description":"Filters to apply to the smart group"}},"type":"object","required":["name","groupSegmentId","filters"],"title":"SmartGroupCreateRequest"},"SmartGroupCreateResponse":{"properties":{"id":{"type":"integer","minimum":1.0,"title":"Id","description":"The unique identifier of the smart group"},"name":{"type":"string","title":"Name","description":"The name of the smart group"},"description":{"type":"string","title":"Description","description":"The description of the smart group"},"groupSegmentId":{"type":"integer","title":"Groupsegmentid","description":"The ID of the group segment this smart group belongs to"},"numberOfUsers":{"type":"integer","title":"Numberofusers","description":"The total number of users in the group (excluding admins)"},"isAutomaticallyCreated":{"type":"boolean","title":"Isautomaticallycreated","description":"Whether this smart group is automatically created and system-managed: generated from a dropdown custom field that has its 'create a group per option' setting turned on. Automatically created groups cannot be edited or deleted directly — their name and membership are owned by the field and its options. Change them by editing the source custom field instead.","default":false},"adminUserIds":{"items":{"type":"integer"},"type":"array","title":"Adminuserids","description":"User IDs of admins who can administer this group — every active owner plus every manager with an explicit per-cohort authorization. Populated only when the request includes the internal include_admin_user_ids flag; otherwise null."}},"type":"object","required":["id","name","groupSegmentId","numberOfUsers"],"title":"SmartGroupCreateResponse"},"SmartGroupFilterOperator":{"type":"string","enum":["and","or"],"title":"SmartGroupFilterOperator","description":"An enumeration."},"SmartGroupFilters":{"properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/SmartGroupFilterOperator"}],"description":"Select whether to use the 'and' or 'or' operator to determine how matching criteria are applied.","default":"and"},"dropdownFilters":{"items":{"$ref":"#/components/schemas/DropdownFilter"},"type":"array","title":"Dropdownfilters","description":"Dropdown custom field filters"}},"type":"object","title":"SmartGroupFilters"},"SmartGroupInstance":{"properties":{"id":{"type":"string","title":"Id","description":"Smart group id"}},"type":"object","required":["id"],"title":"SmartGroupInstance"},"SmartGroupSegment":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the smart group segment"},"name":{"type":"string","title":"Name","description":"The name of the smart group segment"},"color":{"type":"string","title":"Color","description":"The color hex code of the smart group segment"},"sortOrder":{"type":"integer","title":"Sortorder","description":"The sort order of the smart group segment"}},"type":"object","required":["id","name","color","sortOrder"],"title":"SmartGroupSegment"},"SmartGroupSegmentCreateRequest":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the smart group segment"},"color":{"type":"string","title":"Color","description":"The color hex code for the smart group segment (e.g. #ff5722)"}},"type":"object","required":["name","color"],"title":"SmartGroupSegmentCreateRequest"},"SmartGroupSegmentCreateResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the smart group segment"},"name":{"type":"string","title":"Name","description":"The name of the smart group segment"},"color":{"type":"string","title":"Color","description":"The color hex code of the smart group segment"},"sortOrder":{"type":"integer","title":"Sortorder","description":"The sort order of the smart group segment"}},"type":"object","required":["id","name","color","sortOrder"],"title":"SmartGroupSegmentCreateResponse"},"SmartGroupSegmentsResponse":{"properties":{"segments":{"items":{"$ref":"#/components/schemas/SmartGroupSegment"},"type":"array","title":"Segments","description":"List of smart group segments"}},"type":"object","required":["segments"],"title":"SmartGroupSegmentsResponse"},"SmartGroupUpdateRequest":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the smart group"},"description":{"type":"string","title":"Description","description":"Description of the smart group"},"groupSegmentId":{"type":"integer","title":"Groupsegmentid","description":"The ID of the group segment this smart group belongs to"},"filters":{"allOf":[{"$ref":"#/components/schemas/SmartGroupFilters"}],"title":"Filters","description":"Filters to apply to the smart group"}},"type":"object","title":"SmartGroupUpdateRequest"},"SmartGroupUpdateResponse":{"properties":{"id":{"type":"integer","minimum":1.0,"title":"Id","description":"The unique identifier of the smart group"},"name":{"type":"string","title":"Name","description":"The name of the smart group"},"description":{"type":"string","title":"Description","description":"The description of the smart group"},"groupSegmentId":{"type":"integer","title":"Groupsegmentid","description":"The ID of the group segment this smart group belongs to"},"numberOfUsers":{"type":"integer","title":"Numberofusers","description":"The total number of users in the group (excluding admins)"},"isAutomaticallyCreated":{"type":"boolean","title":"Isautomaticallycreated","description":"Whether this smart group is automatically created and system-managed: generated from a dropdown custom field that has its 'create a group per option' setting turned on. Automatically created groups cannot be edited or deleted directly — their name and membership are owned by the field and its options. Change them by editing the source custom field instead.","default":false},"adminUserIds":{"items":{"type":"integer"},"type":"array","title":"Adminuserids","description":"User IDs of admins who can administer this group — every active owner plus every manager with an explicit per-cohort authorization. Populated only when the request includes the internal include_admin_user_ids flag; otherwise null."}},"type":"object","required":["id","name","groupSegmentId","numberOfUsers"],"title":"SmartGroupUpdateResponse"},"SortOrder":{"type":"string","enum":["asc","desc"],"title":"SortOrder"},"StartTimeResponse":{"properties":{"timestamp":{"type":"integer","minimum":1.0,"title":"Timestamp","description":"The start time of the shift"},"timezone":{"type":"string","title":"Timezone","description":"The timezone of the shift"},"locationData":{"allOf":[{"$ref":"#/components/schemas/GpsData"}],"title":"Locationdata","description":"The location data"},"source":{"allOf":[{"$ref":"#/components/schemas/PunchSourceResponse"}],"title":"Source","description":"Describes the origin from which the punch was created"}},"type":"object","title":"StartTimeResponse"},"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"},"StatusDataCreate":{"properties":{"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"The note of the status"},"gps":{"anyOf":[{"$ref":"#/components/schemas/GpsDataV2"},{"type":"null"}],"description":"The GPS data of the status"},"shouldOverridePreviousStatuses":{"type":"boolean","title":"Shouldoverridepreviousstatuses","description":"Indicates whether to override previous statuses","default":true}},"type":"object","title":"StatusDataCreate"},"StatusManagerField":{"properties":{"managerFieldId":{"type":"string","title":"Managerfieldid","description":"The Manager Field's ID"},"name":{"type":"string","title":"Name","description":"The Manager Field's name"},"mobileUsersCanSee":{"type":"boolean","title":"Mobileuserscansee","description":"Indication if mobile users can see the Manager Field"},"mobileUsersNotifyWhenChanges":{"type":"boolean","title":"Mobileusersnotifywhenchanges","description":"Indication if mobile users will be notified if the Manager Field changes"},"adminsWhoCanEdit":{"allOf":[{"$ref":"#/components/schemas/LimitAdminsWhoCanEdit"}],"title":"Adminswhocanedit","description":" Limit the admins who can edit this manager field. Owners can always edit the manager field."},"managerFieldType":{"type":"string","enum":["status"],"title":"Managerfieldtype","description":"The Manager Field's type"},"statuses":{"items":{"$ref":"#/components/schemas/v2__features__workflow__external_api__v1__models__forms_models__ManagerFieldStatus"},"type":"array","title":"Statuses","description":"List of Manager Field's possible statuses"}},"type":"object","required":["managerFieldId","name","mobileUsersCanSee","mobileUsersNotifyWhenChanges","adminsWhoCanEdit","managerFieldType","statuses"],"title":"StatusManagerField"},"StatusTypesAPI":{"type":"string","enum":["accepted","checked_in","completed","rejected","claimed","claim_requested","unclaimed","unclaim_requested","cancel_claim_request","reset"],"title":"StatusTypesAPI"},"SubJobCreateRequest":{"properties":{"title":{"type":"string","title":"Title","description":"The title of the job"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"The code of the job","default":""},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the job","default":""},"fenceSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fencesize","description":"The geofence size of the job"},"gps":{"anyOf":[{"$ref":"#/components/schemas/GpsDataV2"},{"type":"null"}],"description":"The GPS data of the job"},"assign":{"anyOf":[{"$ref":"#/components/schemas/AssignDataIn"},{"type":"null"}],"description":"Data related to job assignment"},"customFields":{"items":{"$ref":"#/components/schemas/BaseCustomFieldV2"},"type":"array","title":"Customfields","description":"The job's custom fields"},"parentId":{"type":"string","title":"Parentid","description":"The ID of the parent job"},"useParentData":{"type":"boolean","title":"Useparentdata","description":"Indicates whether to use the parent job's data or not","default":true}},"type":"object","required":["title","parentId"],"title":"SubJobCreateRequest"},"SubJobCreateRequestInJob":{"properties":{"title":{"type":"string","title":"Title","description":"The title of the job"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"The code of the job","default":""},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the job","default":""},"fenceSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fencesize","description":"The geofence size of the job"},"gps":{"anyOf":[{"$ref":"#/components/schemas/GpsDataV2"},{"type":"null"}],"description":"The GPS data of the job"},"assign":{"anyOf":[{"$ref":"#/components/schemas/AssignDataIn"},{"type":"null"}],"description":"Data related to job assignment"},"customFields":{"items":{"$ref":"#/components/schemas/BaseCustomFieldV2"},"type":"array","title":"Customfields","description":"The job's custom fields"},"useParentData":{"type":"boolean","title":"Useparentdata","description":"Indicates whether to use the parent job's data or not","default":true}},"type":"object","required":["title"],"title":"SubJobCreateRequestInJob"},"SubJobUpdateRequest":{"properties":{"title":{"type":"string","title":"Title","description":"The title of the job"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"The code of the job","default":""},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the job","default":""},"fenceSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fencesize","description":"The geofence size of the job"},"gps":{"anyOf":[{"$ref":"#/components/schemas/GpsDataV2"},{"type":"null"}],"description":"The GPS data of the job"},"assign":{"anyOf":[{"$ref":"#/components/schemas/AssignDataIn"},{"type":"null"}],"description":"Data related to job assignment"},"customFields":{"items":{"$ref":"#/components/schemas/BaseCustomFieldV2"},"type":"array","title":"Customfields","description":"The job's custom fields"},"parentId":{"type":"string","title":"Parentid","description":"The ID of the parent job, if any"},"useParentData":{"type":"boolean","title":"Useparentdata","description":"Indicates whether to use the parent job's data or not"}},"type":"object","required":["title","parentId","useParentData"],"title":"SubJobUpdateRequest"},"SubResourceRateRequest":{"properties":{"subResourceId":{"type":"string","title":"Subresourceid","description":"The unique identifier of the sub-resource"},"rate":{"type":"number","minimum":0.0,"title":"Rate","description":"The rate amount for this sub-resource. Must be >= 0 ($0 is allowed for unpaid work)"},"useParentRate":{"type":"boolean","title":"Useparentrate","description":"Inherit parent resource's rate. When true, the rate field is not required","default":false}},"type":"object","required":["subResourceId"],"title":"SubResourceRateRequest"},"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"},"SubTaskCreateRequest":{"properties":{"title":{"type":"string","title":"Title","description":"The title of the sub task"},"isCompleted":{"type":"boolean","title":"Iscompleted","description":"Indicates whether the status of the sub-task is set to completed.","default":false}},"type":"object","required":["title"],"title":"SubTaskCreateRequest"},"SubTaskCreateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the subtask"},"title":{"type":"string","title":"Title","description":"The title of the sub task"},"isCompleted":{"type":"boolean","title":"Iscompleted","description":"Indicates whether the status of the sub-task is set to completed."}},"type":"object","required":["id","title","isCompleted"],"title":"SubTaskCreateResponse"},"SubTaskDeleteResponse":{"properties":{},"type":"object","title":"SubTaskDeleteResponse"},"SubTaskRequest":{"properties":{"title":{"type":"string","title":"Title","description":"The title of the subtask"},"isCompleted":{"type":"boolean","title":"Iscompleted","description":"Whether the subtask is completed","default":false}},"type":"object","required":["title"],"title":"SubTaskRequest"},"SubTaskResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the subtask"},"title":{"type":"string","title":"Title","description":"The title of the subtask"},"isCompleted":{"type":"boolean","title":"Iscompleted","description":"Whether the subtask is completed"}},"type":"object","required":["id","title","isCompleted"],"title":"SubTaskResponse"},"SubTaskUpdateRequest":{"properties":{"title":{"type":"string","title":"Title","description":"The title of the sub task"},"isCompleted":{"type":"boolean","title":"Iscompleted","description":"Indicates whether the status of the sub-task is set to completed."}},"type":"object","title":"SubTaskUpdateRequest"},"SubTaskUpdateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the subtask"},"title":{"type":"string","title":"Title","description":"The title of the sub task"},"isCompleted":{"type":"boolean","title":"Iscompleted","description":"Indicates whether the status of the sub-task is set to completed."}},"type":"object","required":["id","title","isCompleted"],"title":"SubTaskUpdateResponse"},"SubTasksResponse":{"properties":{"subTasks":{"items":{"$ref":"#/components/schemas/SubTaskResponse"},"type":"array","title":"Subtasks","description":"List of sub tasks"}},"type":"object","required":["subTasks"],"title":"SubTasksResponse"},"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"},"TaskAttachment":{"properties":{"fileId":{"type":"string","title":"Fileid","description":"The unique identifier of the uploaded file."}},"type":"object","required":["fileId"],"title":"TaskAttachment"},"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"},"TaskDescription":{"properties":{"content":{"type":"string","title":"Content","description":"The content of the description. Must be in UTF-8 format."},"attachments":{"items":{"$ref":"#/components/schemas/TaskAttachment"},"type":"array","title":"Attachments","description":"Optional list of attachments for the task description."}},"type":"object","required":["content"],"title":"TaskDescription"},"TaskLabel":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the task label"},"name":{"type":"string","title":"Name","description":"The name of the task label"},"color":{"type":"string","title":"Color","description":"The color of the task label"}},"type":"object","required":["id","name","color"],"title":"TaskLabel"},"TaskLabelsResponse":{"properties":{"labels":{"items":{"$ref":"#/components/schemas/TaskLabel"},"type":"array","title":"Labels","description":"List of task labels"}},"type":"object","required":["labels"],"title":"TaskLabelsResponse"},"TaskQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["task"],"title":"Questiontype","description":"The type of the question"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType"],"title":"TaskQuestion"},"TaskStatus":{"type":"string","enum":["draft","published","completed"],"title":"TaskStatus","description":"An enumeration."},"TaskStatusFilter":{"type":"string","enum":["draft","published","completed","all"],"title":"TaskStatusFilter","description":"An enumeration."},"TaskType":{"type":"string","enum":["oneTime","recurring"],"title":"TaskType","description":"An enumeration."},"TasksBoard":{"properties":{"id":{"type":"integer","title":"Id","description":"The ID of the tasks board"},"name":{"type":"string","title":"Name","description":"The name of the tasks board"},"isArchived":{"type":"boolean","title":"Isarchived","description":"Whether the tasks board is archived"}},"type":"object","required":["id","name","isArchived"],"title":"TasksBoard"},"TasksResponse":{"properties":{"tasks":{"items":{"$ref":"#/components/schemas/ResponseTask"},"type":"array","title":"Tasks","description":"List of tasks"}},"type":"object","required":["tasks"],"title":"TasksResponse"},"TimeActivitiesCreateRequestList":{"properties":{"timeActivities":{"items":{"$ref":"#/components/schemas/UserTimeActivitiesCreateRequest"},"type":"array","maxItems":100,"title":"Timeactivities","description":"List of the time activities of the users"},"isSplitShiftOnManualBreak":{"type":"boolean","title":"Issplitshiftonmanualbreak","description":"When true, manual break creation splits any overlapping completed shift into two shifts around the break window, matching dashboard behavior. When false (default), existing shifts are unchanged.","default":false}},"type":"object","required":["timeActivities"],"title":"TimeActivitiesCreateRequestList"},"TimeActivitiesCreateResponse":{"properties":{"timeActivitiesByUsers":{"items":{"$ref":"#/components/schemas/UserTimeActivity"},"type":"array","title":"Timeactivitiesbyusers","description":"The time activities"}},"type":"object","required":["timeActivitiesByUsers"],"title":"TimeActivitiesCreateResponse"},"TimeActivitiesGetResponse":{"properties":{"timeActivitiesByUsers":{"items":{"$ref":"#/components/schemas/UserTimeActivity"},"type":"array","title":"Timeactivitiesbyusers","description":"The time activities"}},"type":"object","required":["timeActivitiesByUsers"],"title":"TimeActivitiesGetResponse"},"TimeActivitiesUpdateRequestList":{"properties":{"timeActivities":{"items":{"$ref":"#/components/schemas/UserTimeActivitiesUpdateRequest"},"type":"array","maxItems":100,"title":"Timeactivities","description":"List of time activities of the users"}},"type":"object","required":["timeActivities"],"title":"TimeActivitiesUpdateRequestList"},"TimeActivitiesUpdateResponse":{"properties":{"timeActivitiesByUsers":{"items":{"$ref":"#/components/schemas/UserTimeActivity"},"type":"array","title":"Timeactivitiesbyusers","description":"The time activities"}},"type":"object","required":["timeActivitiesByUsers"],"title":"TimeActivitiesUpdateResponse"},"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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.0,"title":"Userid","description":"The unique identifier of the user"},"timeClockId":{"type":"integer","minimum":1.0,"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"},"TimeActivityManualBreakCreateRequest":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the manual break"},"start":{"allOf":[{"$ref":"#/components/schemas/TimestampWithTimezoneRequest"}],"title":"Start","description":"The start time"},"end":{"allOf":[{"$ref":"#/components/schemas/TimestampWithTimezoneRequest"}],"title":"End","description":"The end time"},"employeeNote":{"type":"string","title":"Employeenote","description":"Employee note providing additional details"},"managerNote":{"type":"string","title":"Managernote","description":"Manager note providing additional details"}},"type":"object","required":["start","id"],"title":"TimeActivityManualBreakCreateRequest"},"TimeActivityManualBreakUpdateRequest":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the time activity associated with the time clock"},"start":{"allOf":[{"$ref":"#/components/schemas/TimestampWithTimezoneRequest"}],"title":"Start","description":"The start time of the time activity"},"end":{"allOf":[{"$ref":"#/components/schemas/TimestampWithTimezoneRequest"}],"title":"End","description":"The end time of the time activity"},"employeeNote":{"type":"string","title":"Employeenote","description":"Employee note providing additional details"},"managerNote":{"type":"string","title":"Managernote","description":"Manager note providing additional details"},"manualBreakId":{"type":"string","title":"Manualbreakid","description":"The manual break ID to associate with the break"}},"type":"object","required":["id"],"title":"TimeActivityManualBreakUpdateRequest"},"TimeActivityShiftCreateRequest":{"properties":{"start":{"allOf":[{"$ref":"#/components/schemas/TimestampWithTimezoneRequest"}],"title":"Start","description":"The start time"},"end":{"allOf":[{"$ref":"#/components/schemas/TimestampWithTimezoneRequest"}],"title":"End","description":"The end time"},"employeeNote":{"type":"string","title":"Employeenote","description":"Employee note providing additional details"},"managerNote":{"type":"string","title":"Managernote","description":"Manager note providing additional details"},"jobId":{"type":"string","title":"Jobid","description":"The job ID of the shift"},"subJobId":{"type":"string","title":"Subjobid","description":"The sub job ID of the shift. Required if sub jobs are defined under the specific job"}},"type":"object","required":["start"],"title":"TimeActivityShiftCreateRequest"},"TimeActivityShiftUpdateRequest":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the time activity associated with the time clock"},"start":{"allOf":[{"$ref":"#/components/schemas/TimestampWithTimezoneRequest"}],"title":"Start","description":"The start time of the time activity"},"end":{"allOf":[{"$ref":"#/components/schemas/TimestampWithTimezoneRequest"}],"title":"End","description":"The end time of the time activity"},"employeeNote":{"type":"string","title":"Employeenote","description":"Employee note providing additional details"},"managerNote":{"type":"string","title":"Managernote","description":"Manager note providing additional details"},"jobId":{"type":"string","title":"Jobid","description":"The job ID to associate with the shift (if the shift remains under the same job leave it empty)"},"subJobId":{"type":"string","title":"Subjobid","description":"The sub-job ID to associate with the job (if the sub-job remains under the same parent job update only the sub-job ID)"}},"type":"object","required":["id"],"title":"TimeActivityShiftUpdateRequest"},"TimeActivityTimePointResponse":{"properties":{"timestamp":{"type":"integer","minimum":1.0,"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"},"TimeActivityType":{"type":"string","enum":["shift","manual_break","time_off"],"title":"TimeActivityType","description":"An enumeration."},"TimeClock":{"properties":{"id":{"type":"integer","minimum":1.0,"title":"Id","description":"The ID of the time clock"},"name":{"type":"string","title":"Name","description":"The name of the time clock"},"isArchived":{"type":"boolean","title":"Isarchived","description":"Whether the time clock is archived"}},"type":"object","required":["id","name","isArchived"],"title":"TimeClock"},"TimeClocksResponse":{"properties":{"timeClocks":{"items":{"$ref":"#/components/schemas/TimeClock"},"type":"array","title":"Timeclocks","description":"The time clocks"}},"type":"object","required":["timeClocks"],"title":"TimeClocksResponse"},"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.0,"title":"Createdat","description":"The creation time of the time activity"},"modifiedAt":{"type":"integer","minimum":1.0,"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"},"TimeOffAssignPolicyRequest":{"properties":{"userId":{"type":"integer","title":"Userid","description":"The unique identifier of the user"},"balance":{"type":"number","title":"Balance","description":"The balance amount"},"unit":{"allOf":[{"$ref":"#/components/schemas/PolicyUnitsEnum"}],"description":"The unit (days/hours)"}},"type":"object","required":["userId"],"title":"TimeOffAssignPolicyRequest"},"TimeOffAssignPolicyResponse":{"properties":{},"type":"object","title":"TimeOffAssignPolicyResponse"},"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"},"TimeOffGetPolicyTypesResponse":{"properties":{"policyTypes":{"items":{"$ref":"#/components/schemas/TimeOffPolicyType"},"type":"array","title":"Policytypes","description":"List of the company policy types"}},"type":"object","required":["policyTypes"],"title":"TimeOffGetPolicyTypesResponse"},"TimeOffGetUserBalancesResponse":{"properties":{"balances":{"items":{"$ref":"#/components/schemas/TimeOffUserBalance"},"type":"array","title":"Balances","description":"List of user balances of the policy type"}},"type":"object","required":["balances"],"title":"TimeOffGetUserBalancesResponse"},"TimeOffPolicy":{"properties":{"id":{"type":"string","title":"Id","description":"The policy id"},"name":{"type":"string","title":"Name","description":"The policy name"},"unit":{"type":"string","title":"Unit","description":"The units for this policy (hours or days)"},"accrualType":{"type":"string","title":"Accrualtype","description":"The policy accrual type: fixed, hourly, or unlimited"}},"type":"object","required":["id","name","unit","accrualType"],"title":"TimeOffPolicy"},"TimeOffPolicyType":{"properties":{"id":{"type":"string","title":"Id","description":"The policy type id"},"name":{"type":"string","title":"Name","description":"The policy type name"},"policies":{"items":{"$ref":"#/components/schemas/TimeOffPolicy"},"type":"array","title":"Policies","description":"List of policies within this policy type"}},"type":"object","required":["id","name"],"title":"TimeOffPolicyType"},"TimeOffPutUserBalanceResponse":{"properties":{"balance":{"allOf":[{"$ref":"#/components/schemas/TimeOffUserBalance"}],"title":"Balance","description":"The updated user balance"}},"type":"object","required":["balance"],"title":"TimeOffPutUserBalanceResponse"},"TimeOffRequestCreateRequest":{"properties":{"timeClockId":{"type":"integer","title":"Timeclockid","description":"The unique identifier of the time clock where the time off will be presented in the timesheet"},"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The ID of the user to create the time off request"},"policyTypeId":{"type":"string","title":"Policytypeid","description":"The ID of the policy type"},"isAllDay":{"type":"boolean","title":"Isallday","description":"Specifies the type of the time period. Defaults to true. If set to false, start and end time fields must be specified."},"startDate":{"type":"string","title":"Startdate","description":"The start date of the time off in ISO format (YYYY-MM-DD)"},"endDate":{"type":"string","title":"Enddate","description":"The end time of the time off in ISO format (YYYY-MM-DD). End date must be similar to Start date if isAllDay set to false."},"startTime":{"type":"string","title":"Starttime","description":"The start time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false."},"endTime":{"type":"string","title":"Endtime","description":"The end time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false."},"timezone":{"type":"string","title":"Timezone","description":"The timezone in Tz format (e.g. America/New_York)"},"status":{"type":"string","enum":["approved","pending","denied"],"title":"Status","description":"The status of the time off request."},"employeeNote":{"type":"string","title":"Employeenote","description":"Employee note providing additional details","default":""},"managerNote":{"type":"string","title":"Managernote","description":"Manager note providing additional details","default":""},"isAdjustForDayLightSaving":{"type":"boolean","title":"Isadjustfordaylightsaving","description":"Specifies if the time given should offset the daylight savings time change if the time falls exactly on the daylight savings time change. Set to true only if the time coincides with the rollback hour, otherwise, it should remain false.","default":false}},"type":"object","required":["userId","policyTypeId","isAllDay","startDate","endDate","timezone","status"],"title":"TimeOffRequestCreateRequest"},"TimeOffRequestCreateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the time-off request."},"timeClockId":{"type":"integer","title":"Timeclockid","description":"The unique identifier of the time clock where the time off appears on the timesheet. Omitted when the request is not linked to a time clock."},"policyTypeId":{"type":"string","title":"Policytypeid","description":"The unique identifier of the time-off policy type."},"userId":{"type":"integer","title":"Userid","description":"The unique identifier of the employee the request belongs to."},"isAllDay":{"type":"boolean","title":"Isallday","description":"true if the request covers full days; false if it uses specific times."},"duration":{"allOf":[{"$ref":"#/components/schemas/TimeOffRequestDuration"}],"title":"Duration","description":"Amount of time deducted from balance for this request, expressed in the policy units (hours or days). Returned only for approved requests; omitted otherwise."},"startDate":{"type":"string","title":"Startdate","description":"Start date of the time off."},"endDate":{"type":"string","title":"Enddate","description":"End date of the time off."},"startTime":{"type":"string","title":"Starttime","description":"Start time of the time off."},"endTime":{"type":"string","title":"Endtime","description":"End time of the time off."},"timezone":{"type":"string","title":"Timezone","description":"Timezone of the request, e.g. America/New_York."},"status":{"type":"string","enum":["approved","pending","denied"],"title":"Status","description":"Request status: approved, pending, or denied."},"employeeNote":{"type":"string","title":"Employeenote","description":"Note added by the employee. Empty string when none.","default":""},"managerNote":{"type":"string","title":"Managernote","description":"Note added by the manager. Empty string when none.","default":""}},"type":"object","required":["id","policyTypeId","userId","isAllDay","startDate","endDate","startTime","endTime","timezone","status"],"title":"TimeOffRequestCreateResponse"},"TimeOffRequestDuration":{"properties":{"units":{"allOf":[{"$ref":"#/components/schemas/PolicyUnitsEnum"}],"description":"The unit the amount is expressed in, matching the policy type: hours or days."},"amount":{"type":"number","title":"Amount","description":"Amount of time deducted from balance for this request, expressed in the policy units. For all-day requests this reflects the policy work schedule per calendar day, not the start/end time span. This is the value stored when the request was approved."}},"type":"object","required":["units","amount"],"title":"TimeOffRequestDuration"},"TimeOffRequestUpdateRequest":{"properties":{"timeClockId":{"type":"integer","title":"Timeclockid","description":"The unique identifier of the time clock where the time off will be presented in the timesheet"},"isAllDay":{"type":"boolean","title":"Isallday","description":"Specifies the type of the time period. If set to false, start and end time fields must be specified."},"startDate":{"type":"string","title":"Startdate","description":"The start date of the time off in ISO format (YYYY-MM-DD)"},"endDate":{"type":"string","title":"Enddate","description":"The end time of the time off in ISO format (YYYY-MM-DD). End date must be similar to Start date if isAllDay set to false."},"startTime":{"type":"string","title":"Starttime","description":"The start time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false."},"endTime":{"type":"string","title":"Endtime","description":"The end time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false."},"timezone":{"type":"string","title":"Timezone","description":"The timezone in Tz format (e.g. America/New_York)"},"status":{"type":"string","enum":["approved","pending","denied"],"title":"Status","description":"The status of the time off request."},"managerNote":{"type":"string","title":"Managernote","description":"Manager note providing additional details"},"isAdjustForDayLightSaving":{"type":"boolean","title":"Isadjustfordaylightsaving","description":"Specifies if the time given should offset the daylight savings time change if the time falls exactly on the daylight savings time change. Set to true only if the time coincides with the rollback hour, otherwise, it should remain false."}},"additionalProperties":false,"type":"object","title":"TimeOffRequestUpdateRequest"},"TimeOffRequestUpdateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the time off request"},"timeClockId":{"type":"integer","title":"Timeclockid","description":"The unique identifier of the time clock where the time off will be presented in the timesheet"},"userId":{"type":"integer","title":"Userid","description":"The user id"},"isAllDay":{"type":"boolean","title":"Isallday","description":"Indicates whether the time off is for the entire day"},"startDate":{"type":"string","title":"Startdate","description":"The start date of the time off"},"endDate":{"type":"string","title":"Enddate","description":"The end date of the time off"},"startTime":{"type":"string","title":"Starttime","description":"The start time of the time off"},"endTime":{"type":"string","title":"Endtime","description":"The end time of the time off"},"timezone":{"type":"string","title":"Timezone","description":"The timezone of the time off"},"status":{"type":"string","enum":["approved","pending","denied"],"title":"Status","description":"The status of the time off"},"managerNote":{"type":"string","title":"Managernote","description":"The manager note of the time off"}},"type":"object","required":["id","userId","isAllDay","startDate","endDate","startTime","endTime","timezone","status"],"title":"TimeOffRequestUpdateResponse"},"TimeOffRequestsListResponse":{"properties":{"requests":{"items":{"$ref":"#/components/schemas/TimeOffRequestCreateResponse"},"type":"array","title":"Requests","description":"List of time-off requests matching the filters."}},"type":"object","required":["requests"],"title":"TimeOffRequestsListResponse"},"TimeOffUpdateUserBalanceRequest":{"properties":{"balance":{"type":"number","title":"Balance","description":"The balance to update to"}},"type":"object","required":["balance"],"title":"TimeOffUpdateUserBalanceRequest"},"TimeOffUserBalance":{"properties":{"userId":{"type":"integer","title":"Userid","description":"The user id"},"units":{"allOf":[{"$ref":"#/components/schemas/PolicyUnitsEnum"}],"description":"The user balance units"},"balance":{"type":"number","title":"Balance","description":"The remaining user balance"},"policyId":{"type":"string","title":"Policyid","description":"The id of the policy this balance belongs to"}},"type":"object","required":["userId","units","balance","policyId"],"title":"TimeOffUserBalance"},"TimesheetTotalHoursGetResponse":{"properties":{"startDate":{"type":"string","title":"Startdate","description":"The start date of the reporting period"},"endDate":{"type":"string","title":"Enddate","description":"The end date of the reporting period"},"users":{"items":{"$ref":"#/components/schemas/UserHoursSummaryResponse"},"type":"array","title":"Users","description":"The users and their hour summaries"}},"type":"object","required":["startDate","endDate","users"],"title":"TimesheetTotalHoursGetResponse"},"TimestampWithTimezone":{"properties":{"timestamp":{"type":"integer","minimum":1.0,"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"},"TimestampWithTimezoneRequest":{"properties":{"timestamp":{"type":"integer","minimum":1.0,"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":"TimestampWithTimezoneRequest"},"TransactionCreateItem":{"properties":{"locationId":{"type":"integer","title":"Locationid","description":"The unique identifier of the location"},"saleType":{"allOf":[{"$ref":"#/components/schemas/SaleType"}],"description":"The type of the sale. Current options are: SALE,VOID,REFUND,SPLIT,TRANSFER"},"createdAt":{"type":"integer","title":"Createdat","description":"The timestamp of the sale in UNIX format (UTC)"},"finalSaleAmount":{"type":"number","title":"Finalsaleamount","description":"The final sale amount of the transaction after discounts/changes and without applicable taxes"},"taxAmount":{"type":"number","title":"Taxamount","description":"The tax amount to be added in absolute number (not in percentage)"},"currency":{"type":"string","title":"Currency","description":"The currency of the transaction"}},"type":"object","required":["locationId","saleType","createdAt","finalSaleAmount"],"title":"TransactionCreateItem"},"TransactionCreateRequest":{"properties":{"transactionsCreateRequest":{"items":{"$ref":"#/components/schemas/TransactionCreateItem"},"type":"array","maxItems":100,"minItems":1,"title":"Transactionscreaterequest","description":"List of transactions to create"}},"type":"object","required":["transactionsCreateRequest"],"title":"TransactionCreateRequest"},"TransactionCreateResponse":{"properties":{"transactions":{"items":{"$ref":"#/components/schemas/TransactionData"},"type":"array","title":"Transactions","description":"List of created transactions"}},"type":"object","required":["transactions"],"title":"TransactionCreateResponse"},"TransactionData":{"properties":{"transactionId":{"type":"string","title":"Transactionid","description":"Unique identifier for the transaction"},"locationId":{"type":"integer","title":"Locationid","description":"The location ID derived from the locations API"},"saleType":{"allOf":[{"$ref":"#/components/schemas/SaleType"}],"description":"The type of the sale"},"createdAt":{"type":"integer","title":"Createdat","description":"The timestamp of the sale in UNIX format (UTC)"},"finalSaleAmount":{"type":"number","title":"Finalsaleamount","description":"The final sale amount of the transaction after discounts/changes and without applicable taxes"},"taxAmount":{"type":"number","title":"Taxamount","description":"The tax amount to be added in absolute number (not in percentage)"},"currency":{"type":"string","title":"Currency","description":"The currency of the transaction"}},"type":"object","required":["transactionId","locationId","saleType","createdAt","finalSaleAmount"],"title":"TransactionData"},"UnavailabilitiesListGetResponse":{"properties":{"unavailabilities":{"items":{"$ref":"#/components/schemas/SchedulerUnavailabilityResponse"},"type":"array","title":"Unavailabilities","description":"The list of the unavailabilities"}},"type":"object","required":["unavailabilities"],"title":"UnavailabilitiesListGetResponse"},"UnavailabilityCreateRequest":{"properties":{"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The unique identifier of the user to which the unavailability will be assigned"},"isAllDay":{"type":"boolean","title":"Isallday","description":"Specifies the type of the time period for the unavailability, Defaults to true. If set to false, start and end time fields must be specified."},"unavailabilityDate":{"type":"string","title":"Unavailabilitydate","description":"The date of the unavailability in ISO format (YYYY-MM-DD)."},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","description":"The timezone of the unavailability in Tz format (e.g. America/New_York). If not specified, it uses the timezone configured in the app settings."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Optional note with additional details about the unavailability"},"startTime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starttime","description":"The start time of the unavailability in ISO format (HH:MM:SS). This field is required if isAllDay set to false."},"endTime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endtime","description":"The end time of the unavailability in ISO format (HH:MM:SS). This field is required if isAllDay set to false."}},"type":"object","required":["userId","isAllDay","unavailabilityDate"],"title":"UnavailabilityCreateRequest"},"UnavailabilityCreateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the unavailability"},"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The ID of the user to which the unavailability is assigned"},"isAllDay":{"type":"boolean","title":"Isallday","description":"Whether the unavailability is for the entire day"},"unavailabilityDate":{"type":"string","title":"Unavailabilitydate","description":"The date of the unavailability in ISO format (YYYY-MM-DD)"},"startTime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starttime","description":"The start time of the unavailability in ISO format (HH:MM:SS)"},"endTime":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endtime","description":"The end time of the unavailability in ISO format (HH:MM:SS)"},"timezone":{"type":"string","title":"Timezone","description":"The timezone of the unavailability in Tz format (e.g. America/New_York)"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Optional note with additional details about the unavailability"}},"type":"object","required":["id","userId","isAllDay","unavailabilityDate","timezone"],"title":"UnavailabilityCreateResponse"},"UnavailabilityDeleteResponse":{"properties":{},"type":"object","title":"UnavailabilityDeleteResponse"},"UpdateDropdownOptionRequest":{"properties":{"value":{"type":"string","title":"Value","description":"The dropdown value"}},"type":"object","required":["value"],"title":"UpdateDropdownOptionRequest"},"UpdateDropdownOptionResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The dropdown id"},"value":{"type":"string","title":"Value","description":"The dropdown value"}},"type":"object","required":["id","value"],"title":"UpdateDropdownOptionResponse"},"UpdatePendingUserRequest":{"properties":{"firstName":{"type":"string","maxLength":100,"title":"Firstname","description":"The user's first name"},"lastName":{"type":"string","maxLength":100,"title":"Lastname","description":"The user's last name"},"phoneNumber":{"type":"string","title":"Phonenumber","description":"The user's phone number"},"email":{"type":"string","title":"Email","description":"The user's email (mandatory for managers and owners)"},"customFields":{"items":{"$ref":"#/components/schemas/BaseCustomField"},"type":"array","title":"Customfields","description":"The user's custom fields","default":[]},"rawFields":{"type":"object","title":"Rawfields","description":"The user's raw fields"},"linkId":{"type":"integer","title":"Linkid","description":"The id of the invite link"},"source":{"type":"string","title":"Source","description":"The source of the user"},"userId":{"type":"integer","title":"Userid","description":"Connecteam user id of the user"},"suggestedUserId":{"type":"integer","title":"Suggesteduserid","description":"Connecteam user id of the user for the admin to match"},"sourceIcon":{"type":"string","title":"Sourceicon","description":"The icon of the external system if users come from integration"},"externalUserId":{"type":"string","title":"Externaluserid","description":"The user ID from external system"},"integrationId":{"type":"integer","title":"Integrationid","description":"The integration ID from the integration service"},"extraFields":{"type":"object","title":"Extrafields","description":"Extra fields from integration"},"profilePictureFileId":{"type":"string","title":"Profilepicturefileid","description":"The file ID obtained from the upload attachment endpoint (POST /attachments/v1/files/generate-upload-url) with featureType set to 'users'. The file must be finalized via the complete-upload endpoint before use."}},"type":"object","required":["firstName","lastName"],"title":"UpdatePendingUserRequest"},"UpdatePendingUserResponse":{"properties":{},"type":"object","title":"UpdatePendingUserResponse"},"UpdatePendingUsersStatusRequest":{"properties":{"requests":{"items":{"$ref":"#/components/schemas/PendingUserStatusRequest"},"type":"array","title":"Requests","description":"List of status updates to apply"}},"type":"object","required":["requests"],"title":"UpdatePendingUsersStatusRequest"},"UpdateTaskRequest":{"properties":{"userIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Userids","description":"List of user IDs to assign the task to. If more than one user ID is specified, it will be treated as a group task. To assign the task to multiple users individually, separate the requests. If this field remains empty the status field must be 'draft' and not archived."},"status":{"allOf":[{"$ref":"#/components/schemas/TaskStatus"}],"description":"The status of the task"},"title":{"type":"string","title":"Title","description":"The title of the task"},"startTime":{"type":"integer","title":"Starttime","description":"The start time of the task in Unix format (in seconds)"},"dueDate":{"type":"integer","title":"Duedate","description":"The due date of the task in Unix format (in seconds)"},"labelIds":{"items":{"type":"string"},"type":"array","title":"Labelids","description":"List of labels IDs associated with the task"},"type":{"allOf":[{"$ref":"#/components/schemas/TaskType"}],"description":"The type of the task. Currently set to 'oneTime' by default.","default":"oneTime"},"isArchived":{"type":"boolean","title":"Isarchived","description":"Indicates if the task is archived","default":false},"subTasks":{"items":{"$ref":"#/components/schemas/SubTaskRequest"},"type":"array","title":"Subtasks","description":"List of subtasks associated with the task"},"description":{"allOf":[{"$ref":"#/components/schemas/TaskDescription"}],"title":"Description","description":"Specifies additional description on the task"}},"type":"object","required":["userIds","status","title"],"title":"UpdateTaskRequest"},"UpdateTaskResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the task"},"userIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Userids","description":"List of user IDs to assign the task to. If more than one user ID is specified, it will be treated as a group task. To assign the task to multiple users individually, separate the requests. If this field remains empty the status field must be 'draft' and not archived."},"status":{"allOf":[{"$ref":"#/components/schemas/TaskStatus"}],"description":"The status of the task"},"title":{"type":"string","title":"Title","description":"The title of the task"},"startTime":{"type":"integer","title":"Starttime","description":"The start time of the task in Unix format (in seconds)"},"dueDate":{"type":"integer","title":"Duedate","description":"The due date of the task in Unix format (in seconds)"},"labelIds":{"items":{"type":"string"},"type":"array","title":"Labelids","description":"List of labels IDs associated with the task"},"type":{"allOf":[{"$ref":"#/components/schemas/TaskType"}],"description":"The type of the task. Currently set to 'oneTime' by default.","default":"oneTime"},"isArchived":{"type":"boolean","title":"Isarchived","description":"Indicates if the task is archived","default":false},"subTasks":{"items":{"$ref":"#/components/schemas/SubTaskResponse"},"type":"array","title":"Subtasks","description":"List of subtasks associated with the task"},"description":{"allOf":[{"$ref":"#/components/schemas/TaskDescription"}],"title":"Description","description":"Specifies additional description on the task"}},"type":"object","required":["userIds","status","title","id"],"title":"UpdateTaskResponse","description":"Response model for updating an existing task"},"User":{"properties":{"firstName":{"type":"string","title":"Firstname","description":"The user's first name"},"lastName":{"type":"string","title":"Lastname","description":"The user's last name"},"phoneNumber":{"type":"string","title":"Phonenumber","description":"The user's phone number"},"userType":{"allOf":[{"$ref":"#/components/schemas/UserType"}],"description":"The type of the user is 'user' by default. To promote a user to 'admin', first create the user and then use the users/v1/admins endpoint to send an invite by mail. On edit (PUT /users), only 'manager' <-> 'owner' transitions are supported via this field; transitions that cross the user/manager boundary are rejected with 400 and must go through the /admins endpoint."},"email":{"type":"string","title":"Email","description":"The user's email (mandatory for managers and owners)"},"customFields":{"items":{"$ref":"#/components/schemas/CustomFieldResponse"},"type":"array","title":"Customfields","description":"The user's custom fields","default":[]},"isArchived":{"type":"boolean","title":"Isarchived","description":"The user's archived status","default":false},"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The user's unique id"},"kioskCode":{"type":"string","title":"Kioskcode","description":"The code for the user to access the kiosk app"},"createdAt":{"type":"integer","minimum":1.0,"title":"Createdat","description":"The timestamp when the user was first created in the system"},"modifiedAt":{"type":"integer","minimum":1.0,"title":"Modifiedat","description":"The timestamp of the most recent change to any user field"},"archivedAt":{"type":"integer","minimum":1.0,"title":"Archivedat","description":"The timestamp when the user was archived in the system"},"lastLogin":{"type":"integer","title":"Lastlogin","description":"The last login timestamp of the user in the system","default":0},"smartGroupsIds":{"items":{"type":"integer","minimum":1.0},"type":"array","title":"Smartgroupsids","description":"The user's smart groups he is a member of"},"invitedToBeManager":{"type":"boolean","title":"Invitedtobemanager","description":"Is the user invited to be a manager"},"profilePictureUrl":{"type":"string","title":"Profilepictureurl","description":"The URL of the user's profile picture. null if no profile picture is set."},"mobileDevice":{"type":"string","title":"Mobiledevice","description":"Mobile device model reported by the Connecteam app at the user's last mobile login (e.g. 'iPhone15,3', 'SM-G991B'). null if the user has never logged in from the mobile app."},"osVersion":{"type":"string","title":"Osversion","description":"Mobile operating-system version reported by the Connecteam app (e.g. 'iOS 17.4', 'Android 14'). null if the user has never logged in from the mobile app."},"appVersion":{"type":"string","title":"Appversion","description":"Connecteam mobile app version installed on the user's device (e.g. '8.12.3'). null if the user has never logged in from the mobile app."},"mobileDeviceId":{"type":"string","title":"Mobiledeviceid","description":"Unique identifier of the user's mobile device, as reported by the Connecteam app. null if the user has never logged in from the mobile app."}},"type":"object","required":["firstName","lastName","phoneNumber","userType","userId"],"title":"User"},"UserCreateRequest":{"properties":{"firstName":{"type":"string","maxLength":100,"title":"Firstname","description":"The user's first name"},"lastName":{"type":"string","maxLength":100,"title":"Lastname","description":"The user's last name"},"phoneNumber":{"type":"string","title":"Phonenumber","description":"The user's phone number"},"userType":{"allOf":[{"$ref":"#/components/schemas/UserType"}],"description":"The type of the user is 'user' by default. To promote a user to 'admin', first create the user and then use the users/v1/admins endpoint to send an invite by mail. On edit (PUT /users), only 'manager' <-> 'owner' transitions are supported via this field; transitions that cross the user/manager boundary are rejected with 400 and must go through the /admins endpoint."},"email":{"type":"string","title":"Email","description":"The user's email (mandatory for managers and owners)"},"customFields":{"items":{"$ref":"#/components/schemas/BaseCustomField"},"type":"array","title":"Customfields","description":"The user's custom fields","default":[]},"isArchived":{"type":"boolean","title":"Isarchived","description":"The user's archived status","default":false},"profilePictureFileId":{"type":"string","title":"Profilepicturefileid","description":"The file ID obtained from the upload attachment endpoint (POST /attachments/v1/files/generate-upload-url) with featureType set to 'users'. The file must be finalized via the complete-upload endpoint before use. Supported image formats: JPEG, PNG, BMP, TIFF, WEBP, AVIF."}},"type":"object","required":["firstName","lastName","phoneNumber","userType"],"title":"UserCreateRequest"},"UserCustomFields":{"type":"string","enum":["email","date","phone","number","str","dropdown","file","directManager","birthday","link","location"],"title":"UserCustomFields"},"UserEditRequest":{"properties":{"firstName":{"type":"string","maxLength":100,"title":"Firstname","description":"The user's first name"},"lastName":{"type":"string","maxLength":100,"title":"Lastname","description":"The user's last name"},"phoneNumber":{"type":"string","title":"Phonenumber","description":"The user's phone number"},"userType":{"allOf":[{"$ref":"#/components/schemas/UserType"}],"description":"The type of the user is 'user' by default. To promote a user to 'admin', first create the user and then use the users/v1/admins endpoint to send an invite by mail. On edit (PUT /users), only 'manager' <-> 'owner' transitions are supported via this field; transitions that cross the user/manager boundary are rejected with 400 and must go through the /admins endpoint."},"email":{"type":"string","title":"Email","description":"The user's email (mandatory for managers and owners)"},"customFields":{"items":{"$ref":"#/components/schemas/BaseCustomField"},"type":"array","title":"Customfields","description":"The user's custom fields","default":[]},"isArchived":{"type":"boolean","title":"Isarchived","description":"The user status.Note that restoring a user is not applicable with the editUserByPhone field (you must provide the user ID)."},"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The user's unique id"},"profilePictureFileId":{"type":"string","title":"Profilepicturefileid","description":"The file ID obtained from the upload attachment endpoint (POST /attachments/v1/files/generate-upload-url) with featureType set to 'users'. Send an empty string to remove the current profile picture."}},"type":"object","title":"UserEditRequest"},"UserHoursSummaryResponse":{"properties":{"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The unique identifier of the user"},"dailyRecords":{"items":{"$ref":"#/components/schemas/DailyRecordResponse"},"type":"array","title":"Dailyrecords","description":"The daily breakdown of hours"}},"type":"object","required":["userId","dailyRecords"],"title":"UserHoursSummaryResponse"},"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"},"UserJoinRequestStatus":{"type":"string","enum":["approved","declined","pending"],"title":"UserJoinRequestStatus"},"UserStatus":{"type":"string","enum":["active","archived","all"],"title":"UserStatus","description":"An enumeration."},"UserTimeActivitiesCreateRequest":{"properties":{"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The user ID of the time activity"},"shifts":{"items":{"$ref":"#/components/schemas/TimeActivityShiftCreateRequest"},"type":"array","maxItems":50,"title":"Shifts","description":"The new shifts"},"manualbreaks":{"items":{"$ref":"#/components/schemas/TimeActivityManualBreakCreateRequest"},"type":"array","maxItems":50,"title":"Manualbreaks","description":"The new manual breaks"}},"type":"object","required":["userId"],"title":"UserTimeActivitiesCreateRequest"},"UserTimeActivitiesUpdateRequest":{"properties":{"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The user ID of the time activity"},"shifts":{"items":{"$ref":"#/components/schemas/TimeActivityShiftUpdateRequest"},"type":"array","maxItems":50,"title":"Shifts","description":"The shifts to update"},"manualbreaks":{"items":{"$ref":"#/components/schemas/TimeActivityManualBreakUpdateRequest"},"type":"array","maxItems":50,"title":"Manualbreaks","description":"The breaks to update"}},"type":"object","required":["userId","shifts"],"title":"UserTimeActivitiesUpdateRequest"},"UserTimeActivity":{"properties":{"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The ID of the user"},"shifts":{"items":{"$ref":"#/components/schemas/ShiftActivityResponse"},"type":"array","title":"Shifts","description":"The shifts"},"manualBreaks":{"items":{"$ref":"#/components/schemas/ManualBreakActivityResponse"},"type":"array","title":"Manualbreaks","description":"The manual breaks"},"timeOffs":{"items":{"$ref":"#/components/schemas/TimeOffActivityResponse"},"type":"array","title":"Timeoffs","description":"The time offs"}},"type":"object","required":["userId","shifts","manualBreaks"],"title":"UserTimeActivity"},"UserType":{"type":"string","enum":["user","manager","owner"],"title":"UserType","description":"An enumeration."},"UserUnavailabilityItem":{"properties":{"userId":{"type":"integer","minimum":1.0,"title":"Userid","description":"The unique identifier of the user"},"unavailabilities":{"items":{"$ref":"#/components/schemas/SingleAbsence"},"type":"array","title":"Unavailabilities","description":"List of approved unavailabilities"},"shifts":{"items":{"$ref":"#/components/schemas/SingleShift"},"type":"array","title":"Shifts","description":"List of assigned shifts"}},"type":"object","required":["userId","unavailabilities","shifts"],"title":"UserUnavailabilityItem"},"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"},"UsersResponse":{"properties":{"users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","title":"Users","description":"The users."}},"type":"object","required":["users"],"title":"UsersResponse"},"UsersSortKeysExternal":{"enum":["created_at"],"title":"UsersSortKeysExternal","description":"An enumeration."},"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"},"VideoQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["video"],"title":"Questiontype","description":"The type of the question"},"isMultipleVideoUploadAllowed":{"type":"boolean","title":"Ismultiplevideouploadallowed","description":"Indicates if multiple uploads is enabled"},"isCameraEnabled":{"type":"boolean","title":"Iscameraenabled","description":"Indicates if recording a video through camera is enabled"},"isGalleryEnabled":{"type":"boolean","title":"Isgalleryenabled","description":"Indicates if choosing a video through gallery is enabled"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","isMultipleVideoUploadAllowed","isCameraEnabled","isGalleryEnabled"],"title":"VideoQuestion"},"WageTypesEnum":{"type":"string","enum":["hourly","monthly","yearly"],"title":"WageTypesEnum","description":"An enumeration."},"WebhookCreateRequest":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the webhook"},"url":{"type":"string","minLength":1,"format":"uri","title":"Url","description":"The specified endpoint url the payload will be sent to when the event is triggered. Must be a valid https endpoint."},"secretKey":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secretkey","description":"The secret key for this webhook"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"Determines whether the webhook settings is disabled or enabled upon creation. Default to enabled.","default":false},"featureType":{"type":"string","title":"Featuretype","description":"The feature type of the webhook. Current options are: users, forms, time_activity, tasks"},"entityId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entityid","description":"The ID of the entity scoping this webhook, as a string. For numeric-scoped features (e.g. time activity, shift scheduler) pass the numeric ID as a string, e.g. \"67\". For string-scoped features (e.g. chat) pass the domain identifier directly, e.g. \"conv_abc\". If both `entity_id` and `object_id` are provided, `entity_id` wins."},"objectId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Objectid","description":"Deprecated. Use `entity_id` instead. Kept for backward compatibility.","deprecated":true},"eventTypes":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Eventtypes","description":"The event types under the specified feature type. The list of events is available in the Guides section or on the platform."},"webhookVersion":{"type":"integer","title":"Webhookversion","description":"The version of the webhook payload schema. Defaults to 1.","default":1}},"type":"object","required":["name","url","featureType","eventTypes"],"title":"WebhookCreateRequest"},"WebhookDeleteResponse":{"properties":{},"type":"object","title":"WebhookDeleteResponse"},"WebhookListResponse":{"properties":{"webhooks":{"items":{"$ref":"#/components/schemas/WebhookResponse"},"type":"array","title":"Webhooks","description":"List of webhooks"}},"type":"object","required":["webhooks"],"title":"WebhookListResponse"},"WebhookOrigin":{"type":"string","enum":["organic","integration"],"title":"WebhookOrigin"},"WebhookResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The unique identifier of the webhook"},"name":{"type":"string","title":"Name","description":"The name of the webhook"},"userId":{"type":"integer","title":"Userid","description":"Webhook creator's user id"},"timeCreated":{"type":"integer","title":"Timecreated","description":"The timestamp when the webhook was created"},"url":{"type":"string","minLength":1,"format":"uri","title":"Url","description":"The webhook's URL"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"The webhook's disabled status"},"featureType":{"type":"string","title":"Featuretype","description":"The webhook's feature type"},"entityId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entityid","description":"The webhook's entity id as a string. `null` for broadcast webhooks."},"objectId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Objectid","description":"Deprecated. The legacy numeric object id for this webhook.","deprecated":true},"retryLimit":{"type":"integer","title":"Retrylimit","description":"The webhook's retry limit"},"eventTypes":{"items":{"type":"string"},"type":"array","title":"Eventtypes","description":"The webhook's event types"},"webhookVersion":{"type":"integer","title":"Webhookversion","description":"The version of the webhook payload schema","default":1},"origin":{"$ref":"#/components/schemas/WebhookOrigin","description":"The webhook's origin","default":"organic"}},"type":"object","required":["id","name","userId","timeCreated","url","isDisabled","featureType","retryLimit","eventTypes"],"title":"WebhookResponse"},"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.0,"description":"Integer with minimum value of 1"},"type":"array","title":"Assigneduserids","description":"The IDs of the assigned users"},"startTime":{"type":"integer","minimum":1.0,"title":"Starttime","description":"The start time of the shift"},"endTime":{"type":"integer","minimum":1.0,"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.0,"description":"Integer with minimum value of 1"},{"type":"null"}],"title":"Updatetime","description":"The update time of the shift"},"creationTime":{"anyOf":[{"type":"integer","minimum":1.0,"description":"Integer with minimum value of 1"},{"type":"null"}],"title":"Creationtime","description":"The creation time of the shift"},"createdBy":{"anyOf":[{"type":"integer","minimum":1.0,"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"},"WebhookUpdateRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the webhook"},"url":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"null"}],"title":"Url","description":"The specified endpoint url the payload will be sent to when the event is triggered. Must be a valid https endpoint."},"secretKey":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secretkey","description":"The secret key for this webhook"},"isDisabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isdisabled","description":"Determines whether the webhook settings is disabled or enabled upon creation. Default to enabled."},"featureType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Featuretype","description":"The feature type of the webhook. Current options are: users, forms, time_activity, tasks"},"entityId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entityid","description":"The ID of the entity scoping this webhook, as a string. For numeric-scoped features (e.g. time activity, shift scheduler) pass the numeric ID as a string, e.g. \"67\". For string-scoped features (e.g. chat) pass the domain identifier directly, e.g. \"conv_abc\". If both `entity_id` and `object_id` are provided, `entity_id` wins."},"objectId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Objectid","description":"Deprecated. Use `entity_id` instead. Kept for backward compatibility.","deprecated":true},"eventTypes":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Eventtypes","description":"The event types under the specified feature type. The list of events is available in the Guides section or on the platform."},"webhookVersion":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Webhookversion","description":"The version of the webhook payload schema."}},"type":"object","title":"WebhookUpdateRequest"},"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"},"YesNoQuestion":{"properties":{"questionId":{"type":"string","title":"Questionid","description":"The question's ID"},"title":{"type":"string","title":"Title","description":"The question's title"},"description":{"type":"string","title":"Description","description":"The question's description"},"locationRequired":{"type":"boolean","title":"Locationrequired","description":"Indication if the gps location is required or not"},"submissionRequired":{"type":"boolean","title":"Submissionrequired","description":"Indication if this question needs to be filled to be able to submit the form"},"questionType":{"type":"string","enum":["yesNo"],"title":"Questiontype","description":"The type of the question"},"allAnswers":{"items":{"$ref":"#/components/schemas/FormYesNoOptionModel"},"type":"array","title":"Allanswers","description":"Lise of the answer options"}},"type":"object","required":["questionId","title","description","locationRequired","submissionRequired","questionType","allAnswers"],"title":"YesNoQuestion"},"v2__features__punchclock__external_api__v1__time_clocks__models__shift_response__ShiftResponse":{"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.0,"title":"Createdat","description":"The creation time of the time activity"},"modifiedAt":{"type":"integer","minimum":1.0,"title":"Modifiedat","description":"The last modification time of the time activity"},"userId":{"type":"integer","title":"Userid","description":"The unique identifier of the user. Make sure the user is assigned to the specified time clock."},"jobId":{"type":"string","title":"Jobid","description":"The unique identifier of the associated job or sub-job. Make sure the job is assigned to the specified time clock."},"schedulerShiftId":{"type":"string","title":"Schedulershiftid","description":"The scheduled shift from the schedule associated with the clocking in event"}},"type":"object","required":["id","start","userId"],"title":"ShiftResponse"},"v2__features__shiftscheduler__external_api__v1__schedulers__scheduler__custom_fields__models__shift_custom_field_settings_response__DropdownOptionResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The dropdown option unique id"},"value":{"type":"string","title":"Value","description":"The dropdown option value"},"isDeleted":{"type":"boolean","title":"Isdeleted","description":"Whether the option is deleted","default":false}},"type":"object","required":["id","value"],"title":"DropdownOptionResponse"},"v2__features__shiftscheduler__external_api__v1__schedulers__scheduler__shifts__models__shift_response__ShiftResponse":{"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.0,"description":"Integer with minimum value of 1"},"type":"array","title":"Assigneduserids","description":"The IDs of the assigned users"},"startTime":{"type":"integer","minimum":1.0,"title":"Starttime","description":"The start time of the shift"},"endTime":{"type":"integer","minimum":1.0,"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.0,"description":"Integer with minimum value of 1"},{"type":"null"}],"title":"Updatetime","description":"The update time of the shift"},"creationTime":{"anyOf":[{"type":"integer","minimum":1.0,"description":"Integer with minimum value of 1"},{"type":"null"}],"title":"Creationtime","description":"The creation time of the shift"},"createdBy":{"anyOf":[{"type":"integer","minimum":1.0,"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"}},"type":"object","required":["id","color","startTime","endTime","timezone","isOpenShift","title","isPublished","shiftDetails"],"title":"ShiftResponse"},"v2__features__workflow__external_api__v1__form_dropdown_options__models__dropdown_options__DropdownOptionResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The dropdown id"},"value":{"type":"string","title":"Value","description":"The dropdown value"},"isDeleted":{"type":"boolean","title":"Isdeleted","description":"The dropdown option is deleted","default":false}},"type":"object","required":["id","value"],"title":"DropdownOptionResponse"},"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"},"v2__features__workflow__external_api__v1__models__forms_models__ManagerFieldStatus":{"properties":{"managerFieldStatusId":{"type":"string","title":"Managerfieldstatusid","description":"The Manager Field's status ID"},"name":{"type":"string","title":"Name","description":"The Manager Field's status"},"color":{"type":"string","title":"Color","description":"The status's background color"}},"type":"object","required":["managerFieldStatusId","name","color"],"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"},"tokenUrl":"/oauth/v1/token"}}},"HTTPBasic":{"type":"http","description":"Use client_id as Username and client_secret as Password","scheme":"basic"}}}}