Connecteam Integration

Retrieves a list of all users associated with the account. Optionally, filter by user ID to receive specific user information

13 fields

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.

3 fields

Create individual or multiple users associated with the account using the provided details.

2 fields

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.

2 fields

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.

2 fields

Retrieves all custom fields associated with the account. Optionally, filter the results by categories, names, types, or custom field IDs.

8 fields

Retrieves all custom fields categories associated with the account. Optionally, filter the results by category IDs and/or names.

6 fields

Update custom fields settings by their unique ID

1 field

Create individual or multiple custom fields associated with the account under a specific category.

1 field

Delete individual or multiple custom fields associated with the account by their unique ID.

1 field

Retrieve a list of all dropdown value options under a specified custom field

5 fields

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.

2 fields

Update the value for an option under a specified custom field

3 fields

Delete the value for an option under a specified custom field

2 fields

Create a new segment for smart groups associated with the account. The segment can be assigned a name and a color.

1 field

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.

1 field

Retrieves a list of smart groups associated with the account.

2 fields

Retrieves all smart group segments associated with the account. Optionally, filter the results by segment IDs and/or names.

2 fields

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.

2 fields

Delete existing smart group by its unique identifier

1 field

Promote an existing user to an admin. An invitation link will be sent to the specified email address of the user

1 field

Create new note on the profile of the specified user

2 fields

Upload a payslip for a user for a specified period. The payslip attachment must be uploaded first via the attachments endpoint.

2 fields

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.

3 fields

Retrieve the metric indicators of the performance data associated with account.

2 fields

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.

2 fields

Retrieve all user assignments for a specific onboarding pack

1 field

Assign one or more users to a specific onboarding pack. All-or-nothing: if any user ID is invalid, no assignments are created.

2 fields

Retrieve the scheduling rule policies assigned to a user, including employee-profile custom rules

1 field

Retrieve all assignments for a specific scheduling rule policy

4 fields

Delete a scheduling rule policy and all its assignments

1 field

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.

2 fields

Retrieve the working hours assigned to a user. Returns an empty object when the user has no working hours

1 field

Assign users to the specified working hours policy. Replaces custom working hours for those users

2 fields

Create or replace custom working hours for a user. Any shared working hours assignment is replaced

2 fields

Remove custom working hours for a user. A shared working hours assignment is kept

1 field

Remove a user's assignment to this working hours policy. Custom working hours are kept

2 fields

Retrieve all assignments for a specific pay rule policy that are in effect on the given date

5 fields

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.

2 fields

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.

2 fields

Remove a specific assignment from a pay rule policy

2 fields

Remove a pay rule from the specified pay rule policy. The policy itself and its user assignments are never deleted by this operation.

2 fields

Retrieve all metadata associated with a specified asset.

1 field

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

3 fields

Retrieve a list of locations associated with the account

5 fields

Create new sale transactions for specified locations.

1 field

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.

1 field

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.

2 fields

Delete single transaction by its ID

1 field

Delete transactions within a specified time period. All transactions during this period will be permanently removed.

3 fields

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.

1 field

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.

1 field

Retrieve detailed information about a previously uploaded attachment identified by the fileId. The response includes its metadata, and the status of the upload process.

1 field

Generates a time limited URL for downloading a file.

1 field

Retrieve a list of task labels associated with the account

4 fields

Update a quick task under a specified task board. Any new attachments will replace the existing ones.

3 fields

Delete quick task under a specified task board

2 fields

Retrieves a list of tasks under a specified task board

7 fields

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.

2 fields

Create a single sub-task under a specified parent task

3 fields

Retrieve a list of sub-tasks under a specified parent task

5 fields

Update a single sub-task under a specified parent task

4 fields

Delete a single sub-task under a specified parent task

3 fields

Retrieves a list of custom publishers associated with the account.

2 fields

Retrieves a list of team chats and/or channels associated with the account. The list excludes private conversations.

2 fields

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.

1 field

Sends a new message to a specific chat, whether it’s channel or a team chat

2 fields

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.

2 fields

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

9 fields

Retrieve a single job information by its unique ID

1 field

Create individual or multiple jobs under a specified scheduler

1 field

Update a single job by its unique identifier. Currently, updating job with nested sub-jobs is not supported.

