The Connecteam connector lets your AI agent act in each user's Connecteam account. Each user connects their own Connecteam API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.
- Tools
- 59
- What they doRead · write · destructive
- 32 · 21 · 632 read21 write6 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Connecteam connection
In AgentKit > Connections, create a Connecteam connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'connecteam'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Connecteam:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'connecteam_account_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "connecteam"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Connecteam:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="connecteam_account_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Connecteam credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolconnecteam_account_getGet the Connecteam company account the API key belongs to.Read-onlyGet Account
Get the Connecteam company account the API key belongs to. Returns data (companyName, companyId). Use this to confirm the connection and see the company ID and name.
Inputs
This tool takes no inputs.
connecteam_conversations_listList chat conversations (teams and channels) in the account.Read-onlyList Conversations
List chat conversations (teams and channels) in the account. Returns data (conversations). Use this to get a conversation ID for connecteam_conversation_message_send.
Inputs
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
connecteam_daily_note_getGet one daily note by ID.Read-onlyGet Daily Note
Get one daily note by ID. Returns data (id, title, qualifiedUserIds, qualifiedGroupIds, dates). Use this after connecteam_daily_note_create.
Inputs
note_idintegerrequired- The unique identifier of the note. Example: 64f1c2a9e4b0a1b2c3d4e605
connecteam_documents_listList the company document templates.Read-onlyList Documents
List the company document templates. Returns data (documents). Use this to see which documents can be pushed to users.
Inputs
document_idsarray- Only include these document ids. Example: [12345]
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
connecteam_form_getGet one form with its questions.Read-onlyGet Form
Get one form with its questions. Returns data (formId, formName, createdAt, lastUpdatedAt, questions, settings). Get the form ID from connecteam_forms_list.
Inputs
form_idintegerrequired- Form id to return. Example: 4455667
connecteam_form_submission_getGet one form submission with all its answers.Read-onlyGet Form Submission
Get one form submission with all its answers. Returns data (formSubmission). Get the IDs from connecteam_form_submissions_list.
Inputs
form_idintegerrequired- Form Id. Example: 4455667
form_submission_idstringrequired- Filter by Form submission id. Example: 64f1c2a9e4b0a1b2c3d4e600
connecteam_form_submissions_listList submissions of a form, optionally by user or submission time.Read-onlyList Form Submissions
List submissions of a form, optionally by user or submission time. Returns data (formSubmissions). Use connecteam_form_submission_get for one submission's answers.
Inputs
form_idintegerrequired- Filter by Form Id. Example: 4455667
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
submitting_end_timeinteger- Filter form submissions that were submitted until this timestamp. Example: 10
submitting_start_timestampinteger- Filter form submissions that were submitted from this timestamp. Example: 10
user_idsarray- Filter by submitting user ids. Example: [1203456]
connecteam_forms_listList the forms (checklists, reports, surveys) in the account.Read-onlyList Forms
List the forms (checklists, reports, surveys) in the account. Returns data (forms). Use this to get a form ID for connecteam_form_submissions_list.
Inputs
end_datestring- Filter forms created on or before this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive. Example: 2026-02-03
limitinteger- The maximum number of results to display per page. Example: 50
namestring- The name of the form to filter by (partial, case-insensitive match) Example: Example name
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
start_datestring- Filter forms created on or after this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive. Example: 2026-02-02
connecteam_job_getGet one job by ID.Read-onlyGet Job
Get one job by ID. Returns data (job). Get the job ID from connecteam_jobs_list.
Inputs
job_idstringrequired- The unique identifier of the job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
connecteam_jobs_listList jobs (work sites, clients or tasks people are scheduled and clocked on), optionally by IDs, title, code or instance.Read-onlyList Jobs
List jobs (work sites, clients or tasks people are scheduled and clocked on), optionally by IDs, title, code or instance. Returns data (jobs). Use this to get job IDs for shifts and clock-ins.
Inputs
include_deletedboolean- Determines whether the response includes jobs that have been deleted. Default value is set to true. Example: true
instance_idsarray- List of instance IDs (schedule id or time clock id) to filter by. Example: [9876543]
job_codesarray- List of job codes to filter by. In case where a sub-job code is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job. Example: ["value"]
job_idsarray- List of job IDs to filter by. In cases where a job ID includes nested sub-jobs, all sub-jobs under that parent job will be retrieved alongside with the parent job. Note that this filter does not support direct querying by sub-job IDs. To retrieve specific sub-jobs, please use the Get Job endpoint. Example: ["value"]
job_namesarray- List of job names to filter by. In case where a sub-job name is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job. Example: ["value"]
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
orderstring- Sort order, set only if sort key is set. One of: asc, desc. Example: ascone of
ascdesc sortstring- Sort key. One of: title. Example: titleone of
title
connecteam_onboarding_packs_listList onboarding packs.Read-onlyList Onboarding Packs
List onboarding packs. Returns data (packs). Use this to get a pack ID for connecteam_onboarding_pack_assign.
Inputs
This tool takes no inputs.
connecteam_pending_users_listList pending user requests that are waiting for approval.Read-onlyList Pending Users
List pending user requests that are waiting for approval. Returns data (pendingUsers). Use connecteam_users_list for active users.
Inputs
idsarray- Filter by pending user IDs. Default: all. Example: [12345]
statusstring- Filter by status: 'pending', 'approved', or 'declined'. Default: all statuses. One of: approved, declined, pending. Example: approvedone of
approveddeclinedpending
connecteam_publishers_listList custom publishers (sender identities used for API chat messages).Read-onlyList Publishers
List custom publishers (sender identities used for API chat messages). Returns data (publishers). Use this to get the sender ID for the message tools.
Inputs
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
connecteam_schedulers_listList the job schedules in the account with their IDs and names.Read-onlyList Schedules
List the job schedules in the account with their IDs and names. Returns data (schedulers). Use this to get a scheduler ID for the shift tools.
Inputs
This tool takes no inputs.
connecteam_shift_getGet one shift by ID with its times, users, job, breaks, notes and statuses.Read-onlyGet Shift
Get one shift by ID with its times, users, job, breaks, notes and statuses. Returns data (id, color, assignedUserIds, startTime, endTime, timezone, isOpenShift, title, jobId, locationData). Get the shift ID from connecteam_shifts_list.
Inputs
scheduler_idintegerrequired- The unique identifier of the schedule. Example: 9876543
shift_idstringrequired- The unique identifier of the shift. Example: 64f1c2a9e4b0a1b2c3d4e5f9
connecteam_shift_layers_listList the shift layers (extra shift info fields) configured for a schedule.Read-onlyList Shift Layers
List the shift layers (extra shift info fields) configured for a schedule. Returns data (shiftLayers). Get the scheduler ID from connecteam_schedulers_list.
Inputs
scheduler_idintegerrequired- The unique identifier of the schedule. Example: 9876543
connecteam_shifts_listList shifts in a schedule between two Unix times (up to 92 days), optionally by user, job, title or open, published or approval status.Read-onlyList Shifts
List shifts in a schedule between two Unix times (up to 92 days), optionally by user, job, title or open, published or approval status. Returns data (shifts). Get the scheduler ID from connecteam_schedulers_list. Use connecteam_shift_get for one shift.
Inputs
end_timeintegerrequired- The end time to filter by in Unix format (in seconds). The range cannot exceed 92 days unless shiftId is provided. Example: 1767283200
scheduler_idintegerrequired- The unique identifier of the schedule. Example: 9876543
start_timeintegerrequired- The start time to filter by in Unix format (in seconds). The range cannot exceed 92 days unless shiftId is provided. Example: 1767254400
assigned_user_idsarray- List of user IDs. Example: [1203456]
is_open_shiftboolean- Filter shifts that are open shifts. Example: true
is_publishedboolean- Filter shifts that are published. Example: true
is_require_admin_approvalboolean- Filter shifts that require admin approval. Example: true
job_idarray- List of job IDs. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
orderstring- Sort order, set only if sort key is set. One of: asc, desc. Example: ascone of
ascdesc shift_idarray- List of shift IDs. Example: 64f1c2a9e4b0a1b2c3d4e5f9
sortstring- Sort key. One of: created_at, updated_at. Example: created_atone of
created_atupdated_at titlestring- Title of the shift. Example: Morning shift
connecteam_smart_groups_listList smart groups (dynamic user groups) with their IDs and names.Read-onlyList Smart Groups
List smart groups (dynamic user groups) with their IDs and names. Returns data (groups). Use this to get group IDs for chat, daily notes and job assignments.
Inputs
idinteger- The unique identifier of the smart group. Example: 12345
namestring- The name of the smart group to filter by. Example: Example name
connecteam_subtasks_listList the sub-tasks of a task.Read-onlyList Sub-Tasks
List the sub-tasks of a task. Returns data (subTasks). Get the task ID from connecteam_tasks_list.
Inputs
task_board_idstringrequired- The unique identifier of the task board. Example: 64f1c2a9e4b0a1b2c3d4e5f6
task_idstringrequired- The unique identifier of the parent task. Example: 64f1c2a9e4b0a1b2c3d4e5f7
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
subtask_idsarray- Optional list of subtask IDs to filter by. Example: ["value"]
connecteam_task_labels_listList the labels defined on a task board.Read-onlyList Task Labels
List the labels defined on a task board. Returns data (labels). Use this to get label IDs for connecteam_task_create.
Inputs
task_board_idstringrequired- The unique identifier of the task board to filter by. Example: 64f1c2a9e4b0a1b2c3d4e5f6
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
titlestring- The title (name) of the label to filter by. Example: Morning shift
connecteam_taskboards_listList the task boards in the account.Read-onlyList Task Boards
List the task boards in the account. Returns data (taskBoards). Use this to get a task board ID for the task tools.
Inputs
This tool takes no inputs.
connecteam_tasks_listList tasks on a task board, optionally by status, user or label.Read-onlyList Tasks
List tasks on a task board, optionally by status, user or label. Returns data (tasks). Get the task board ID from connecteam_taskboards_list.
Inputs
task_board_idstringrequired- The unique identifier of the taskBoard. Example: 64f1c2a9e4b0a1b2c3d4e5f6
label_idsarray- List of label IDs to filter by. Tasks retrieved will include the specified label(s), but may also include additional labels. Example: ["64f1c2a9e4b0a1b2c3d4e606"]
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
statusstring- draft/published/completed/all - all is by default. One of: draft, published, completed, all. Example: allone of
draftpublishedcompletedall task_idsarray- List of task IDs to filter by. Example: ["value"]
user_idsarray- List of assigned user IDs on the task to filter by. Group tasks will be also included in the results. Example: [1203456]
connecteam_time_activities_listList clocked shifts and breaks on a time clock in a date range, per user.Read-onlyList Time Activities
List clocked shifts and breaks on a time clock in a date range, per user. Returns data (timeActivitiesByUsers). Use this for timesheets and payroll exports. Use connecteam_timesheet_totals_get for totals.
Inputs
end_datestringrequired- The end time to filter by in ISO 8601 format (YYYY-MM-DD) Example: 2026-02-03
start_datestringrequired- The start time to filter by in ISO 8601 format (YYYY-MM-DD) Example: 2026-02-02
time_clock_idintegerrequired- The unique identifier of the time clock. Example: 1234567
activity_typesarray- The time activity types: shift, manual_break or time_off. Example: ["shift"]
job_idsarray- The job IDs of shifts. Example: ["value"]
manual_break_idsarray- The manual break IDs of manual breaks. Example: ["value"]
policy_type_idsarray- The policy type IDs of time offs. Example: ["value"]
user_idsarray- Filter time activities by a list of user IDs. Users who are no longer assigned to the specified time clock cannot be retrieved with this filter. Example: [1203456]
connecteam_time_clocks_listList the time clocks in the account.Read-onlyList Time Clocks
List the time clocks in the account. Returns data (timeClocks). Use this to get a time clock ID for clock-in, clock-out and time activity tools.
Inputs
This tool takes no inputs.
connecteam_time_off_balances_listList users' time off balances for one policy type.Read-onlyList Time Off Balances
List users' time off balances for one policy type. Returns data (balances). Get the policy type ID from connecteam_time_off_policy_types_list.
Inputs
policy_type_idstringrequired- Policy type id. Example: 64f1c2a9e4b0a1b2c3d4e602
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
user_idsarray- List of user ids. Example: [1203456]
connecteam_time_off_policy_types_listList time off policy types (for example vacation or sick) with their IDs.Read-onlyList Time Off Policy Types
List time off policy types (for example vacation or sick) with their IDs. Returns data (policyTypes). Use this to get a policy type ID for time off requests and balances.
Inputs
This tool takes no inputs.
connecteam_time_off_requests_listList time off requests, filtered by users, policy type, status or dates.Read-onlyList Time Off Requests
List time off requests, filtered by users, policy type, status or dates. Returns data (requests). Use connecteam_time_off_request_update to approve or deny one.
Inputs
end_datestringrequired- End of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Must be on or after startDate. Range may not exceed 365 days. Example: 2026-02-03
start_datestringrequired- Start of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Any request overlapping [startDate, endDate] is returned. Example: 2026-02-02
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
statusesarray- Filter by status. Allowed: approved, pending, denied. Repeat the param for multiple values. Defaults to ['approved'] when omitted. Example: []
user_idsarray- Filter by one or more employee IDs. Omit to include all employees. Example: [1203456]
connecteam_timesheet_totals_getGet timesheet totals (hours, pay and approval) per user on a time clock for a date range.Read-onlyGet Timesheet Totals
Get timesheet totals (hours, pay and approval) per user on a time clock for a date range. Returns data (startDate, endDate, users). Use this for payroll summaries. Use connecteam_time_activities_list for individual punches.
Inputs
end_datestringrequired- The end of the reporting period, in ISO 8601 format (YYYY-MM-DD). The filter includes all records up to 23:59:59 on the specified date. Example: An endDate of 2025-01-01 includes data up to 2025-01-01T23:59:59. The end date must be no more than 45 days after the start date. If there is an ongoing overnight shift that continues past the end date, the hours of the overnight will only be included if it has been configured in the time clock settings.
start_datestringrequired- The start of the reporting period, in ISO 8601 format (YYYY-MM-DD). The filter includes all records from 00:00:00 on the specified date. Example: A startDate of 2025-01-01 includes data starting from 2025-01-01T00:00:00.
time_clock_idintegerrequired- The unique identifier of the time clock. Example: 1234567
group_idsarray- List of cohort/group IDs to filter the results. Only time entries associated with users in these cohorts will be included. Example: ["value"]
include_plan_vs_actualboolean- When false (default), Plan vs Actual fields are omitted from the response and scheduled shifts are not fetched. When true, each daily record includes a dailyScheduledDetails object with dailyScheduledHours, dailyScheduledDifferenceHours, dailyScheduledShifts, and shifts (planned shift ids) comparing planned schedule hours to actual worked hours. Does not require Plan vs Actual to be enabled in time clock settings. Example: false
is_approvedboolean- Filter by approval status. If not provided, returns all records (approved and unapproved). Set to true for approved only, false for unapproved only. Example: true
is_lockedboolean- Filter by lock status. If not provided, returns all records (locked and unlocked). Set to true for locked only, false for unlocked only. Example: true
is_submittedboolean- Filter by submission status. If not provided, returns all records (submitted and unsubmitted). Set to true for submitted only, false for unsubmitted only. Example: true
job_idsarray- List of job IDs to filter the results. Currently supports only parent job IDs and regular job IDs. If a parent job ID is provided, only sub-jobs that have actual recorded hours will be included in the response. Example: ["value"]
user_idsarray- List of user IDs to filter the results. Only time entries associated with these users will be included. If a user has no recorded time entries within the specified date range, they will be excluded from the results. Example: [1203456]
connecteam_user_assignments_listList the schedules, time clocks and other assets a user is assigned to.Read-onlyList User Assignments
List the schedules, time clocks and other assets a user is assigned to. Returns data (smartGroups, assets). Get user IDs from connecteam_users_list.
Inputs
asset_typesarrayrequired- Specify the asset types for which you wish to retrieve details. Multiple asset types can be selected. Example: ["quickTasks"]
user_idintegerrequired- The unique identifier of the user. Example: 1203456
connecteam_user_custom_fields_listList the user profile custom fields defined in the account, with IDs, types and options.Read-onlyList User Custom Fields
List the user profile custom fields defined in the account, with IDs, types and options. Returns data (customFields). Use this to get customFieldId values for connecteam_user_create and connecteam_user_update.
Inputs
category_idsarray- Custom field category ids to filter by. Example: [12345]
custom_field_idsarray- Custom field ids to filter by. Example: [12345]
custom_field_namesarray- Custom field names to filter by. Example: ["value"]
custom_field_typesarray- Custom field types to filter by. Example: ["email"]
limitinteger- The maximum number of results to display per page. Example: 50
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
orderstring- Sort order, set only if sort key is set. One of: asc, desc. Example: ascone of
ascdesc sortstring- Sort key. One of: id, name, type. Example: idone of
idnametype
connecteam_users_listList users in the Connecteam account, filtered by IDs, status, names, phones, emails or created, modified, login or archive time.Read-onlyList Users
List users in the Connecteam account, filtered by IDs, status, names, phones, emails or created, modified, login or archive time. Returns data (users). Use this to find user IDs for scheduling, time clock, task and chat tools.
Inputs
archived_atinteger- Parameter specifying the date in Unix format (in seconds). Only users archived after this date will be included in the results. Example: 1735689600
created_atinteger- Parameter specifying the date in Unix format (in seconds). Only users created after this date will be included in the results. Example: 1735689600
email_addressesarray- List of email addresses to filter by (in format test@test.com). Example: ["jane@example.com"]
full_namesarray- List of full names to filter by. Specify the exact first and last name with a space between them as shown in the platform (ignore capitalization). Example: ["Jane Doe"]
last_logininteger- Parameter specifying the date in in Unix format (in seconds). Only users who's logged in after this date will be included in the results. Example: 1735689600
limitinteger- The maximum number of results to display per page. Example: 50
modified_atinteger- Parameter specifying the date in in Unix format (in seconds). Only users with fields updated after this date will be included in the results. Example: 1735689600
offsetinteger- The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results. Example: 0
orderstring- Sort order, set only if sort key is set. One of: asc, desc. Example: ascone of
ascdesc phone_numbersarray- List of phone numbers to filter by (in format + ). Example: ["+15555550101"]
sortstring- Sort key. One of: created_at. Example: created_atone of
created_at user_idsarray- List of user IDs for filtering. Example: [1203456]
user_statusstring- Filter users by status. Default is active. One of: active, archived, all. Example: activeone of
activearchivedall
connecteam_clock_inClock a user in on a time clock, optionally on a job or scheduled shift, at a given time and location.WriteClock In
Clock a user in on a time clock, optionally on a job or scheduled shift, at a given time and location. Returns data (shift). Use connecteam_clock_out to end the shift. The user must be assigned to the time clock.
Inputs
time_clock_idintegerrequired- The unique identifier of the time clock. Example: 1234567
user_idintegerrequired- The unique identifier of the user. Make sure the user is assigned to the specified time clock. Example: 1203456
job_idstring- The unique identifier of the associated job or sub-job. Make sure the job is assigned to the specified time clock. This field is required if the setting to enforce job assignment for time clock usage is enabled. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
location_dataobject- GPS data associated with the clocking in event. Example: {"isReferencedToJob": false, "gps": {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}}
scheduler_shift_idstring- The scheduled shift from the schedule associated with the clocking in event. Example: 64f1c2a9e4b0a1b2c3d4e5f9
timestampinteger- The clock-in time in Unix format (in seconds). If omitted, the server captures the time when the request is received. Must be no more than 12 hours in the past and not in the future. Use to record a clock-in that already happened - typically when a physical clock device is flushing queued punches after recovering from offline mode. Example: 1767254400
timezonestring- The timezone in Tz format (e.g. America/New_York). If timezone is not specified, it will use the default timezone in the time clock settings. Example: America/New_York
connecteam_clock_outClock a user out on a time clock, optionally saving shift attachment values.WriteClock Out
Clock a user out on a time clock, optionally saving shift attachment values. Returns data (shift). Use after connecteam_clock_in.
Inputs
time_clock_idintegerrequired- The unique identifier of the time clock. Example: 1234567
user_idintegerrequired- The unique identifier of the user. Make sure the user is assigned to the specified time clock. Example: 1203456
location_dataobject- GPS data associated with the clocking out event. Example: {"isReferencedToJob": false, "gps": {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}}
shift_attachmentsarray- The shift attachment values to save on clock-out. Supports dropdownList, freeText and number shift attachments. Get the IDs from Get shift attachments. Values already filled in during the shift are kept. Example: []
timestampinteger- The clock-out time in Unix format (in seconds). If omitted, the server captures the time when the request is received. Must be no more than 12 hours in the past, not in the future, and after the open shift's clock-in time. Use to record a clock-out that already happened - typically when a physical clock device is flushing queued punches after recovering from offline mode. Example: 1767254400
timezonestring- The timezone in Tz format (e.g. America/New_York). If timezone is not specified, it will use the default timezone in the time clock settings. Example: America/New_York
connecteam_conversation_createCreate a team chat or announcement channel with members, smart groups and admins.WriteCreate Conversation
Create a team chat or announcement channel with members, smart groups and admins. Returns data (conversation). Use connecteam_conversation_message_send to post in it.
Inputs
titlestringrequired- The conversation title shown in the chat clients. Must be non-empty after trimming whitespace. Example: Morning shift
typestringrequired- The conversation type. team = collaborative chat, all members can send messages. channel = broadcast group, only admins can send messages. One of: team, channel. Example: teamone of
teamchannel admin_user_idsarray- User IDs granted admin privileges in the conversation (manage members/settings; for channels, the only users who can post). An admin id must also be an assigned member (via assignedUserIds or an assigned smart group) to take effect. If omitted, defaults are applied. Example: [1203456]
assigned_smart_group_idsarray- Smart group (dynamic cohort) IDs assigned to the conversation. Membership follows the smart group's rules. At least one of assignedUserIds or assignedSmartGroupIds must be provided. Defaults to an empty array. Example: []
assigned_user_idsarray- Individual user IDs assigned as members. At least one of assignedUserIds or assignedSmartGroupIds must be provided. Defaults to an empty array. Example: [1203456]
is_lockedboolean- Whether the conversation is created locked (members cannot send messages until an admin unlocks it). Defaults to unlocked. Example: true
is_members_hiddenboolean- Whether the member list is hidden from members in the chat clients. Defaults to false. Example: false
connecteam_conversation_message_sendSend a message to a chat conversation as a custom publisher.WriteSend Conversation Message
Send a message to a chat conversation as a custom publisher. Returns requestId, data. Get the sender ID from connecteam_publishers_list and the conversation ID from connecteam_conversations_list. This notifies the members.
Inputs
conversation_idstringrequired- The unique identifier of the conversation. Example: 64f1c2a9e4b0a1b2c3d4e601
sender_idintegerrequired- The unique identifier of the sender (custom publisher). The custom publishers page can be found in the UI under Settings -> Feed settings. Example: 556677
textstringrequired- Specifies the text content of the message. Must be in UTF-8 and less than 500 characters. Example: Please remember to bring your safety vest.
attachmentsarray- List of attachments to be associated with the message. Example: []
connecteam_daily_note_createPost a daily note on a schedule for a date, visible to chosen users or groups.WriteCreate Daily Note
Post a daily note on a schedule for a date, visible to chosen users or groups. Returns data (id, title, qualifiedUserIds, qualifiedGroupIds, dates). Get the schedule ID from connecteam_schedulers_list.
Inputs
datestringrequired- The date for the note in ISO 8601 format (e.g. YYYY-MM-DD) Example: 2026-02-02
instance_idintegerrequired- The unique identifier of the schedule. Example: 9876543
titlestringrequired- The title of the note. Example: Morning shift
qualified_group_idsarray- The groups qualified to see the note. Example: []
qualified_user_idsarray- The users qualified to see the note. Example: [1203456]
connecteam_job_createCreate one job with title, code, description, location, assignment, color and optional sub-jobs, and attach it to schedules or time clocks.WriteCreate Job
Create one job with title, code, description, location, assignment, color and optional sub-jobs, and attach it to schedules or time clocks. Returns data (jobs). Pass instance_ids (schedule or time clock IDs) for a top-level job, or parent_id for a sub-job. Use connecteam_job_update to change it later.
Inputs
titlestringrequired- The title of the job. Example: Morning shift
assignobject- Data related to job assignment. Example: {"type": "users", "userIds": [1203456]}
codestring- The code of the job. Example: J-100
colorstring- The color associated with the job. Should be one of the following colors: ['#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']. Example: #4B7AC5
custom_fieldsarray- The job's custom fields. Example: [{"customFieldId": 101, "value": "North"}]
descriptionstring- The description of the job. Example: Downtown warehouse
fence_sizeinteger- The geofence size of the job. Example: 100
gpsobject- The GPS data of the job. Example: {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}
instance_idsarray- List of instance IDs (schedule id or time clock id) Example: [9876543]
parent_idstring- The ID of the parent job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567899
sub_jobsarray- List of sub jobs to create. Example: []
use_parent_databoolean- Indicates whether to use the parent job's data or not. Example: true
connecteam_job_updateUpdate a job's title, code, description, location, assignment, color or instances.WriteUpdate Job
Update a job's title, code, description, location, assignment, color or instances. Send at least one field. Returns data (job). Get the job ID from connecteam_jobs_list.
- Idempotent
Inputs
job_idstringrequired- The unique identifier of the job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
assignobject- Settings related to job assignment. Omit to keep the job's current assign. Example: {"type": "users", "userIds": [1203456]}
codestring- The code of the job. Example: J-100
colorstring- The color associated with the job. Should be one of the following colors: ['#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']. Example: #4B7AC5
custom_fieldsarray- The job's custom fields. Example: [{"customFieldId": 101, "value": "North"}]
descriptionstring- The description of the job. Example: Downtown warehouse
fence_sizeinteger- The geofence size of the job. Example: 100
gpsobject- The GPS data of the job. Example: {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}
instance_idsarray- List of instance ids (schedule id or time clock id) to assign the job to. Omit to keep the job's current instances; pass an empty list to unassign it from all of them. Example: [9876543]
parent_idstring- The ID of the parent job, if any. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567899
titlestring- The title of the job. Example: Morning shift
use_parent_databoolean- Indicates whether to use the parent job's data or not. Example: true
connecteam_onboarding_pack_assignAssign users to an onboarding pack (up to 500 at once).WriteAssign Onboarding Pack
Assign users to an onboarding pack (up to 500 at once). Returns requestId, data. Get the pack ID from connecteam_onboarding_packs_list. Get user IDs from connecteam_users_list.
Inputs
pack_idintegerrequired- The onboarding pack ID. Example: 2233445
user_idsarrayrequired- List of user IDs to assign (max: 500) Example: [1203456]
connecteam_private_message_sendSend a private chat message to one user as a custom publisher.WriteSend Private Message
Send a private chat message to one user as a custom publisher. Returns requestId, data. Get the sender ID from connecteam_publishers_list. Get user IDs from connecteam_users_list.
Inputs
sender_idintegerrequired- The unique identifier of the sender (custom publisher). The custom publishers page can be found in the UI under Settings -> Feed settings. Example: 556677
textstringrequired- Specifies the text content of the message. Must be in UTF-8 and less than 500 characters. Example: Please remember to bring your safety vest.
user_idintegerrequired- The unique identifier of the user. Example: 1203456
attachmentsarray- List of attachments to be associated with the message. Example: []
connecteam_shift_createCreate one shift in a schedule with start and end Unix times, title or job, assigned users, breaks, notes and tasks.WriteCreate Shift
Create one shift in a schedule with start and end Unix times, title or job, assigned users, breaks, notes and tasks. Returns data (shifts). Set notify_users to notify the assigned users. Get the scheduler ID from connecteam_schedulers_list.
Inputs
end_timeintegerrequired- The end time of the shift in Unix format (in seconds) Example: 1767283200
scheduler_idintegerrequired- The unique identifier of the schedule. Example: 9876543
start_timeintegerrequired- The start time of the shift in Unix format (in seconds) Example: 1767254400
assigned_user_idsarray- The list of assigned user IDs for the shift. When vision is enabled, multiple user IDs can be specified. Otherwise, only one user ID can be specified. If the shift is open, this list should remain empty. Example: [1203456]
breaksarray- A list of breaks to create for the shift. Example: [{"name": "Lunch", "type": "unpaid", "duration": 30}]
colorstring- The color associated with the shift, defaults to the color of the job linked to the shift. If a specific color is provided, it will override the default job color. Defaults to #4B7AC5. Should be one of the following colors: ['#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']. Example: #4B7AC5
custom_fieldsarray- Custom field values for the shift. Example: [{"customFieldId": 101, "value": "North"}]
is_open_shiftboolean- Indicates whether the shift is an open shift. Creates only with 1 open spot. Example: false
is_publishedboolean- Indicates whether the shift is published. Example: false
is_require_admin_approvalboolean- Indicates whether admin approval is required for claiming the shift. Can only be set if the shift is an open shift. Example: true
job_idstring- The ID of the associated job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
location_dataobject- The location data for the shift. Example: {"isReferencedToJob": false, "gps": {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}}
notesarray- Additional notes for the shift. Example: [{"html": "<p>Open the store</p>"}]
notify_usersboolean- Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published. Example: true
open_spotsinteger- The number of open spots for the shift. Can only be set for open shifts. Example: 2
shift_detailsobject- The additional details on the shift, if applicable. Example: {}
statusesarray- The list of statuses associated with the shift. Example: []
tasksarray- The list of tasks associated with the shift. Example: [{"title": "Count the register"}]
timezonestring- The timezone of the shift in Tz format (e.g. America/New_York). If not specified, it uses the timezone configured in the app settings. Example: America/New_York
titlestring- The title of the shift, If this field remains empty, the jobId field must be specified. Example: Morning shift
connecteam_shift_updateUpdate one shift's times, title, job, assigned users, breaks, notes, tasks or publish status.WriteUpdate Shift
Update one shift's times, title, job, assigned users, breaks, notes, tasks or publish status. Returns data (shifts, deletedShiftIds, createdShifts). Get the shift ID from connecteam_shifts_list.
- Idempotent
Inputs
scheduler_idintegerrequired- The unique identifier of the schedule. Example: 9876543
shift_idstringrequired- The unique identifier of the shift. Example: 64f1c2a9e4b0a1b2c3d4e5f9
assigned_user_idsarray- The list of assigned user IDs for the shift. Required for V2 Vision targeted base/group edits when isEditForAllUsers is explicitly false. When vision is enabled, multiple user IDs can be specified. Otherwise, only one user ID can be specified. Example: [1203456]
breaksarray- The list of breaks for the shift. Example: [{"name": "Lunch", "type": "unpaid", "duration": 30}]
colorstring- The color associated with the shift. Should be one of the following colors: ['#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']. Example: #4B7AC5
custom_fieldsarray- Custom field values for the shift. Example: [{"customFieldId": 101, "value": "North"}]
end_timeinteger- The end time of the shift in Unix format (in seconds) Example: 1767283200
is_edit_for_all_usersboolean- Indicates whether the update should be applied to all users assigned to the shift. In V2, when omitted and assignedUserIds is not provided, an edit of a group or open shift by its shift id applies to all users. Example: false
is_open_shiftboolean- Indicates whether the shift is an open shift. Creates only with 1 open spot. Example: true
is_publishedboolean- Indicates whether the shift is published. Example: true
is_require_admin_approvalboolean- Indicates whether admin approval is required for the shift. Can only be set if the shift is an open shift. Example: true
job_idstring- The ID of the associated job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
location_dataobject- The location data for the shift. Example: {"isReferencedToJob": false, "gps": {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}}
notesarray- Additional notes for the shift. Example: [{"html": "<p>Open the store</p>"}]
notify_usersboolean- Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published. Example: true
open_spotsinteger- The number of open spots for the shift. Can only be set for open shifts. Must be at least 1 when the open shift has no assigned users. Defaults to 1 when converting an unassigned shift to an open shift. Example: 2
start_timeinteger- The start time of the shift in Unix format (in seconds) Example: 1767254400
tasksarray- Replaces the shift's tasks with this list. Pass the id of an existing task to keep it (and its completion state); omit the id to create a new task. Pass an empty list to remove all tasks. Example: [{"title": "Count the register"}]
timezonestring- The timezone in Tz format (e.g. America/New_York) Example: America/New_York
titlestring- The title of the shift. Example: Morning shift
connecteam_subtask_createAdd a sub-task to a task.WriteCreate Sub-Task
Add a sub-task to a task. Returns data (id, title, isCompleted). Get the task ID from connecteam_tasks_list.
Inputs
task_board_idstringrequired- The unique identifier of the task board. Example: 64f1c2a9e4b0a1b2c3d4e5f6
task_idstringrequired- The unique identifier of the parent task. Example: 64f1c2a9e4b0a1b2c3d4e5f7
titlestringrequired- The title of the sub task. Example: Morning shift
is_completedboolean- Indicates whether the status of the sub-task is set to completed. Example: false
connecteam_task_createCreate a task on a task board, assigned to users, with status, title, dates, labels, sub-tasks and description.WriteCreate Task
Create a task on a task board, assigned to users, with status, title, dates, labels, sub-tasks and description. Returns data (id, userIds, status, title, startTime, dueDate, labelIds, type, isArchived, subTasks). Get the task board ID from connecteam_taskboards_list and label IDs from connecteam_task_labels_list.
Inputs
statusstringrequired- The status of the task. One of: draft, published, completed. Example: draftone of
draftpublishedcompleted task_board_idstringrequired- The unique identifier of the taskBoard. Example: 64f1c2a9e4b0a1b2c3d4e5f6
titlestringrequired- The title of the task. Example: Morning shift
user_idsarrayrequired- List of user IDs to assign the task to. If more than one user ID is specified, it will be treated as a group task. To assign the task to multiple users individually, separate the requests. If this field remains empty the status field must be 'draft' and not archived. Example: [1203456]
descriptionobject- Specifies additional description on the task. Example: {"content": "Restock aisle 4"}
due_dateinteger- The due date of the task in Unix format (in seconds) Example: 1767340800
is_archivedboolean- Indicates if the task is archived. Example: false
label_idsarray- List of labels IDs associated with the task. Example: ["64f1c2a9e4b0a1b2c3d4e606"]
start_timeinteger- The start time of the task in Unix format (in seconds) Example: 1767254400
sub_tasksarray- List of subtasks associated with the task. Example: [{"title": "Check stock"}]
typestring- The type of the task. Currently set to 'oneTime' by default. One of: oneTime, recurring. Example: oneTimeone of
oneTimerecurring
connecteam_task_updateReplace a task's users, status, title, dates, labels, sub-tasks and description.WriteUpdate Task
Replace a task's users, status, title, dates, labels, sub-tasks and description. Returns data (id, userIds, status, title, startTime, dueDate, labelIds, type, isArchived, subTasks). Send all required fields again. Get the task ID from connecteam_tasks_list.
- Idempotent
Inputs
statusstringrequired- The status of the task. One of: draft, published, completed. Example: draftone of
draftpublishedcompleted task_board_idstringrequired- The unique identifier of the taskBoard. Example: 64f1c2a9e4b0a1b2c3d4e5f6
task_idstringrequired- The unique identifier of the task. Example: 64f1c2a9e4b0a1b2c3d4e5f7
titlestringrequired- The title of the task. Example: Morning shift
user_idsarrayrequired- List of user IDs to assign the task to. If more than one user ID is specified, it will be treated as a group task. To assign the task to multiple users individually, separate the requests. If this field remains empty the status field must be 'draft' and not archived. Example: [1203456]
descriptionobject- Specifies additional description on the task. Example: {"content": "Restock aisle 4"}
due_dateinteger- The due date of the task in Unix format (in seconds) Example: 1767340800
is_archivedboolean- Indicates if the task is archived. Example: false
label_idsarray- List of labels IDs associated with the task. Example: ["64f1c2a9e4b0a1b2c3d4e606"]
start_timeinteger- The start time of the task in Unix format (in seconds) Example: 1767254400
sub_tasksarray- List of subtasks associated with the task. Example: [{"title": "Check stock"}]
typestring- The type of the task. Currently set to 'oneTime' by default. One of: oneTime, recurring. Example: oneTimeone of
oneTimerecurring
connecteam_time_activities_createAdd clocked shifts or manual breaks for one or more users on a time clock.WriteCreate Time Activities
Add clocked shifts or manual breaks for one or more users on a time clock. Returns data (timeActivitiesByUsers). Use this to add missed punches. Use connecteam_clock_in for a live clock-in.
Inputs
time_activitiesarrayrequired- List of the time activities of the users. Example: [{"userId": 1203456, "shifts": [{"start": {"timestamp": 1767254400, "timezone": "America/New_York"}, "end": {"timestamp": 1767283200, "timezone": "America/New_York"}}]}]
time_clock_idintegerrequired- The unique identifier of the time clock. Example: 1234567
is_split_shift_on_manual_breakboolean- When true, manual break creation splits any overlapping completed shift into two shifts around the break window, matching dashboard behavior. When false (default), existing shifts are unchanged. Example: false
connecteam_time_activities_updateEdit clocked shifts or breaks for one or more users on a time clock.WriteUpdate Time Activities
Edit clocked shifts or breaks for one or more users on a time clock. Returns data (timeActivitiesByUsers). Get the time activity IDs from connecteam_time_activities_list.
- Idempotent
Inputs
time_activitiesarrayrequired- List of time activities of the users. Example: [{"userId": 1203456, "shifts": [{"id": "64f1c2a9e4b0a1b2c3d4e604", "end": {"timestamp": 1767283200, "timezone": "America/New_York"}}]}]
time_clock_idintegerrequired- The unique identifier of the time clock. Example: 1234567
connecteam_time_off_request_createCreate a time off request for a user, as approved, pending or denied, for full days or a time range.WriteCreate Time Off Request
Create a time off request for a user, as approved, pending or denied, for full days or a time range. Returns data (id, timeClockId, policyTypeId, userId, isAllDay, duration, startDate, endDate, startTime, endTime). Get the policy type ID from connecteam_time_off_policy_types_list.
Inputs
end_datestringrequired- The end time of the time off in ISO format (YYYY-MM-DD). End date must be similar to Start date if isAllDay set to false. Example: 2026-02-03
is_all_daybooleanrequired- Specifies the type of the time period. Defaults to true. If set to false, start and end time fields must be specified. Example: true
policy_type_idstringrequired- The ID of the policy type. Example: 64f1c2a9e4b0a1b2c3d4e602
start_datestringrequired- The start date of the time off in ISO format (YYYY-MM-DD) Example: 2026-02-02
statusstringrequired- The status of the time off request. One of: approved, pending, denied. Example: approvedone of
approvedpendingdenied timezonestringrequired- The timezone in Tz format (e.g. America/New_York) Example: America/New_York
user_idintegerrequired- The ID of the user to create the time off request. Example: 1203456
employee_notestring- Employee note providing additional details. Example: Doctor appointment
end_timestring- The end time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false. Example: 1767283200
is_adjust_for_day_light_savingboolean- Specifies if the time given should offset the daylight savings time change if the time falls exactly on the daylight savings time change. Set to true only if the time coincides with the rollback hour, otherwise, it should remain false. Example: false
manager_notestring- Manager note providing additional details. Example: Approved
start_timestring- The start time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false. Example: 1767254400
time_clock_idinteger- The unique identifier of the time clock where the time off will be presented in the timesheet. Example: 1234567
connecteam_time_off_request_updateChange a time off request's dates, times, status or manager note.WriteUpdate Time Off Request
Change a time off request's dates, times, status or manager note. Returns data (id, timeClockId, userId, isAllDay, startDate, endDate, startTime, endTime, timezone, status). Use this to approve or deny a request. Get the ID from connecteam_time_off_requests_list.
- Idempotent
Inputs
request_idstringrequired- The unique identifier of the time off request. Example: 64f1c2a9e4b0a1b2c3d4e603
end_datestring- The end time of the time off in ISO format (YYYY-MM-DD). End date must be similar to Start date if isAllDay set to false. Example: 2026-02-03
end_timestring- The end time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false. Example: 1767283200
is_adjust_for_day_light_savingboolean- Specifies if the time given should offset the daylight savings time change if the time falls exactly on the daylight savings time change. Set to true only if the time coincides with the rollback hour, otherwise, it should remain false. Example: true
is_all_dayboolean- Specifies the type of the time period. If set to false, start and end time fields must be specified. Example: true
manager_notestring- Manager note providing additional details. Example: Approved
start_datestring- The start date of the time off in ISO format (YYYY-MM-DD) Example: 2026-02-02
start_timestring- The start time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false. Example: 1767254400
statusstring- The status of the time off request. One of: approved, pending, denied. Example: approvedone of
approvedpendingdenied time_clock_idinteger- The unique identifier of the time clock where the time off will be presented in the timesheet. Example: 1234567
timezonestring- The timezone in Tz format (e.g. America/New_York) Example: America/New_York
connecteam_user_createCreate one user (employee, manager or owner) with name, phone, email and custom fields, optionally sending an activation SMS.WriteCreate User
Create one user (employee, manager or owner) with name, phone, email and custom fields, optionally sending an activation SMS. Returns data (results). Use connecteam_user_update to change an existing user. Managers and owners need an email.
Inputs
first_namestringrequired- The user's first name. Example: Jane
last_namestringrequired- The user's last name. Example: Doe
phone_numberstringrequired- The user's phone number. Example: +15555550101
user_typestringrequired- The type of the user is 'user' by default. To promote a user to 'admin', first create the user and then use the users/v1/admins endpoint to send an invite by mail. On edit (PUT /users), only 'manager' 'owner' transitions are supported via this field; transitions that cross the user/manager boundary are rejected with 400 and must go through the /admins endpoint. One of: user, manager, owner. Example: userone of
usermanagerowner custom_fieldsarray- The user's custom fields. Example: [{"customFieldId": 101, "value": "North"}]
emailstring- The user's email (mandatory for managers and owners) Example: jane@example.com
is_archivedboolean- The user's archived status. Example: false
send_activationboolean- Optional flag to send activation sms. Example: false
connecteam_user_note_createAdd a note to a user's profile.WriteCreate User Note
Add a note to a user's profile. Returns data (id, title, text, createdBy, modifiedBy, createdAt, modifiedAt). Get user IDs from connecteam_users_list.
Inputs
textstringrequired- The text of the user note to be created. Example: Please remember to bring your safety vest.
user_idintegerrequired- The unique identifier of user to create note for. Example: 1203456
titlestring- The title of the user note to be created. Example: Morning shift
connecteam_user_updateUpdate one user's name, phone, email, type, custom fields or archived status by user ID (or by phone with edit_users_by_phone).WriteUpdate User
Update one user's name, phone, email, type, custom fields or archived status by user ID (or by phone with edit_users_by_phone). Returns data (count, users). Get user IDs from connecteam_users_list.
- Idempotent
Inputs
custom_fieldsarray- The user's custom fields. Example: [{"customFieldId": 101, "value": "North"}]
edit_users_by_phoneboolean- Optional flag to edit users by phone (default by user id). Example: false
emailstring- The user's email (mandatory for managers and owners) Example: jane@example.com
first_namestring- The user's first name. Example: Jane
include_smart_group_idsboolean- Indicates whether to include smart group IDs in the response body for the updated user(s). Please note that setting this value to true may increase the request time significantly. Example: true
is_archivedboolean- The user status.Note that restoring a user is not applicable with the editUserByPhone field (you must provide the user ID). Example: true
last_namestring- The user's last name. Example: Doe
phone_numberstring- The user's phone number. Example: +15555550101
user_idinteger- The user's unique id. Example: 1203456
user_typestring- The type of the user is 'user' by default. To promote a user to 'admin', first create the user and then use the users/v1/admins endpoint to send an invite by mail. On edit (PUT /users), only 'manager' 'owner' transitions are supported via this field; transitions that cross the user/manager boundary are rejected with 400 and must go through the /admins endpoint. One of: user, manager, owner. Example: userone of
usermanagerowner
connecteam_job_deleteDelete a job.DestructiveDelete Job
Delete a job. Returns requestId, data. Get the job ID from connecteam_jobs_list.
- Idempotent
Inputs
job_idstringrequired- The unique identifier of the job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
connecteam_shift_deleteDelete one shift from a schedule.DestructiveDelete Shift
Delete one shift from a schedule. Returns data (shiftId). Get the shift ID from connecteam_shifts_list.
- Idempotent
Inputs
scheduler_idintegerrequired- The unique identifier of the schedule. Example: 9876543
shift_idstringrequired- The ID of the shift to delete. Example: 64f1c2a9e4b0a1b2c3d4e5f9
notify_usersboolean- Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published. Example: true
connecteam_shifts_deleteDelete several shifts from a schedule in one call.DestructiveDelete Shifts
Delete several shifts from a schedule in one call. Returns data (shiftsIds). Use connecteam_shift_delete for a single shift.
- Idempotent
Inputs
scheduler_idintegerrequired- The unique identifier of the schedule. Example: 9876543
shifts_idsarrayrequired- The unique identifiers of the shifts to delete. Example: ["64f1c2a9e4b0a1b2c3d4e5f9"]
notify_usersboolean- Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published. Example: true
connecteam_task_deleteDelete a task.DestructiveDelete Task
Delete a task. Returns requestId, data. Get the task ID from connecteam_tasks_list.
- Idempotent
Inputs
task_board_idstringrequired- The unique identifier of the taskBoard. Example: 64f1c2a9e4b0a1b2c3d4e5f6
task_idstringrequired- The unique identifier of the task. Example: 64f1c2a9e4b0a1b2c3d4e5f7
connecteam_time_activity_deleteDelete a clocked shift or break from a time clock.DestructiveDelete Time Activity
Delete a clocked shift or break from a time clock. Returns requestId, data. Get the ID from connecteam_time_activities_list.
- Idempotent
Inputs
time_activity_idstringrequired- The unique identifier of the time activity to delete. Example: 64f1c2a9e4b0a1b2c3d4e604
time_clock_idintegerrequired- The unique identifier of the time clock. Example: 1234567
connecteam_users_archiveArchive users, or permanently delete them when deletion_type is delete.DestructiveArchive or Delete Users
Archive users, or permanently delete them when deletion_type is delete. Returns data (success). Archive is reversible with connecteam_user_update; delete cannot be undone. Get user IDs from connecteam_users_list.
- Idempotent
Inputs
user_idsarrayrequired- IDs of the users to archive or delete. Example: [1203456]
deletion_typestring- Determines whether to archive the users or permanently delete the users from the account. Permanent deletion is limited to 25 users per request. One of: archive, delete. Example: archiveone of
archivedelete
No tools match.