# Connecteam Documentation

> Connecteam is an non-desk workforce management app designed to help businesses communicate, increase collaboration and streamline work with a set of operational, communication, and HR tools. Connecteam's API is your gateway to unlocking the full potential of our comprehensive workforce management platform. Whether you're a small business or an enterprise, our API empowers you to tailor Connecteam to your unique needs and seamlessly integrate it with your existing systems and processes.

## Guides
- [Introduction](https://developer.connecteam.com/docs/introduction-1.md)
- [Authentication](https://developer.connecteam.com/docs/authentication-1.md)
- [API access](https://developer.connecteam.com/docs/api-access.md)
- [Rate limiting](https://developer.connecteam.com/docs/rate-limiting-1.md)
- [Pagination](https://developer.connecteam.com/docs/pagination-1.md)
- [Oauth 2.0](https://developer.connecteam.com/docs/oauth-20.md)
- [Beta Endpoints](https://developer.connecteam.com/docs/beta-endpoints.md)
- [MCP](https://developer.connecteam.com/docs/mcp.md)
- [Overview](https://developer.connecteam.com/docs/company-policies-overview.md)
- [Pay Rule Policies](https://developer.connecteam.com/docs/company-policies-pay-rules.md)
- [Overview](https://developer.connecteam.com/docs/assets-overview.md)
- [Asset Metadata](https://developer.connecteam.com/docs/assets-metadata.md)
- [Overview](https://developer.connecteam.com/docs/users-overview.md)
- [Create new users](https://developer.connecteam.com/docs/create-users-data.md)
- [Get users](https://developer.connecteam.com/docs/read-users-data.md)
- [Update existing users](https://developer.connecteam.com/docs/update-users-data.md)
- [Archive/Unarchive Users](https://developer.connecteam.com/docs/archiveunarchive-users.md)
- [Delete Users](https://developer.connecteam.com/docs/delete-users.md)
- [Smart Groups](https://developer.connecteam.com/docs/smart-groups.md)
- [Promote to Admin](https://developer.connecteam.com/docs/promote-to-admin.md)
- [Overview](https://developer.connecteam.com/docs/onboarding-overview.md)
- [Get Onboarding Packs](https://developer.connecteam.com/docs/get-onboarding-packs.md)
- [Manage Pack Assignments](https://developer.connecteam.com/docs/manage-pack-assignments.md)
- [Overview](https://developer.connecteam.com/docs/overview.md)
- [Create custom fields](https://developer.connecteam.com/docs/create-custom-fields.md)
- [Get custom fields](https://developer.connecteam.com/docs/get-custom-fields.md)
- [Get custom fields categories](https://developer.connecteam.com/docs/get-custom-fields-categories.md)
- [Update custom fields](https://developer.connecteam.com/docs/update-custom-fields.md)
- [Overview](https://developer.connecteam.com/docs/overview-3.md)
- [Get custom field options](https://developer.connecteam.com/docs/get-custom-field-options.md)
- [Create custom field option](https://developer.connecteam.com/docs/create-custom-field-option.md)
- [Update custom field option](https://developer.connecteam.com/docs/update-custom-field-option.md)
- [Delete custom field option](https://developer.connecteam.com/docs/delete-custom-field-option.md)
- [Overview](https://developer.connecteam.com/docs/chat-overview.md)
- [Conversations](https://developer.connecteam.com/docs/chat-conversations.md)
- [Private Messages](https://developer.connecteam.com/docs/chat-private-messages.md)
- [Custom Publishers](https://developer.connecteam.com/docs/chat-custom-publishers.md)
- [Overview](https://developer.connecteam.com/docs/sales-data-overview.md)
- [Managing Locations](https://developer.connecteam.com/docs/sales-data-locations.md)
- [Managing Transactions](https://developer.connecteam.com/docs/sales-data-transactions.md)
- [Managing Daily Sales](https://developer.connecteam.com/docs/sales-data-daily-sales.md)
- [Overview](https://developer.connecteam.com/docs/overview-2.md)
- [Create jobs](https://developer.connecteam.com/docs/create-jobs.md)
- [Get jobs](https://developer.connecteam.com/docs/get-jobs.md)
- [Update job](https://developer.connecteam.com/docs/update-jobs.md)
- [Delete job](https://developer.connecteam.com/docs/delete-job.md)
- [Sub-jobs](https://developer.connecteam.com/docs/sub-jobs.md)
- [Overview](https://developer.connecteam.com/docs/pay-rates-overview.md)
- [Get Pay Rates](https://developer.connecteam.com/docs/get-pay-rates.md)
- [Set Pay Rates](https://developer.connecteam.com/docs/set-pay-rates.md)
- [Delete Pay Rate](https://developer.connecteam.com/docs/delete-pay-rate.md)
- [Overview](https://developer.connecteam.com/docs/time-clock-overview.md)
- [Getting Time Clocks](https://developer.connecteam.com/docs/time-clock-getting-time-clocks.md)
- [Time Activities](https://developer.connecteam.com/docs/time-clock-time-activities.md)
- [Real-Time Clocking](https://developer.connecteam.com/docs/time-clock-real-time-clocking.md)
- [Geofences](https://developer.connecteam.com/docs/time-clock-geofences.md)
- [Timesheet Totals](https://developer.connecteam.com/docs/time-clock-timesheet.md)
- [Settings & Configuration](https://developer.connecteam.com/docs/time-clock-settings.md)
- [Lock Days](https://developer.connecteam.com/docs/time-clock-lock-days.md)
- [Breadcrumbs](https://developer.connecteam.com/docs/time-clock-breadcrumbs.md)
- [Manual Break Clocking](https://developer.connecteam.com/docs/time-clock-manual-break-clocking.md)
- [Overview](https://developer.connecteam.com/docs/time-off-overview.md)
- [Policy Types & Balances](https://developer.connecteam.com/docs/time-off-policies-balances.md)
- [Time Off Requests](https://developer.connecteam.com/docs/time-off-requests.md)
- [Policy Assignments](https://developer.connecteam.com/docs/time-off-assignments.md)
- [Get Time Off Requests](https://developer.connecteam.com/docs/time-off-get-time-off-requests.md)
- [Overview](https://developer.connecteam.com/docs/scheduler-overview.md)
- [JS Vision: V1 vs V2 Shifts API](https://developer.connecteam.com/docs/scheduler-shifts-vision.md)
- [How V1 and V2 Differ](https://developer.connecteam.com/docs/scheduler-shifts-vision-overview.md)
- [Shift IDs and Response Shapes](https://developer.connecteam.com/docs/scheduler-shifts-vision-ids-responses.md)
- [Endpoint-by-Endpoint Reference](https://developer.connecteam.com/docs/scheduler-shifts-vision-endpoints.md)
- [Migration Playbook and FAQ](https://developer.connecteam.com/docs/scheduler-shifts-vision-migration.md)
- [Shifts Overview](https://developer.connecteam.com/docs/scheduler-shifts.md)
- [Get Schedulers](https://developer.connecteam.com/docs/scheduler-get-schedulers.md)
- [Creating Shifts](https://developer.connecteam.com/docs/scheduler-create-shifts.md)
- [Getting Shifts](https://developer.connecteam.com/docs/scheduler-get-shifts.md)
- [Updating Shifts](https://developer.connecteam.com/docs/scheduler-update-shifts.md)
- [Deleting Shifts](https://developer.connecteam.com/docs/scheduler-delete-shifts.md)
- [Custom Fields](https://developer.connecteam.com/docs/shift-custom-fields.md)
- [Shift Layers](https://developer.connecteam.com/docs/scheduler-shift-layers.md)
- [Unavailability](https://developer.connecteam.com/docs/scheduler-unavailability.md)
- [Auto-Assign](https://developer.connecteam.com/docs/scheduler-auto-assign.md)
- [Overview](https://developer.connecteam.com/docs/forms-overview.md)
- [Get Forms](https://developer.connecteam.com/docs/forms-get-forms.md)
- [Form Submissions](https://developer.connecteam.com/docs/forms-form-submissions.md)
- [Dropdown Options](https://developer.connecteam.com/docs/forms-dropdown-options.md)
- [Overview](https://developer.connecteam.com/docs/tasks-overview.md)
- [Task Boards](https://developer.connecteam.com/docs/tasks-task-boards.md)
- [Managing Tasks](https://developer.connecteam.com/docs/tasks-managing-tasks.md)
- [Labels](https://developer.connecteam.com/docs/tasks-labels.md)
- [Sub-Tasks](https://developer.connecteam.com/docs/tasks-sub-tasks.md)
- [Overview](https://developer.connecteam.com/docs/overview-4.md)
- [Upload file to the Cloud](https://developer.connecteam.com/docs/upload-file-to-the-cloud.md)
- [Code snippets examples](https://developer.connecteam.com/docs/code-snippets-examples.md)
- [Overview](https://developer.connecteam.com/docs/overview-1.md)
- [Setting up webhook via API](https://developer.connecteam.com/docs/setting-up-webhook-via-api.md)
- [Time activity webhook](https://developer.connecteam.com/docs/time-activity-webhook-1.md)
- [Form submission webhook](https://developer.connecteam.com/docs/forms-webhook.md)
- [Users webhook](https://developer.connecteam.com/docs/users-webhook.md)
- [Scheduler webhook](https://developer.connecteam.com/docs/scheduler-webhook.md)
- [Shift Webhook V1 vs V2](https://developer.connecteam.com/docs/shift-webhook-v1-vs-v2.md)
- [Tasks webhook](https://developer.connecteam.com/docs/tasks-webhook.md)
- [Chat webhook](https://developer.connecteam.com/docs/chat-webhook.md)

## API Reference
- [Form Submission Edited Event](https://developer.connecteam.com/reference/form_submission_edited_eventform_submission_edited_post.md): Receive real-time data updates when a form submission is edited at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Manager Field Updated Event](https://developer.connecteam.com/reference/manager_field_updated_eventmanager_field_updated_post.md): Receive real-time data updates on user demotion events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Form Submission Event](https://developer.connecteam.com/reference/form_submission_eventform_submission_post.md): Receive real-time data updates on user demotion events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Form Submission Event](https://developer.connecteam.com/reference/form-submission-event.md)
- [Time Activity Auto Approved Clock Out Without Nfc Request Event](https://developer.connecteam.com/reference/time_activity_auto_approved_clock_out_without_nfc_request_eventtime_activity_auto_approved_clock_out_without_nfc_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Admin Approved Clock Out Without Nfc Request Event](https://developer.connecteam.com/reference/time_activity_admin_approved_clock_out_without_nfc_request_eventtime_activity_admin_approved_clock_out_without_nfc_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Auto Approved Clock Out Outside Geo Fence Request Event](https://developer.connecteam.com/reference/time_activity_auto_approved_clock_out_outside_geo_fence_request_eventtime_activity_auto_approved_clock_out_outside_geo_fence_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Auto Approved Delete Request Event](https://developer.connecteam.com/reference/time_activity_auto_approved_delete_request_eventtime_activity_auto_approved_delete_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Auto Approved Edit Request Event](https://developer.connecteam.com/reference/time_activity_auto_approved_edit_request_eventtime_activity_auto_approved_edit_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Auto Approved Add Request Event](https://developer.connecteam.com/reference/time_activity_auto_approved_add_request_eventtime_activity_auto_approved_add_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Admin Declined Request Event](https://developer.connecteam.com/reference/time_activity_admin_declined_request_eventtime_activity_admin_declined_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Admin Approved Delete Request Event](https://developer.connecteam.com/reference/time_activity_admin_approved_delete_request_eventtime_activity_admin_approved_delete_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Admin Approved Add Request Event](https://developer.connecteam.com/reference/time_activity_admin_approved_add_request_eventtime_activity_admin_approved_add_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Admin Approved Edit Request Event](https://developer.connecteam.com/reference/time_activity_admin_approved_edit_request_eventtime_activity_admin_approved_edit_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Admin Approved Clock Out Outside Geo Fence Request Event](https://developer.connecteam.com/reference/time_activity_admin_approved_clock_out_outside_geo_fence_request_eventtime_activity_admin_approved_clock_out_outside_geo_fence_request_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Admin Delete Event](https://developer.connecteam.com/reference/time_activity_admin_delete_eventtime_activity_admin_delete_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Admin Edit Event](https://developer.connecteam.com/reference/time_activity_admin_edit_eventtime_activity_admin_edit_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Admin Add Event](https://developer.connecteam.com/reference/time_activity_admin_add_eventtime_activity_admin_add_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Auto Clock Out Event](https://developer.connecteam.com/reference/time_activity_auto_clock_out_eventtime_activity_auto_clock_out_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Clock Out Event](https://developer.connecteam.com/reference/time_activity_clock_out_eventtime_activity_clock_out_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Time Activity Clock In Event](https://developer.connecteam.com/reference/time_activity_clock_in_eventtime_activity_clock_in_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [User Demoted Event](https://developer.connecteam.com/reference/user_demoted_eventuser_demoted_post.md): Receive real-time data updates on user demotion events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [User Promoted Event](https://developer.connecteam.com/reference/user_promoted_eventuser_promoted_post.md): Receive real-time data updates on user promotion events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [User Restored Event](https://developer.connecteam.com/reference/user_restored_eventuser_restored_post.md): Receive real-time data updates on user restoration events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [User Archived Event](https://developer.connecteam.com/reference/user_archived_eventuser_archived_post.md): Receive real-time data updates on user archiving events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [User Deleted Event](https://developer.connecteam.com/reference/user_deleted_eventuser_deleted_post.md): Receive real-time data updates on user deletion events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [User Updated Event](https://developer.connecteam.com/reference/user_updated_eventuser_updated_post.md): Receive real-time data updates on user update events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [User Created Event](https://developer.connecteam.com/reference/user_created_eventuser_created_post.md): Receive real-time data updates on time activity events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Shifts Created Event](https://developer.connecteam.com/reference/shifts_created_eventshifts_created_post.md): Receive real-time data updates on shifts creation at your specified URL.   **V1** (default): one event per individual user assignment.   **V2**: aggregates all user assignments of the same shift into a single event, with a combined list of assigned user IDs and a base shift ID. Adding a new user to an existing shift triggers a **shift.updated** event instead. Contact us to enable V2 for your account.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Shifts Deleted Event](https://developer.connecteam.com/reference/shifts_deleted_eventshifts_deleted_post.md): Receive real-time data updates on shifts deletion at your specified URL.   **V1** (default): one event per individual user assignment.   **V2**: uses base shift IDs and only fires when the entire shift is removed. Unassigning a single user from a multi-user shift triggers a **shift.updated** event instead. Contact us to enable V2 for your account.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Shifts Updated Event](https://developer.connecteam.com/reference/shifts_updated_eventshifts_updated_post.md): Receive real-time data updates on shifts updates at your specified URL.   **V1** (default): one event per individual user assignment.   **V2**: aggregates all user assignments of the same shift into a single event, with a combined list of assigned user IDs and a base shift ID. Contact us to enable V2 for your account.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Availability Status Deleted Event](https://developer.connecteam.com/reference/availability_status_deleted_eventavailability_status_deleted_post.md): Receive real-time data updates on availability status events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Availability Status Created Event](https://developer.connecteam.com/reference/availability_status_created_eventavailability_status_created_post.md): Receive real-time data updates on availability status events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Task Completed Event](https://developer.connecteam.com/reference/task_completed_eventtask_completed_post.md): Receive real-time data updates on task complete events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Task Published Event](https://developer.connecteam.com/reference/task_published_eventtask_published_post.md): Receive real-time data updates on task published events at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Chat Message Updated Event](https://developer.connecteam.com/reference/chat_message_updated_eventchat_message_updated_post.md): Receive real-time data updates on chat message updates at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Chat Message Deleted Event](https://developer.connecteam.com/reference/chat_message_deleted_eventchat_message_deleted_post.md): Receive real-time data updates on chat message deletion at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Chat Message Created Event](https://developer.connecteam.com/reference/chat_message_created_eventchat_message_created_post.md): Receive real-time data updates on chat message creation at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Chat Conversation Updated Event](https://developer.connecteam.com/reference/chat_conversation_updated_eventchat_conversation_updated_post.md): Receive real-time data updates on chat conversation updates at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Chat Conversation Deleted Event](https://developer.connecteam.com/reference/chat_conversation_deleted_eventchat_conversation_deleted_post.md): Receive real-time data updates on chat conversation deletion at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Chat Conversation Created Event](https://developer.connecteam.com/reference/chat_conversation_created_eventchat_conversation_created_post.md): Receive real-time data updates on chat conversation creation at your specified URL.   Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.
- [Issue Access Token](https://developer.connecteam.com/reference/oauth_token_docs_oauth_v1_token_post.md): Issue an OAuth access token using client credentials grant. Use HTTP Basic Authentication with your client_id and client_secret.
- [Get account information](https://developer.connecteam.com/reference/get_account_information_me_get.md): Retrieve the account information
- [Get users](https://developer.connecteam.com/reference/get_users_users_v1_users_get.md): Retrieves a list of all users associated with the account. Optionally, filter by user ID to receive specific user information
- [Update users](https://developer.connecteam.com/reference/edit_users_users_v1_users_put.md): 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.
- [Create users](https://developer.connecteam.com/reference/create_users_users_v1_users_post.md): Create individual or multiple users associated with the account using the provided details.
- [Archive users](https://developer.connecteam.com/reference/archive_users_users_v1_users_delete.md): 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.
- [Delete user](https://developer.connecteam.com/reference/delete_user_users_v1_users__userid__delete.md): 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.
- [Get custom fields](https://developer.connecteam.com/reference/get_custom_fields_users_v1_custom_fields_get.md): Retrieves all custom fields associated with the account. Optionally, filter the results by categories, names, types, or custom field IDs.
- [Get custom field categories](https://developer.connecteam.com/reference/get_custom_fields_users_v1_custom_field_categories_get.md): Retrieves all custom fields categories associated with the account. Optionally, filter the results by category IDs and/or names.
- [Update custom fields](https://developer.connecteam.com/reference/update_custom_fields_users_v1_custom_fields_put.md): Update custom fields settings by their unique ID
- [Create custom fields](https://developer.connecteam.com/reference/create_custom_fields_users_v1_custom_fields_post.md): Create individual or multiple custom fields associated with the account under a specific category.
- [Delete custom fields](https://developer.connecteam.com/reference/delete_custom_fields_users_v1_custom_fields_delete.md): Delete individual or multiple custom fields associated with the account by their unique ID.
- [Get custom field options](https://developer.connecteam.com/reference/get_custom_field_options_users_v1_custom_fields__customfieldid__options_get.md): Retrieve a list of all dropdown value options under a specified custom field
- [Create custom field option](https://developer.connecteam.com/reference/create_custom_field_option_users_v1_custom_fields__customfieldid__options_post.md): 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.
- [Update custom field option](https://developer.connecteam.com/reference/edit_custom_field_option_users_v1_custom_fields__customfieldid__options__optionid__put.md): Update the value for an option under a specified custom field
- [Delete custom field option](https://developer.connecteam.com/reference/delete_custom_field_option_users_v1_custom_fields__customfieldid__options__optionid__delete.md): Delete the value for an option under a specified custom field
- [Create smart group segment](https://developer.connecteam.com/reference/create_smart_group_segment_users_v1_smart_group_segments_post.md): Create a new segment for smart groups associated with the account. The segment can be assigned a name and a color.
- [Create smart group](https://developer.connecteam.com/reference/create_smart_group_users_v1_smart_groups_post.md): 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.
- [Get smart groups](https://developer.connecteam.com/reference/get_smart_groups_users_v1_smart_groups_get.md): Retrieves a list of smart groups associated with the account.
- [Get smart group segments](https://developer.connecteam.com/reference/get_smart_group_segments_users_v1_smart_group_segments_get.md): Retrieves all smart group segments associated with the account. Optionally, filter the results by segment IDs and/or names.
- [Update smart group](https://developer.connecteam.com/reference/update_smart_group_users_v1_smart_groups__smartgroupid__put.md): 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.
- [Delete smart group](https://developer.connecteam.com/reference/delete_smart_group_users_v1_smart_groups__smartgroupid__delete.md): Delete existing smart group by its unique identifier
- [Promote to admin](https://developer.connecteam.com/reference/invite_admin_users_v1_admins_post.md): Promote an existing user to an admin. An invitation link will be sent to the specified email address of the user
- [Create user note](https://developer.connecteam.com/reference/create_note_users_v1_users__userid__notes_post.md): Create new note on the profile of the specified user
- [Upload a payslip](https://developer.connecteam.com/reference/create_payslip_users_v1_users__userid__payslips_post.md): Upload a payslip for a user for a specified period. The payslip attachment must be uploaded first via the attachments endpoint.
- [Update performance data](https://developer.connecteam.com/reference/update_performance_users_v1_users__userid__performance__date__put.md): 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.
- [Get indicators](https://developer.connecteam.com/reference/get_indicators_users_v1_performance_indicators_get.md): Retrieve the metric indicators of the performance data associated with account.
- [Get user assignments](https://developer.connecteam.com/reference/get_user_assignments_users_v1_users__userid__assignments_get.md): 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.
- [Get onboarding packs](https://developer.connecteam.com/reference/get_packs_onboarding_v1_packs_get.md): Retrieve all onboarding packs for the company
- [Get pack assignments](https://developer.connecteam.com/reference/get_pack_assignments_onboarding_v1_packs__packid__assignments_get.md): Retrieve all user assignments for a specific onboarding pack
- [Assign users to pack](https://developer.connecteam.com/reference/create_pack_assignments_onboarding_v1_packs__packid__assignments_post.md): Assign one or more users to a specific onboarding pack. All-or-nothing: if any user ID is invalid, no assignments are created.
- [Get company pay rule policies](https://developer.connecteam.com/reference/get_pay_rule_policies_company_policies_v1_pay_rule_policies_get.md): Retrieve a list of policies associated with the account. Currently supports pay rule policies.
- [Assign user to pay rule policy](https://developer.connecteam.com/reference/assign_user_to_policy_company_policies_v1_pay_rule_policies__payrulepolicyid__assignments_put.md): 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.
- [Get asset metadata](https://developer.connecteam.com/reference/get_metadata_per_asset_assets_v1_asset__assetid__get.md): Retrieve all metadata associated with a specified asset.
- [Get daily sales](https://developer.connecteam.com/reference/get_daily_sales_sales_v1_daily_sales_get.md): 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.
- [Get locations](https://developer.connecteam.com/reference/get_locations_sales_v1_locations_get.md): Retrieve a list of locations associated with the account
- [Create transactions](https://developer.connecteam.com/reference/create_transactions_sales_v1_transactions_post.md): Create new sale transactions for specified locations.
- [Create location](https://developer.connecteam.com/reference/create_location_sales_v1_locations_post.md): 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.
- [Set projected sales](https://developer.connecteam.com/reference/update_projected_sales_sales_v1_locations__locationid__daily_sales_put.md): 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.
- [Delete transaction](https://developer.connecteam.com/reference/delete_transaction_sales_v1_transactions__transactionid__delete.md): Delete single transaction by its ID
- [Delete transactions](https://developer.connecteam.com/reference/delete_transactions_by_period_sales_v1_transactions_delete.md): Delete transactions within a specified time period. All transactions during this period will be permanently removed.
- [Generate upload url](https://developer.connecteam.com/reference/generate_upload_url_attachments_v1_files_generate_upload_url_post.md): 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.
- [Finalize upload](https://developer.connecteam.com/reference/finalize_upload_attachments_v1_files_complete_upload__fileid__put.md): 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.
- [Get file metadata](https://developer.connecteam.com/reference/get_file_url_attachments_v1_files__fileid__get.md): Retrieve detailed information about a previously uploaded attachment identified by the fileId. The response includes its metadata, and the status of the upload process.
- [Generate download URL](https://developer.connecteam.com/reference/generate_download_url_attachments_v1_files_download_url_post.md): Generates a time limited URL for downloading a file.
- [Get task boards](https://developer.connecteam.com/reference/get_tasks_boards_tasks_v1_taskboards_get.md): Retrieve a list of task boards associated with the account
- [Get task labels](https://developer.connecteam.com/reference/get_task_labels_tasks_v1_taskboards__taskboardid__labels_get.md): Retrieve a list of task labels associated with the account
- [Update task](https://developer.connecteam.com/reference/update_task_tasks_v1_taskboards__taskboardid__tasks__taskid__put.md): Update a quick task under a specified task board. Any new attachments will replace the existing ones.
- [Delete task](https://developer.connecteam.com/reference/delete_task_tasks_v1_taskboards__taskboardid__tasks__taskid__delete.md): Delete quick task under a specified task board
- [Get tasks](https://developer.connecteam.com/reference/get_tasks_tasks_v1_taskboards__taskboardid__tasks_get.md): Retrieves a list of tasks under a specified task board
- [Create task](https://developer.connecteam.com/reference/create_task_tasks_v1_taskboards__taskboardid__tasks_post.md): 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.
- [Create sub-task](https://developer.connecteam.com/reference/create_subtask_tasks_v1_taskboards__taskboardid__tasks__taskid__sub_tasks_post.md): Create a single sub-task under a specified parent task
- [Get sub-tasks](https://developer.connecteam.com/reference/get_subtasks_tasks_v1_taskboards__taskboardid__tasks__taskid__sub_tasks_get.md): Retrieve a list of sub-tasks under a specified parent task
- [Update sub-task](https://developer.connecteam.com/reference/update_subtask_tasks_v1_taskboards__taskboardid__tasks__taskid__sub_tasks__subtaskid__put.md): Update a single sub-task under a specified parent task
- [Delete sub-task](https://developer.connecteam.com/reference/delete_subtask_tasks_v1_taskboards__taskboardid__tasks__taskid__sub_tasks__subtaskid__delete.md): Delete a single sub-task under a specified parent task
- [Get publishers](https://developer.connecteam.com/reference/get_publishers_publishers_v1_publishers_get.md): Retrieves a list of custom publishers associated with the account.
- [Get conversations](https://developer.connecteam.com/reference/get_conversations_chat_v1_conversations_get.md): Retrieves a list of team chats and/or channels associated with the account. The list excludes private conversations.
- [Create conversation](https://developer.connecteam.com/reference/create_conversation_chat_v1_conversations_post.md): 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.
- [Send message](https://developer.connecteam.com/reference/send_message_to_conversation_chat_v1_conversations__conversationid__message_post.md): Sends a new message to a specific chat, whether it’s channel or a team chat
- [Send private message](https://developer.connecteam.com/reference/send_message_to_private_conversation_chat_v1_conversations_privatemessage__userid__post.md): 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.
- [Get jobs](https://developer.connecteam.com/reference/get_jobs_jobs_v1_jobs_get.md): Get a list of job objects relevant to instance id (scheduler id or time clock id). If unified jobs are disabled, only schedulers are supported
- [Get job](https://developer.connecteam.com/reference/get_job_jobs_v1_jobs__jobid__get.md): Retrieve a single job information by its unique ID
- [Create jobs](https://developer.connecteam.com/reference/create_jobs_jobs_v1_jobs_post.md): Create individual or multiple jobs under a specified scheduler
- [Update job](https://developer.connecteam.com/reference/update_job_jobs_v1_jobs__jobid__put.md): Update a single job by its unique identifier. Currently, updating job with nested sub-jobs is not supported.
- [Delete job](https://developer.connecteam.com/reference/delete_job_jobs_v1_jobs__jobid__delete.md): Delete a single job by its unique identifier.         Currently, deleting a sub-job and/or job with nested sub-jobs is not supported.
- [Get resource custom fields](https://developer.connecteam.com/reference/get_resource_custom_fields_jobs_v1_custom_fields_get.md): Retrieves all resource custom fields associated with the account. Optionally, filter the results by custom field IDs, names, or types.
- [Get schedulers](https://developer.connecteam.com/reference/get_schedulers_scheduler_v1_schedulers_get.md): Retrieve a list of schedulers associated with the account
- [Get user unavailabilities](https://developer.connecteam.com/reference/get_unavailabilities_scheduler_v1_schedulers_user_unavailability_get.md): Retrieve a list of user unavailabilities, approved time-off requests and assigned shifts
- [Get shifts](https://developer.connecteam.com/reference/get_shifts_scheduler_v1_schedulers__schedulerid__shifts_get.md): Retrieve a list of shifts under a specific schedule
- [Get shift](https://developer.connecteam.com/reference/get_shift_by_id_scheduler_v1_schedulers__schedulerid__shifts__shiftid__get.md): Retrieve single shift information by its unique ID
- [Delete shifts](https://developer.connecteam.com/reference/delete_shifts_by_ids_scheduler_v1_schedulers__schedulerid__shifts_delete.md): Delete single or multiple shifts in a specified schedule
- [Create shifts](https://developer.connecteam.com/reference/create_shifts_scheduler_v1_schedulers__schedulerid__shifts_post.md): Create single or multiple shifts under a specific schedule
- [Update shifts](https://developer.connecteam.com/reference/update_shifts_scheduler_v1_schedulers__schedulerid__shifts_put.md): Update single or multiple shifts under a specific schedule
- [Delete shift](https://developer.connecteam.com/reference/delete_shift_by_id_scheduler_v1_schedulers__schedulerid__shifts__shiftid__delete.md): Delete a single shift by its unique ID
- [Get user unavailabilities](https://developer.connecteam.com/reference/get_unavailabilities_scheduler_v2_schedulers_user_unavailability_get.md): Retrieve a list of user unavailabilities, approved time-off requests and assigned shifts
- [Get auto-assign status](https://developer.connecteam.com/reference/get_autofill_status_scheduler_v2_schedulers__schedulerid__shifts_auto_assign__autoassignrequestid__get.md): 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.
- [Get shifts](https://developer.connecteam.com/reference/get_shifts_scheduler_v2_schedulers__schedulerid__shifts_get.md): Retrieve a list of shifts under a specific schedule
- [Get shift](https://developer.connecteam.com/reference/get_shift_by_id_scheduler_v2_schedulers__schedulerid__shifts__shiftid__get.md): Retrieve single shift information by its unique ID
- [Create auto-assign request](https://developer.connecteam.com/reference/create_autofill_request_scheduler_v2_schedulers__schedulerid__shifts_auto_assign_post.md): 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.
- [Create shifts](https://developer.connecteam.com/reference/create_shifts_scheduler_v2_schedulers__schedulerid__shifts_post.md): Create single or multiple shifts under a specific schedule
- [Update shifts](https://developer.connecteam.com/reference/update_shifts_scheduler_v2_schedulers__schedulerid__shifts_put.md): Update single or multiple shifts under a specific schedule
- [Delete shifts](https://developer.connecteam.com/reference/delete_shifts_by_ids_scheduler_v2_schedulers__schedulerid__shifts_delete.md): Delete single or multiple shifts in a specified schedule
- [Delete shift](https://developer.connecteam.com/reference/delete_shift_by_id_scheduler_v2_schedulers__schedulerid__shifts__shiftid__delete.md): Delete a single shift by its unique ID
- [Get shift custom fields](https://developer.connecteam.com/reference/get_shift_custom_fields_scheduler_v1_schedulers__schedulerid__custom_fields_get.md): Retrieves all shift custom fields associated with the scheduler
- [Create schedule unavailability](https://developer.connecteam.com/reference/create_scheduler_unavailability_scheduler_v1_schedulers__schedulerid__unavailability_post.md): 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.
- [Get schedule unavailabilities](https://developer.connecteam.com/reference/get_unavailabilities_scheduler_v1_schedulers__schedulerid__unavailabilities_get.md): Retrieve a list of unavailabilities under a specific schedule filtered by date range. The response is paginated and can be filtered by user ID.
- [Delete schedule unavailability](https://developer.connecteam.com/reference/delete_scheduler_unavailability_scheduler_v1_schedulers__schedulerid__unavailability__unavailabilityid__delete.md): Delete existing unavailability by its unavailability ID
- [Create auto-assign request](https://developer.connecteam.com/reference/create_autofill_request_scheduler_v1_schedulers__schedulerid__shifts_auto_assign_post.md): 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.
- [Get auto-assign status](https://developer.connecteam.com/reference/get_autofill_status_scheduler_v1_schedulers__schedulerid__shifts_auto_assign__autoassignrequestid__get.md): 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.
- [Get shift layers](https://developer.connecteam.com/reference/get_shift_layers_scheduler_v1_schedulers__schedulerid__shift_layers_get.md): Retrieve a list of shift layers under a specified schedule
- [Get shift layer values](https://developer.connecteam.com/reference/get_shift_layer_values_scheduler_v1_schedulers__schedulerid__shift_layers__layerid__values_get.md): Retrieve the possible values of a shift layer
- [Get note](https://developer.connecteam.com/reference/get_note_daily_info_v1_daily_note__noteid__get.md): Get a single note by its unique identifier
- [Create daily note](https://developer.connecteam.com/reference/create_note_daily_info_v1_daily_notes_post.md): Create a note under a specified schedule for a specific date
- [Update note](https://developer.connecteam.com/reference/update_note_daily_info_v1_daily_note__noteid__put.md): Update a single note by its unique identifier
- [Delete note](https://developer.connecteam.com/reference/delete_note_daily_info_v1_daily_note__noteid__delete.md): Delete a single note by its unique identifier
- [Set pay rates](https://developer.connecteam.com/reference/set_pay_rates_pay_rates_v1_pay_rates_put.md): 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.
- [Get pay rates](https://developer.connecteam.com/reference/get_pay_rates_pay_rates_v1_pay_rates_get.md): 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.
- [Delete pay rate](https://developer.connecteam.com/reference/delete_pay_rate_pay_rates_v1_pay_rates_users__userid___effectivedate__delete.md): 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).
- [Get timesheet totals](https://developer.connecteam.com/reference/get_timesheet_total_hours_time_clock_v1_time_clocks__timeclockid__timesheet_get.md): 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.
- [Get time clocks](https://developer.connecteam.com/reference/get_time_clocks_time_clock_v1_time_clocks_get.md): Retrieve a list of time clocks associated with the account
- [Get time activities](https://developer.connecteam.com/reference/get_time_activities_time_clock_v1_time_clocks__timeclockid__time_activities_get.md): Retrieve a list of time activities in under a specified time clock. Time activities include shift and/or manual breaks
- [Get shift attachments](https://developer.connecteam.com/reference/get_shift_attachments_time_clock_v1_time_clocks__timeclockid__shift_attachments_get.md): Get shift attachments of a time clock
- [Get manual breaks](https://developer.connecteam.com/reference/get_manual_breaks_time_clock_v1_time_clocks__timeclockid__manual_breaks_get.md): Get multiple manual breaks of a time clock
- [Clock in](https://developer.connecteam.com/reference/clock_user_in_time_clock_v1_time_clocks__timeclockid__clock_in_post.md): Record the start time for the work period of an employee. The start time is automatically captured when the call is executed.
- [Clock out](https://developer.connecteam.com/reference/clock_user_out_time_clock_v1_time_clocks__timeclockid__clock_out_post.md): 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.
- [Update time activities](https://developer.connecteam.com/reference/update_time_activities_time_clock_v1_time_clocks__timeclockid__time_activities_put.md): Update time activities for users assigned to a specific time clock. Time activities can include adjustments to shifts and/or manual breaks.
- [Create time activities](https://developer.connecteam.com/reference/create_time_activities_time_clock_v1_time_clocks__timeclockid__time_activities_post.md): Create multiple time activities in a time clock
- [Update user lock days](https://developer.connecteam.com/reference/update_user_lock_days_time_clock_v1_time_clocks__timeclockid__users__userid__lock_days_put.md): 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.
- [Delete time activity](https://developer.connecteam.com/reference/delete_time_activity_time_clock_v1_time_clocks__timeclockid__time_activities__timeactivityid__delete.md): 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.
- [Get geofences](https://developer.connecteam.com/reference/get_geofences_time_clock_v1_time_clocks__timeclockid__geofences_get.md): Get all geofences for a specified time clock
- [Create geofences](https://developer.connecteam.com/reference/create_geofences_time_clock_v1_time_clocks__timeclockid__geofences_post.md): 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
- [Get geofence](https://developer.connecteam.com/reference/get_geofence_time_clock_v1_time_clocks__timeclockid__geofences__fenceid__get.md): Get a geofence site under a specified time clock
- [Delete geofence](https://developer.connecteam.com/reference/delete_geo_fence_time_clock_v1_time_clocks__timeclockid__geofences__fenceid__delete.md): Delete a geofence site under a specified time clock
- [Download breadcrumbs report](https://developer.connecteam.com/reference/download_breadcrumbs_report_time_clock_breadcrumbs_v1_report__fileid__download_get.md): Stream the breadcrumbs JSON report directly from S3. Only available when the task status is 'completed'.
- [Get breadcrumbs report status](https://developer.connecteam.com/reference/get_report_status_time_clock_breadcrumbs_v1_report__fileid__get.md): Get the status of a breadcrumbs report task. Returns 'completed' when the file is ready in S3.
- [Generate breadcrumbs report](https://developer.connecteam.com/reference/generate_breadcrumbs_report_time_clock_breadcrumbs_v1_report_post.md): Initiate a breadcrumbs report for a specific date. Returns a request ID that can be used to check the report status.
- [Clock out from a manual break](https://developer.connecteam.com/reference/clock_out_manual_break_time_clock_v1_time_clocks__timeclockid__manual_breaks_clock_out_post.md): 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).
- [Clock in to a manual break](https://developer.connecteam.com/reference/clock_in_manual_break_time_clock_v1_time_clocks__timeclockid__manual_breaks__manualbreakid__clock_in_post.md): 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).
- [Get policy types](https://developer.connecteam.com/reference/get_policy_groups_time_off_v1_policy_types_get.md): Retrieve a list of policy types associated with the account
- [Get user balances](https://developer.connecteam.com/reference/get_balances_time_off_v1_policy_types__policytypeid__balances_get.md): Retrieve a list of user time-off balances within a policy type
- [Get time off requests](https://developer.connecteam.com/reference/list_time_off_requests_time_off_v1_requests_get.md): 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.
- [Create time off request](https://developer.connecteam.com/reference/post_time_off_request_time_off_v1_requests_post.md): 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.
- [Update time off request](https://developer.connecteam.com/reference/put_time_off_request_time_off_v1_requests__requestid__put.md): Update an existing time-off request. The time-off request can be modified with new dates, times, status, or notes.
- [Update user balance](https://developer.connecteam.com/reference/put_user_balance_time_off_v1_policy_types__policytypeid__balances__userid__put.md): Update user time-off balance within a policy type
- [Assign user to time-off policy](https://developer.connecteam.com/reference/assign_user_to_policy_time_off_v1_time_off_policies__timeoffpolicyid__assignments_put.md): Assign user to specified time-off policy.
- [Get form](https://developer.connecteam.com/reference/get_form_forms_v1_forms__formid__get.md): Retrieve single form information by its unique ID
- [Get form submissions](https://developer.connecteam.com/reference/get_form_submissions_forms_v1_forms__formid__form_submissions_get.md): Retrieve a list of form submissions by form ID
- [Get forms](https://developer.connecteam.com/reference/get_forms_forms_v1_forms_get.md): Retrieve a list of forms associated with the account
- [Get form submission](https://developer.connecteam.com/reference/get_form_submission_forms_v1_forms__formid__form_submissions__formsubmissionid__get.md): Retrieve a single form submission by form submission ID
- [Update form submission](https://developer.connecteam.com/reference/update_form_submissions_forms_v1_forms__formid__form_submissions__formsubmissionid__put.md): Update a single form submission by form submission ID. Currently, updates are only supported for manager fields.
- [Add dropdown options](https://developer.connecteam.com/reference/add_dropdown_options_forms_v1_forms__formid__questions__questionid__post.md): 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.
- [Get dropdown question options](https://developer.connecteam.com/reference/get_dropdown_question_options_forms_v1_forms__formid__questions__questionid__get.md): Retrieve the list of selectable options for a dropdown-type question within a specified form.
- [Update dropdown option](https://developer.connecteam.com/reference/update_dropdown_options_forms_v1_forms__formid__questions__questionid__options__optionid__put.md): Update the label of an existing option in a dropdown-type question within a specified form. This action overrides the current value.
- [Delete dropdown option](https://developer.connecteam.com/reference/delete_dropdown_option_forms_v1_forms__formid__questions__questionid__options__optionid__delete.md): Delete an existing selectable option from a dropdown-type question within a specified form.
- [Get webhook](https://developer.connecteam.com/reference/get_webhook_settings_v1_webhooks__webhookid__get.md): Retrieve single webhook information by its unique ID
- [Update Webhook](https://developer.connecteam.com/reference/update_webhook_settings_v1_webhooks__webhookid__put.md): Update an existing webhook settings by its unique ID.
- [Delete webhook](https://developer.connecteam.com/reference/delete_webhook_settings_v1_webhooks__webhookid__delete.md): Delete a single webhook configuration by its unique ID
- [Get webhooks](https://developer.connecteam.com/reference/get_webhooks_by_type_settings_v1_webhooks_get.md): Retrieves a list of webhook settings associated with the account.
- [Create webhook](https://developer.connecteam.com/reference/create_webhook_settings_v1_webhooks_post.md): Create individual webhook settings under specified details

## Changelog
- [Time Off: accrualType and policyId Added to Policy Types & Balances Response](https://developer.connecteam.com/changelog/time-off-accrual-type-and-policy-id-improved.md)
- [Time Clock: isSplitShiftOnManualBreak on Create Time Activities](https://developer.connecteam.com/changelog/time-clock-create-time-activities-split-shifts-improved.md)
- [Chat: Create Conversation API](https://developer.connecteam.com/changelog/chat-create-conversation-api-released.md)
- [Time Clock: Manual Break Clock In/Out API](https://developer.connecteam.com/changelog/time-clock-manual-break-clocking-api-released.md)
- [Forms: API guides and creation-date filters](https://developer.connecteam.com/changelog/forms-api-guides-and-date-filters.md)