Connecteam API

{"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":{"s

# --- truncated at 32 KB (599 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/connecteam/refs/heads/main/openapi/connecteam-openapi-original.json