Skip to main content
Connecteam logo
  • Category: human resources
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: CONNECTEAM
  • Version: 20261101_00

Tools

Slug: CONNECTEAM_ARCHIVE_USERSTool to archive one or more users by their unique IDs. Use when you need to deactivate users without deleting their records.

Input Parameters

array
required
List of unique user IDs to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_CREATE_JOBSCreate parent jobs or add sub-jobs beneath existing parent jobs.

Input Parameters

array
required
Parent jobs or sub-jobs under existing parents to create. Connecteam accepts at most 500 per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_CREATE_USERSTool to create multiple users in Connecteam. Use when you need to add several staff or admin accounts at once.

Input Parameters

array
required
List of users to create in batch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_DELETE_GEOFENCEDelete 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

string
required
Unique identifier of the geofence to delete.
integer
required
Unique identifier of the time clock.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_DELETE_JOBDelete a standalone job by ID.

Input Parameters

string
required
Unique identifier of the job to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_DELETE_SHIFTDelete 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

string
required
Unique identifier of the shift to delete
boolean
Whether to notify assigned users when deleting a published shift
integer
required
Unique identifier of the scheduler

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_DELETE_TIME_ACTIVITYDelete one shift or manual-break activity from a time clock.

Input Parameters

integer
required
Unique identifier of the time clock.
string
required
Unique identifier of the shift or manual-break activity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GENERATE_UPLOAD_URLTool 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

string
required
Name of the file to be uploaded, e.g., ‘document.pdf’
string
required
Application feature associated with the file, such as ‘chat’
string
Optional MIME type hint for the file, e.g., ‘image/jpeg’ or ‘application/pdf’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_CHATRetrieve a page of chat conversations, including team chats and channels. Use after confirming the Communications hub is on the Expert plan.

Input Parameters

integer
Maximum number of conversations to return per page (1 to 500).
integer
Number of conversations to skip for pagination (>= 0, default is 0).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_CUSTOM_FIELD_CATEGORIESTool to retrieve all custom field categories. Use when you need to list or filter custom field categories in your Connecteam account.

Input Parameters

integer
Maximum number of custom field categories to retrieve
array
List of custom field category names to filter results
array
List of custom field category IDs to filter results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_CUSTOM_FIELDSRetrieve custom fields associated with the account, with options to filter, sort, and page through results.

Input Parameters

string ("id" | "name" | "type")
Sort key: ‘id’, ‘name’, or ‘type’
integer
Maximum number of results per page (1-500)
string ("asc" | "desc")
Sort order, only honored if ‘sort’ is set
integer
Resource offset for pagination (>=0)
array
Custom field category IDs to filter by
array
Custom field IDs to filter by
array
Custom field names to filter by
array
Custom field types to filter by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_FORMSTool to retrieve all form definitions from Connecteam. Use when you need to list all existing forms after enabling the Forms API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_JOBSTool 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

string
Sort key for ordering results. Currently only ‘title’ is supported.
integer
Maximum number of records to return per page.
string ("asc" | "desc")
Sort direction. Defaults to ascending.
array
List of job IDs to filter by. Includes nested sub-jobs under each parent.
integer
Number of records to skip before starting to collect the result set.
array
List of job codes to filter by. Returns matching sub-jobs and their parents.
array
List of job names to filter by. Returns matching sub-jobs and their parents.
array
List of instance IDs (scheduler or time clock) to filter by. Only one allowed.
boolean
Whether to include deleted jobs in the response. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_PAY_RATESRetrieve effective user pay rates over a required date range.

Input Parameters

integer
Maximum number of user pay-rate records to return (1-500).
integer
Resource offset from which to return the next page.
string
required
End of the effective date range in YYYY-MM-DD format. The range must not exceed 365 days.
array
User IDs to retrieve pay rates for. Omit to include all users.
string ("hourly" | "monthly" | "yearly")
Rate type to include.
string
required
Start of the effective date range in YYYY-MM-DD format. The range must not exceed 365 days.
array
Resource IDs to include in resource-specific rate details. This does not filter other pay-rate fields.
boolean
Whether to include the complete modification history.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_PERFORMANCE_INDICATORSTool 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

integer
Maximum number of performance indicators to return per page (1-100, default is 10)
integer
Resource offset for pagination (>=0, default is 0)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_POLICY_TYPESTool to retrieve available time-off policy types. Use before filtering or creating time-off requests by policyTypeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_PUBLISHERSRetrieve a page of custom publishers associated with the account.

Input Parameters

integer
Maximum number of publishers to return per page (1-100).
integer
Offset for pagination; the number of items to skip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_SCHEDULERSTool to retrieve a list of job schedulers associated with the account. Use after authentication when you need to enumerate all schedulers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_SMART_GROUPSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_TASK_BOARDSTool to retrieve all task boards. Use after authenticating with a valid API key to list available task boards.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_TIME_ACTIVITIESRetrieve shifts, manual breaks, and time off grouped by user.

Input Parameters

array
Job IDs used to filter shifts.
string
required
End of the date range in YYYY-MM-DD format.
array
User IDs whose time activities should be returned.
string
required
Start of the date range in YYYY-MM-DD format.
integer
required
Unique identifier of the time clock.
array
Activity types to include in the response.
array
Policy type IDs used to filter time-off records.
array
Manual break IDs used to filter manual breaks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_GET_USERSRetrieve and filter a page of users associated with the account.

Input Parameters

string
Sorting criteria (e.g., creation time)
integer
Maximum number of results per page (1 to 500, default is 10)
string ("asc" | "desc")
Order of results. Defaults to ascending.
integer
Resource offset for pagination (>= 0, default is 0)
array
List of user IDs to filter results
integer
Filter users created after a specific Unix timestamp
array
Filter by exact full names
integer
Filter users modified after a specific Unix timestamp
string
Filter users by status (e.g., ‘active’)
array
Filter by phone numbers in E.164 format (e.g., +1234567890)
array
Filter by email addresses

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_LIST_METool to retrieve account information including company name and company ID. Use when you need to get details about the authenticated account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_UPDATE_JOBUpdate 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

object
Updated GPS data. For sub-jobs, forbidden when useParentData is true.
string
Updated code of the job.
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.
string
required
Unique identifier of the job to update.
string
required
Updated title of the job or sub-job.
object
Updated assignment settings. For sub-jobs, required when useParentData is false and forbidden when it is true.
string
Parent job ID. Required when updating a sub-job.
integer
Updated geofence size of the job.
string
Updated description. For sub-jobs, forbidden when useParentData is true.
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.
array
Updated custom-field values for the job.
boolean
Whether the sub-job inherits its parent’s data. Required when updating a sub-job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONNECTEAM_UPDATE_SHIFTSUpdate shifts; notifyUsers defaults true and may notify users for published shifts.

Input Parameters

array
required
Shifts to update
boolean
Whether to notify assigned users when published shifts are updated
integer
required
The unique identifier of the scheduler

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not