> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Connecteam

> Connecteam is a comprehensive workforce management platform designed to streamline operations, enhance communication, and improve HR processes for deskless teams.

![Connecteam logo](https://mintcdn.com/composio-preview/NPf8agM6UrvZD-Iu/images/toolkits/connecteam.svg?fit=max\&auto=format\&n=NPf8agM6UrvZD-Iu\&q=85\&s=47f8334eae8f53aa693e775f12df1139)

* **Category:** human resources
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 16
* **Triggers:** 0
* **Slug:** `CONNECTEAM`
* **Version:** 20261101\_00

## Tools

> [accordion] Archive Users
>
> **Slug:** `CONNECTEAM_ARCHIVE_USERS`
>
> Tool to archive one or more users by their unique IDs. Use when you need to deactivate users without deleting their records.
>
> #### Input Parameters
>
> **userIds** `array` *required*
>
> List of unique user IDs to archive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Jobs
>
> **Slug:** `CONNECTEAM_CREATE_JOBS`
>
> Create parent jobs or add sub-jobs beneath existing parent jobs.
>
> #### Input Parameters
>
> **jobs** `array` *required*
>
> Parent jobs or sub-jobs under existing parents to create. Connecteam accepts at most 500 per request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Users
>
> **Slug:** `CONNECTEAM_CREATE_USERS`
>
> Tool to create multiple users in Connecteam. Use when you need to add several staff or admin accounts at once.
>
> #### Input Parameters
>
> **users** `array` *required*
>
> List of users to create in batch
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Geofence
>
> **Slug:** `CONNECTEAM_DELETE_GEOFENCE`
>
> Delete one geofence and automatically verify its absence. Connecteam also returns 200 with empty data for a missing fence ID, so this action performs a follow-up read before reporting verified deletion.
>
> #### Input Parameters
>
> **fenceId** `string` *required*
>
> Unique identifier of the geofence to delete.
>
> **timeClockId** `integer` *required*
>
> Unique identifier of the time clock.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Job
>
> **Slug:** `CONNECTEAM_DELETE_JOB`
>
> Delete a standalone job by ID.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> Unique identifier of the job to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Shift
>
> **Slug:** `CONNECTEAM_DELETE_SHIFT`
>
> Delete one shift from a scheduler. Irreversible. If the shift repeats, ALL instances are deleted; deleting a single occurrence is not supported via the API. notifyUsers defaults to true and may notify assigned users when deleting a published shift.
>
> #### Input Parameters
>
> **shiftId** `string` *required*
>
> Unique identifier of the shift to delete
>
> **notifyUsers** `boolean`
>
> Whether to notify assigned users when deleting a published shift
>
> **schedulerId** `integer` *required*
>
> Unique identifier of the scheduler
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Time Activity
>
> **Slug:** `CONNECTEAM_DELETE_TIME_ACTIVITY`
>
> Delete one shift or manual-break activity from a time clock.
>
> #### Input Parameters
>
> **timeClockId** `integer` *required*
>
> Unique identifier of the time clock.
>
> **timeActivityId** `string` *required*
>
> Unique identifier of the shift or manual-break activity.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Upload URL
>
> **Slug:** `CONNECTEAM_GENERATE_UPLOAD_URL`
>
> Tool to generate a pre-signed URL for uploading a file. Use when you need a secure, time-limited URL prior to file upload.
>
> #### Input Parameters
>
> **fileName** `string` *required*
>
> Name of the file to be uploaded, e.g., 'document.pdf'
>
> **featureType** `string` *required*
>
> Application feature associated with the file, such as 'chat'
>
> **fileTypeHint** `string`
>
> Optional MIME type hint for the file, e.g., 'image/jpeg' or 'application/pdf'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Chat
>
> **Slug:** `CONNECTEAM_GET_CHAT`
>
> Retrieve a page of chat conversations, including team chats and channels. Use after confirming the Communications hub is on the Expert plan.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of conversations to return per page (1 to 500).
>
> **offset** `integer`
>
> Number of conversations to skip for pagination (>= 0, default is 0).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Field Categories
>
> **Slug:** `CONNECTEAM_GET_CUSTOM_FIELD_CATEGORIES`
>
> Tool to retrieve all custom field categories. Use when you need to list or filter custom field categories in your Connecteam account.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of custom field categories to retrieve
>
> **names** `array`
>
> List of custom field category names to filter results
>
> **categoryIds** `array`
>
> List of custom field category IDs to filter results
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Fields
>
> **Slug:** `CONNECTEAM_GET_CUSTOM_FIELDS`
>
> Retrieve custom fields associated with the account, with options to filter, sort, and page through results.
>
> #### Input Parameters
>
> **sort** `string ("id" | "name" | "type")`
>
> Sort key: 'id', 'name', or 'type'
>
> **limit** `integer`
>
> Maximum number of results per page (1-500)
>
> **order** `string ("asc" | "desc")`
>
> Sort order, only honored if 'sort' is set
>
> **offset** `integer`
>
> Resource offset for pagination (>=0)
>
> **categoryIds** `array`
>
> Custom field category IDs to filter by
>
> **customFieldIds** `array`
>
> Custom field IDs to filter by
>
> **customFieldNames** `array`
>
> Custom field names to filter by
>
> **customFieldTypes** `array`
>
> Custom field types to filter by
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Forms
>
> **Slug:** `CONNECTEAM_GET_FORMS`
>
> Tool to retrieve all form definitions from Connecteam. Use when you need to list all existing forms after enabling the Forms API.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Jobs
>
> **Slug:** `CONNECTEAM_GET_JOBS`
>
> Tool to retrieve a list of job objects relevant to a specific instance ID. Use after confirming scheduler or time clock instance ID when you need to filter and page through jobs.
>
> #### Input Parameters
>
> **sort** `string`
>
> Sort key for ordering results. Currently only 'title' is supported.
>
> **limit** `integer`
>
> Maximum number of records to return per page.
>
> **order** `string ("asc" | "desc")`
>
> Sort direction. Defaults to ascending.
>
> **jobIds** `array`
>
> List of job IDs to filter by. Includes nested sub-jobs under each parent.
>
> **offset** `integer`
>
> Number of records to skip before starting to collect the result set.
>
> **jobCodes** `array`
>
> List of job codes to filter by. Returns matching sub-jobs and their parents.
>
> **jobNames** `array`
>
> List of job names to filter by. Returns matching sub-jobs and their parents.
>
> **instanceIds** `array`
>
> List of instance IDs (scheduler or time clock) to filter by. Only one allowed.
>
> **includeDeleted** `boolean`
>
> Whether to include deleted jobs in the response. Defaults to true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pay Rates
>
> **Slug:** `CONNECTEAM_GET_PAY_RATES`
>
> Retrieve effective user pay rates over a required date range.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of user pay-rate records to return (1-500).
>
> **offset** `integer`
>
> Resource offset from which to return the next page.
>
> **endDate** `string` *required*
>
> End of the effective date range in YYYY-MM-DD format. The range must not exceed 365 days.
>
> **userIds** `array`
>
> User IDs to retrieve pay rates for. Omit to include all users.
>
> **rateType** `string ("hourly" | "monthly" | "yearly")`
>
> Rate type to include.
>
> **startDate** `string` *required*
>
> Start of the effective date range in YYYY-MM-DD format. The range must not exceed 365 days.
>
> **resourceIds** `array`
>
> Resource IDs to include in resource-specific rate details. This does not filter other pay-rate fields.
>
> **isIncludeHistory** `boolean`
>
> Whether to include the complete modification history.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Performance Indicators
>
> **Slug:** `CONNECTEAM_GET_PERFORMANCE_INDICATORS`
>
> Tool to retrieve the list of performance metric indicators. Use when you need to list available performance indicators for data analysis. Examples: "List performance metrics".
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of performance indicators to return per page (1-100, default is 10)
>
> **offset** `integer`
>
> Resource offset for pagination (>=0, default is 0)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Policy Types
>
> **Slug:** `CONNECTEAM_GET_POLICY_TYPES`
>
> Tool to retrieve available time-off policy types. Use before filtering or creating time-off requests by policyTypeId.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Publishers
>
> **Slug:** `CONNECTEAM_GET_PUBLISHERS`
>
> Retrieve a page of custom publishers associated with the account.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of publishers to return per page (1-100).
>
> **offset** `integer`
>
> Offset for pagination; the number of items to skip.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Schedulers
>
> **Slug:** `CONNECTEAM_GET_SCHEDULERS`
>
> Tool to retrieve a list of job schedulers associated with the account. Use after authentication when you need to enumerate all schedulers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Smart Groups
>
> **Slug:** `CONNECTEAM_GET_SMART_GROUPS`
>
> Tool to retrieve all smart groups associated with the account. Use when you need to list all smart groups after authenticating with a valid API key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Task Boards
>
> **Slug:** `CONNECTEAM_GET_TASK_BOARDS`
>
> Tool to retrieve all task boards. Use after authenticating with a valid API key to list available task boards.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time Activities
>
> **Slug:** `CONNECTEAM_GET_TIME_ACTIVITIES`
>
> Retrieve shifts, manual breaks, and time off grouped by user.
>
> #### Input Parameters
>
> **jobIds** `array`
>
> Job IDs used to filter shifts.
>
> **endDate** `string` *required*
>
> End of the date range in YYYY-MM-DD format.
>
> **userIds** `array`
>
> User IDs whose time activities should be returned.
>
> **startDate** `string` *required*
>
> Start of the date range in YYYY-MM-DD format.
>
> **timeClockId** `integer` *required*
>
> Unique identifier of the time clock.
>
> **activityTypes** `array`
>
> Activity types to include in the response.
>
> **policyTypeIds** `array`
>
> Policy type IDs used to filter time-off records.
>
> **manualBreakIds** `array`
>
> Manual break IDs used to filter manual breaks.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Users
>
> **Slug:** `CONNECTEAM_GET_USERS`
>
> Retrieve and filter a page of users associated with the account.
>
> #### Input Parameters
>
> **sort** `string`
>
> Sorting criteria (e.g., creation time)
>
> **limit** `integer`
>
> Maximum number of results per page (1 to 500, default is 10)
>
> **order** `string ("asc" | "desc")`
>
> Order of results. Defaults to ascending.
>
> **offset** `integer`
>
> Resource offset for pagination (>= 0, default is 0)
>
> **userIds** `array`
>
> List of user IDs to filter results
>
> **createdAt** `integer`
>
> Filter users created after a specific Unix timestamp
>
> **fullNames** `array`
>
> Filter by exact full names
>
> **modifiedAt** `integer`
>
> Filter users modified after a specific Unix timestamp
>
> **userStatus** `string`
>
> Filter users by status (e.g., 'active')
>
> **phoneNumbers** `array`
>
> Filter by phone numbers in E.164 format (e.g., +1234567890)
>
> **emailAddresses** `array`
>
> Filter by email addresses
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Me
>
> **Slug:** `CONNECTEAM_LIST_ME`
>
> Tool to retrieve account information including company name and company ID. Use when you need to get details about the authenticated account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job
>
> **Slug:** `CONNECTEAM_UPDATE_JOB`
>
> Update a standalone job or sub-job by ID. Updating a parent job that has nested sub-jobs is not supported; update its sub-jobs individually. Pass the job's existing color to preserve it, because omitting color may reset it to the provider default.
>
> #### Input Parameters
>
> **gps** `object`
>
> Updated GPS data. For sub-jobs, forbidden when useParentData is true.
>
> **code** `string`
>
> Updated code of the job.
>
> **color** `string ("#4B7AC5" | "#801A1A" | "#AE2121" | "#DC7A7A" | "#B0712E" | "#D4985A" | "#E4B37F" | "#AE8E2D" | "#CBA73A" | "#D9B443" | "#487037" | "#6F9B5C" | "#91B282" | "#365C64" | "#5687B3" | "#7C9BA2" | "#3968BB" | "#85A6DA" | "#225A8C" | "#548CBE" | "#81A8CC" | "#4E3F75" | "#604E8E" | "#8679AA" | "#983D73" | "#A43778" | "#D178AD" | "#6B2E4C" | "#925071" | "#B57D9A" | "#3a3a3a" | "#616161" | "#969696")`
>
> Updated color for a standalone parent job; not valid for sub-jobs. The provider schema defaults this field to #4B7AC5, so omitting it may reset the color; pass the job's existing color to preserve it.
>
> **jobId** `string` *required*
>
> Unique identifier of the job to update.
>
> **title** `string` *required*
>
> Updated title of the job or sub-job.
>
> **assign** `object`
>
> Updated assignment settings. For sub-jobs, required when useParentData is false and forbidden when it is true.
>
> **parentId** `string`
>
> Parent job ID. Required when updating a sub-job.
>
> **fenceSize** `integer`
>
> Updated geofence size of the job.
>
> **description** `string`
>
> Updated description. For sub-jobs, forbidden when useParentData is true.
>
> **instanceIds** `array`
>
> Scheduler or time-clock instance IDs to assign. Omit to keep current instances; pass an empty list to unassign all instances. Parent jobs only; not valid for sub-jobs.
>
> **customFields** `array`
>
> Updated custom-field values for the job.
>
> **useParentData** `boolean`
>
> Whether the sub-job inherits its parent's data. Required when updating a sub-job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Shifts
>
> **Slug:** `CONNECTEAM_UPDATE_SHIFTS`
>
> Update shifts; notifyUsers defaults true and may notify users for published shifts.
>
> #### Input Parameters
>
> **shifts** `array` *required*
>
> Shifts to update
>
> **notifyUsers** `boolean`
>
> Whether to notify assigned users when published shifts are updated
>
> **schedulerId** `integer` *required*
>
> The unique identifier of the scheduler
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
