# Connecteam integration

> Deskless workforce management API: users, scheduling and shifts, time clock, time off, tasks, forms, jobs, chat, and company policies.

- Authentication: apiKey

## Tools (154)

- **Add dropdown options**: 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.
- **Add pay rule to pay rule policy**: Add an existing pay rule to the specified pay rule policy. Adding a regular pay rule replaces the policy's current regular pay rule. Adding a pay rule the policy already contains succeeds unchanged.
- **Archive users**: 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.
- **Assign users to pack**: Assign one or more users to a specific onboarding pack. All-or-nothing: if any user ID is invalid, no assignments are created.
- **Assign users to scheduling rule policy**: Assign one or more users to the specified scheduling rule policy. Pass the users in the userIds array. If a user is already assigned to another scheduling rule policy, that assignment is replaced.
- **Assign users to working hours policy**: Assign users to the specified working hours policy. Replaces custom working hours for those users
- **Assign user to pay rule policy**: 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.
- **Assign user to time-off policy**: Assign user to specified time-off policy.
- **Clock in**: Record the start time for the work period of an employee. The start time is automatically captured when the call is executed.
- **Clock in to a manual break**: 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).
- **Clock out**: 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.
- **Clock out from a manual break**: 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.
- **Create auto-assign request**: Initiate a request to auto-assign shifts by their IDs. Only submits the request; processing may take a few minutes. Check progress with the auto-assign status endpoint.
- **Create auto-assign request (v2)**: Initiate a request to auto-assign shifts by their IDs (v2 scheduler). Only submits the request; processing may take a few minutes.
- **Create conversation**: Creates a team chat or channel as the authenticated user, with members assigned via userIds and/or smartGroupIds.
- **Create custom field option**: Add a new option for a specified dropdown custom field without overwriting existing options.
- **Create custom fields**: Create individual or multiple custom fields associated with the account under a specific category.
- **Create daily note**: Create a note under a specified schedule for a specific date.
- **Create geofences**: Create one or more geofences for the specified time clock, scoped to jobs via jobIdsMode and jobIds.
- **Create jobs**: Create individual or multiple jobs (or sub jobs) under a specified scheduler or time clock.
- **Create location**: Create a new location entity (branch, store or facility) used to sync sales data with third-party systems.
- **Create schedule unavailability**: Create a single unavailability in the specified schedule for a user on a given date (all day or part of the day).
- **Create shifts**: Create single or multiple shifts under a specific schedule.
- **Create shifts (v2)**: Create single or multiple shifts under a specific schedule (v2 scheduler).
- **Create smart group**: Create a new dynamic smart group under a specified segment, filtered on dropdown custom field options.
- **Create smart group segment**: Create a new segment for smart groups associated with the account, with a name and color.
- **Create sub-task**: Create a single sub-task under a specified parent task.
- **Create task**: Create quick task for specified users by their ID, detailing information such as title, due date and description.
- **Create time activities**: Create multiple time activities (shifts and manual breaks) in a time clock.
- **Create time off request**: Create a new time-off request for a user under a specified policy, in pending or approved status.
- **Create transactions**: Create new sale transactions for specified locations.
- **Create user note**: Create new note on the profile of the specified user.
- **Create users**: Create individual or multiple users associated with the account using the provided details.
- **Create webhook**: Create individual webhook settings under specified details.
- **Delete custom field option**: Delete the value for an option under a specified custom field.
- **Delete custom fields**: Delete individual or multiple custom fields associated with the account by their unique ID.
- **Delete dropdown option**: Delete an existing selectable option from a dropdown-type question within a specified form.
- **Delete geofence**: Delete a geofence site under a specified time clock.
- **Delete job**: Delete a single job by its unique identifier. Deleting a sub-job or a job with nested sub-jobs is not supported.
- **Delete note**: Delete a single daily note by its unique identifier.
- **Delete pay rate**: Deletes a specific pay rate entry for a user, identified by user ID and effective date. Cannot be undone.
- **Delete schedule unavailability**: Delete existing unavailability by its unavailability ID.
- **Delete scheduling rule policy**: Delete a scheduling rule policy and all its assignments.
- **Delete shift**: Delete a single shift by its unique ID.
- **Delete shifts**: Delete single or multiple shifts in a specified schedule.
- **Delete shifts (v2)**: Delete single or multiple shifts in a specified schedule (v2 scheduler).
- **Delete shift (v2)**: Delete a single shift by its unique ID (v2 scheduler).
- **Delete smart group**: Delete existing smart group by its unique identifier.
- **Delete sub-task**: Delete a single sub-task under a specified parent task.
- **Delete task**: Delete quick task under a specified task board.
- **Delete time activity**: Deletes a single time activity (a punch shift or a manual break) from a specified time clock.
- **Delete transaction**: Delete single transaction by its ID.
- **Delete transactions**: Delete all transactions within a specified time period for a location.
- **Delete user**: Delete or archive a user associated with the account. Deletion is permanent.
- **Delete user custom working hours**: Remove custom working hours for a user. A shared working hours assignment is kept.
- **Delete webhook**: Delete a single webhook configuration by its unique ID.
- **Download breadcrumbs report**: Stream the breadcrumbs JSON report. Only available when the report task status is completed.
- **Finalize upload**: Finalizes the upload of the attachment identified by fileId and registers it with the relevant feature.
- **Generate breadcrumbs report**: Initiate a breadcrumbs report for a specific date. Returns a request ID for checking report status.
- **Generate download URL**: Generates a time limited URL for downloading a file.
- **Generate upload url**: Generates a pre-signed URL (valid 300 seconds) for uploading an attachment, tied to a specific feature.
- **Get account information**: Retrieve the account information (company name and ID). Useful to validate the API key.
- **Get asset metadata**: Retrieve all metadata (permissions and assignments) associated with a specified asset.
- **Get auto-assign status**: Retrieve the status of an auto-assign request, with assigned and unassigned shifts.
- **Get auto-assign status (v2)**: Retrieve the status of an auto-assign request (v2 scheduler), with assigned and unassigned shifts.
- **Get breadcrumbs report status**: Get the status of a breadcrumbs report task. Returns completed when the file is ready.
- **Get company pay rule policies**: Retrieve a list of pay rule policies associated with the account.
- **Get company pay rules**: Retrieve a list of pay rules associated with the account.
- **Get conversations**: Retrieves a list of team chats and/or channels (excluding private conversations).
- **Get custom field categories**: Retrieves all custom field categories, optionally filtered by IDs and/or names.
- **Get custom field options**: Retrieve a list of all dropdown value options under a specified custom field.
- **Get custom fields**: Retrieves all custom fields, optionally filtered by categories, names, types, or IDs.
- **Get daily sales**: Retrieve daily sales totals per location for a date range (total and projected sales).
- **Get dropdown question options**: Retrieve the selectable options for a dropdown-type question within a specified form.
- **Get file metadata**: Retrieve metadata and upload status of a previously uploaded attachment by fileId.
- **Get form**: Retrieve single form information by its unique ID, including its questions.
- **Get forms**: Retrieve a list of forms associated with the account.
- **Get form submission**: Retrieve a single form submission by form submission ID.
- **Get form submissions**: Retrieve a list of form submissions by form ID, filterable by user and time range.
- **Get geofence**: Get a geofence site under a specified time clock.
- **Get geofences**: Get all geofences for a specified time clock.
- **Get indicators**: Retrieve the metric indicators of the performance data associated with the account.
- **Get job**: Retrieve a single job by its unique ID.
- **Get jobs**: Get a list of jobs relevant to an instance ID (scheduler ID or time clock ID).
- **Get locations**: Retrieve a list of sales locations associated with the account.
- **Get manual breaks**: Get multiple manual breaks of a time clock.
- **Get note**: Get a single daily note by its unique identifier.
- **Get onboarding packs**: Retrieve all onboarding packs for the company.
- **Get pack assignments**: Retrieve all user assignments for a specific onboarding pack.
- **Get pay rates**: Retrieves pay rate information for one or more users, filterable by date range, rate type and resource.
- **Get policy types**: Retrieve a list of time-off policy types associated with the account.
- **Get publishers**: Retrieves a list of custom publishers associated with the account.
- **Get resource custom fields**: Retrieves all resource (job) custom fields, optionally filtered by IDs, names or types.
- **Get schedulers**: Retrieve a list of schedulers associated with the account.
- **Get schedule unavailabilities**: Retrieve unavailabilities under a specific schedule filtered by date range.
- **Get scheduling rule policies**: Retrieve a list of scheduling rule policies associated with the account.
- **Get shift**: Retrieve single shift information by its unique ID.
- **Get shift attachments**: Get shift attachments of a time clock.
- **Get shift custom fields**: Retrieves all shift custom fields associated with the scheduler.
- **Get shift layers**: Retrieve a list of shift layers under a specified schedule.
- **Get shift layer values**: Retrieve the possible values of a shift layer.
- **Get shifts**: Retrieve a list of shifts under a specific schedule within a time range.
- **Get shifts (v2)**: Retrieve a list of shifts under a specific schedule within a time range (v2 scheduler).
- **Get shift (v2)**: Retrieve single shift information by its unique ID (v2 scheduler).
- **Get smart groups**: Retrieves a list of smart groups associated with the account.
- **Get smart group segments**: Retrieves all smart group segments, optionally filtered by segment IDs and/or names.
- **Get sub-tasks**: Retrieve a list of sub-tasks under a specified parent task.
- **Get task boards**: Retrieve a list of task boards associated with the account.
- **Get task labels**: Retrieve a list of task labels for a task board.
- **Get tasks**: Retrieves a list of tasks under a specified task board.
- **Get time activities**: Retrieve time activities (shifts, manual breaks, time offs) under a specified time clock for a date range.
- **Get time clocks**: Retrieve a list of time clocks associated with the account.
- **Get time off requests**: Retrieve a paginated list of time-off requests overlapping a date window, filterable by employees and statuses.
- **Get timesheet totals**: Retrieves detailed work records per employee for a date range (up to 45 days), with total hours by pay rule, for payroll.
- **Get user assignments**: Retrieve the assets assigned to a specified user, by asset type.
- **Get user balances**: Retrieve a list of user time-off balances within a policy type.
- **Get users**: Retrieves a list of all users associated with the account, with optional filters.
- **Get user scheduling rule policies**: Retrieve the scheduling rule policies assigned to a user, including employee-profile custom rules.
- **Get user unavailabilities**: Retrieve a user's unavailabilities, approved time-off requests and assigned shifts.
- **Get user unavailabilities (v2)**: Retrieve a user's unavailabilities, approved time-off requests and assigned shifts (v2 scheduler).
- **Get user working hours**: Retrieve the working hours assigned to a user. Returns an empty object when the user has none.
- **Get webhook**: Retrieve single webhook information by its unique ID.
- **Get webhooks**: Retrieves a list of webhook settings associated with the account.
- **Get working hours policies**: Retrieve shared working hours policies for the account, including disabled policies.
- **List pay rule policy assignments**: Retrieve all assignments for a pay rule policy in effect on a given date.
- **List scheduling rule policy assignments**: Retrieve all assignments for a specific scheduling rule policy.
- **Promote to admin**: Promote an existing user to an admin; an invitation link is sent to the given email.
- **Remove pay rule from pay rule policy**: Remove a pay rule from the specified pay rule policy. The policy and its assignments are kept.
- **Remove pay rule policy assignment**: Remove a specific assignment from a pay rule policy.
- **Send message**: Sends a new message to a channel or team chat as a custom publisher.
- **Send private message**: Send a private message to a user as a custom publisher, creating the conversation if needed.
- **Set pay rates**: Creates or updates pay rates for one or more users; a rate with the same effective date is replaced.
- **Set projected sales**: Set projected sales for a single location for one or more days. Does not modify totalSales.
- **Set user custom working hours**: Create or replace custom working hours for a user, replacing any shared working hours assignment.
- **Unassign user from working hours policy**: Remove a user's assignment to a working hours policy. Custom working hours are kept.
- **Update custom field option**: Update the value for an option under a specified custom field.
- **Update custom fields**: Update custom field settings by their unique ID.
- **Update dropdown option**: Update the label of an existing option in a dropdown-type form question.
- **Update form submission**: Update a single form submission by ID. Only manager fields can be updated.
- **Update job**: Update a single job by its unique identifier. Updating a job with nested sub-jobs is not supported.
- **Update note**: Update a single daily note by its unique identifier.
- **Update performance data**: Update or add performance indicator values for a user on a given date.
- **Update shifts**: Update single or multiple shifts under a specific schedule.
- **Update shifts (v2)**: Update single or multiple shifts under a specific schedule (v2 scheduler).
- **Update smart group**: Update an existing smart group; filter changes override current settings and may change its members.
- **Update sub-task**: Update a single sub-task under a specified parent task.
- **Update task**: Update a quick task under a specified task board. New attachments replace the existing ones.
- **Update time activities**: Update time activities (shift and manual break adjustments) for users assigned to a time clock.
- **Update time off request**: Update an existing time-off request: dates, times, status or notes.
- **Update user balance**: Update a user's time-off balance within a policy type.
- **Update user lock days**: Locks or unlocks calendar days for a user on a time clock, controlling whether time activities on those dates can be edited.
- **Update users**: Update individual or multiple users using the provided details, identified by phone number or user ID.
- **Update Webhook**: Update an existing webhook's settings by its unique ID.
- **Upload a payslip**: Upload a payslip for a user for a specified period. The payslip attachment must be uploaded first via the attachments endpoint.

Connect Connecteam in General Input: https://www.generalinput.com/apps/connecteam