2 fields

Delete a single job by its unique identifier. Currently, deleting a sub-job and/or job with nested sub-jobs is not supported.

1 field

Retrieves all resource custom fields associated with the account. Optionally, filter the results by custom field IDs, names, or types.

8 fields

Retrieve a list of user unavailabilities, approved time-off requests and assigned shifts

3 fields

Retrieve a list of shifts under a specific schedule

14 fields

Retrieve single shift information by its unique ID

2 fields

Delete single or multiple shifts in a specified schedule

3 fields

Create single or multiple shifts under a specific schedule

3 fields

Update single or multiple shifts under a specific schedule

3 fields

Delete a single shift by its unique ID

3 fields

Retrieve a list of user unavailabilities, approved time-off requests and assigned shifts

3 fields

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.

2 fields

Retrieve a list of shifts under a specific schedule

14 fields

Retrieve single shift information by its unique ID

2 fields

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.

2 fields

Create single or multiple shifts under a specific schedule

3 fields

Update single or multiple shifts under a specific schedule

3 fields

Delete single or multiple shifts in a specified schedule

3 fields

Delete a single shift by its unique ID

3 fields

Retrieves all shift custom fields associated with the scheduler

3 fields

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.

2 fields

Retrieve a list of unavailabilities under a specific schedule filtered by date range. The response is paginated and can be filtered by user ID.

5 fields

Delete existing unavailability by its unavailability ID

2 fields

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.

2 fields

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.

2 fields

Retrieve a list of shift layers under a specified schedule

1 field

Retrieve the possible values of a shift layer

4 fields

Get a single note by its unique identifier

1 field

Create a note under a specified schedule for a specific date

1 field

Update a single note by its unique identifier

2 fields

Delete a single note by its unique identifier

1 field

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 resource

1 field

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.

8 fields

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

2 fields

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 orde

10 fields

Retrieve a list of time activities in under a specified time clock. Time activities include shift and/or manual breaks

8 fields

Get shift attachments of a time clock

1 field

Get multiple manual breaks of a time clock

1 field

Record the start time for the work period of an employee. The start time is automatically captured when the call is executed.

2 fields

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.

2 fields

Update time activities for users assigned to a specific time clock. Time activities can include adjustments to shifts and/or manual breaks.

2 fields

Create multiple time activities in a time clock

2 fields

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 ac

3 fields

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 an

2 fields

Get all geofences for a specified time clock

1 field

Create one or more geofences for the specified time clock. Use jobIdsMode with jobIds to control which jobs each geofence applies to (all jobs, only listed jobs, or all jobs except listed ones). Job IDs must belong to that time clock.

2 fields

Get a geofence site under a specified time clock

2 fields

Delete a geofence site under a specified time clock

2 fields

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).

2 fields

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).

3 fields

Stream the breadcrumbs JSON report directly from S3. Only available when the task status is 'completed'.

1 field

Get the status of a breadcrumbs report task. Returns 'completed' when the file is ready in S3.

1 field

Initiate a breadcrumbs report for a specific date. Returns a request ID that can be used to check the report status.

1 field

Retrieve a list of user time-off balances within a policy type

4 fields

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.

6 fields

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.

1 field

Update an existing time-off request. The time-off request can be modified with new dates, times, status, or notes.

2 fields

Update user time-off balance within a policy type

3 fields

Assign user to specified time-off policy.

2 fields

Retrieve single form information by its unique ID

1 field

Retrieve a list of form submissions by form ID

6 fields

Retrieve a list of forms associated with the account

5 fields

Retrieve a single form submission by form submission ID

2 fields

Update a single form submission by form submission ID. Currently, updates are only supported for manager fields.

3 fields

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.

3 fields

Retrieve the list of selectable options for a dropdown-type question within a specified form.

5 fields

Update the label of an existing option in a dropdown-type question within a specified form. This action overrides the current value.

4 fields

Delete an existing selectable option from a dropdown-type question within a specified form.

3 fields

Retrieve single webhook information by its unique ID

1 field

Update an existing webhook settings by its unique ID.

2 fields

Delete a single webhook configuration by its unique ID

1 field

Retrieves a list of webhook settings associated with the account.

3 fields

Create individual webhook settings under specified details

1 field