> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Connecteam

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.

**Authentication:** API Key
**Categories:** Productivity, Communication
**Tools:** 59: 32 read, 21 write, 6 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CONNECTEAM)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Connecteam connection

   In **AgentKit > Connections**, create a Connecteam connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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.actions

   const connector = 'connecteam'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { 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 call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'connecteam_account_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_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.actions

   connection_name = "connecteam"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_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 call
   result = actions.execute_tool(
       tool_input={},
       tool_name="connecteam_account_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Connecteam credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'connecteam_account_get',
  toolInput: {},
  connector: 'connecteam',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="connecteam_account_get",
    tool_input={},
    connection_name="connecteam",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `connecteam_account_get`

Get Account · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `connecteam_conversations_list`

List Conversations · Read-only

List chat conversations (teams and channels) in the account.
Returns data (conversations).
Use this to get a conversation ID for connecteam_conversation_message_send.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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

Example input: `{}`

### `connecteam_daily_note_get`

Get Daily Note · Read-only

Get one daily note by ID.
Returns data (id, title, qualifiedUserIds, qualifiedGroupIds, dates).
Use this after connecteam_daily_note_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `note_id` (`integer`, required): The unique identifier of the note. Example: 64f1c2a9e4b0a1b2c3d4e605

Example input: `{"note_id":1}`

### `connecteam_documents_list`

List Documents · Read-only

List the company document templates.
Returns data (documents).
Use this to see which documents can be pushed to users.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `document_ids` (`array`, optional): Only include these document ids. Example: [12345]
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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

Example input: `{}`

### `connecteam_form_get`

Get Form · Read-only

Get one form with its questions.
Returns data (formId, formName, createdAt, lastUpdatedAt, questions, settings).
Get the form ID from connecteam_forms_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `form_id` (`integer`, required): Form id to return. Example: 4455667

Example input: `{"form_id":4455667}`

### `connecteam_form_submission_get`

Get Form Submission · Read-only

Get one form submission with all its answers.
Returns data (formSubmission).
Get the IDs from connecteam_form_submissions_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `form_id` (`integer`, required): Form Id. Example: 4455667
- `form_submission_id` (`string`, required): Filter by Form submission id. Example: 64f1c2a9e4b0a1b2c3d4e600

Example input: `{"form_id":4455667,"form_submission_id":"<form_submission_id>"}`

### `connecteam_form_submissions_list`

List Form Submissions · Read-only

List submissions of a form, optionally by user or submission time.
Returns data (formSubmissions).
Use connecteam_form_submission_get for one submission's answers.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `form_id` (`integer`, required): Filter by Form Id. Example: 4455667
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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_time` (`integer`, optional): Filter form submissions that were submitted until this timestamp. Example: 10
- `submitting_start_timestamp` (`integer`, optional): Filter form submissions that were submitted from this timestamp. Example: 10
- `user_ids` (`array`, optional): Filter by submitting user ids. Example: [1203456]

Example input: `{"form_id":4455667}`

### `connecteam_forms_list`

List Forms · Read-only

List the forms (checklists, reports, surveys) in the account.
Returns data (forms).
Use this to get a form ID for connecteam_form_submissions_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, optional): Filter forms created on or before this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive. Example: 2026-02-03
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `name` (`string`, optional): The name of the form to filter by (partial, case-insensitive match) Example: Example name
- `offset` (`integer`, optional): 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_date` (`string`, optional): Filter forms created on or after this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive. Example: 2026-02-02

Example input: `{}`

### `connecteam_job_get`

Get Job · Read-only

Get one job by ID.
Returns data (job).
Get the job ID from connecteam_jobs_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): The unique identifier of the job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Example input: `{"job_id":"<job_id>"}`

### `connecteam_jobs_list`

List Jobs · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include_deleted` (`boolean`, optional): Determines whether the response includes jobs that have been deleted. Default value is set to true. Example: true
- `instance_ids` (`array`, optional): List of instance IDs (schedule id or time clock id) to filter by. Example: [9876543]
- `job_codes` (`array`, optional): 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_ids` (`array`, optional): 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_names` (`array`, optional): 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"]
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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
- `order` (`string`, optional): Sort order, set only if sort key is set. One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `sort` (`string`, optional): Sort key. One of: title. Example: title. One of: `title`.

Example input: `{}`

### `connecteam_onboarding_packs_list`

List Onboarding Packs · Read-only

List onboarding packs.
Returns data (packs).
Use this to get a pack ID for connecteam_onboarding_pack_assign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `connecteam_pending_users_list`

List Pending Users · Read-only

List pending user requests that are waiting for approval.
Returns data (pendingUsers).
Use connecteam_users_list for active users.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `ids` (`array`, optional): Filter by pending user IDs. Default: all. Example: [12345]
- `status` (`string`, optional): Filter by status: 'pending', 'approved', or 'declined'. Default: all statuses. One of: approved, declined, pending. Example: approved. One of: `approved`, `declined`, `pending`.

Example input: `{}`

### `connecteam_publishers_list`

List Publishers · Read-only

List custom publishers (sender identities used for API chat messages).
Returns data (publishers).
Use this to get the sender ID for the message tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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

Example input: `{}`

### `connecteam_schedulers_list`

List Schedules · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `connecteam_shift_get`

Get Shift · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `scheduler_id` (`integer`, required): The unique identifier of the schedule. Example: 9876543
- `shift_id` (`string`, required): The unique identifier of the shift. Example: 64f1c2a9e4b0a1b2c3d4e5f9

Example input: `{"scheduler_id":9876543,"shift_id":"<shift_id>"}`

### `connecteam_shift_layers_list`

List Shift Layers · Read-only

List the shift layers (extra shift info fields) configured for a schedule.
Returns data (shiftLayers).
Get the scheduler ID from connecteam_schedulers_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `scheduler_id` (`integer`, required): The unique identifier of the schedule. Example: 9876543

Example input: `{"scheduler_id":9876543}`

### `connecteam_shifts_list`

List Shifts · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_time` (`integer`, required): The end time to filter by in Unix format (in seconds). The range cannot exceed 92 days unless shiftId is provided. Example: 1767283200
- `scheduler_id` (`integer`, required): The unique identifier of the schedule. Example: 9876543
- `start_time` (`integer`, required): 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_ids` (`array`, optional): List of user IDs. Example: [1203456]
- `is_open_shift` (`boolean`, optional): Filter shifts that are open shifts. Example: true
- `is_published` (`boolean`, optional): Filter shifts that are published. Example: true
- `is_require_admin_approval` (`boolean`, optional): Filter shifts that require admin approval. Example: true
- `job_id` (`array`, optional): List of job IDs. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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
- `order` (`string`, optional): Sort order, set only if sort key is set. One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `shift_id` (`array`, optional): List of shift IDs. Example: 64f1c2a9e4b0a1b2c3d4e5f9
- `sort` (`string`, optional): Sort key. One of: created_at, updated_at. Example: created_at. One of: `created_at`, `updated_at`.
- `title` (`string`, optional): Title of the shift. Example: Morning shift

Example input: `{"end_time":1767283200,"scheduler_id":9876543,"start_time":1767254400}`

### `connecteam_smart_groups_list`

List Smart Groups · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, optional): The unique identifier of the smart group. Example: 12345
- `name` (`string`, optional): The name of the smart group to filter by. Example: Example name

Example input: `{}`

### `connecteam_subtasks_list`

List Sub-Tasks · Read-only

List the sub-tasks of a task.
Returns data (subTasks).
Get the task ID from connecteam_tasks_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_board_id` (`string`, required): The unique identifier of the task board. Example: 64f1c2a9e4b0a1b2c3d4e5f6
- `task_id` (`string`, required): The unique identifier of the parent task. Example: 64f1c2a9e4b0a1b2c3d4e5f7
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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_ids` (`array`, optional): Optional list of subtask IDs to filter by. Example: ["value"]

Example input: `{"task_board_id":"<task_board_id>","task_id":"<task_id>"}`

### `connecteam_task_labels_list`

List Task Labels · Read-only

List the labels defined on a task board.
Returns data (labels).
Use this to get label IDs for connecteam_task_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_board_id` (`string`, required): The unique identifier of the task board to filter by. Example: 64f1c2a9e4b0a1b2c3d4e5f6
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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
- `title` (`string`, optional): The title (name) of the label to filter by. Example: Morning shift

Example input: `{"task_board_id":"<task_board_id>"}`

### `connecteam_taskboards_list`

List Task Boards · Read-only

List the task boards in the account.
Returns data (taskBoards).
Use this to get a task board ID for the task tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `connecteam_tasks_list`

List Tasks · Read-only

List tasks on a task board, optionally by status, user or label.
Returns data (tasks).
Get the task board ID from connecteam_taskboards_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_board_id` (`string`, required): The unique identifier of the taskBoard. Example: 64f1c2a9e4b0a1b2c3d4e5f6
- `label_ids` (`array`, optional): List of label IDs to filter by. Tasks retrieved will include the specified label(s), but may also include additional labels. Example: ["64f1c2a9e4b0a1b2c3d4e606"]
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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
- `status` (`string`, optional): draft/published/completed/all - all is by default. One of: draft, published, completed, all. Example: all. One of: `draft`, `published`, `completed`, `all`.
- `task_ids` (`array`, optional): List of task IDs to filter by. Example: ["value"]
- `user_ids` (`array`, optional): List of assigned user IDs on the task to filter by. Group tasks will be also included in the results. Example: [1203456]

Example input: `{"task_board_id":"<task_board_id>"}`

### `connecteam_time_activities_list`

List Time Activities · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): The end time to filter by in ISO 8601 format (YYYY-MM-DD) Example: 2026-02-03
- `start_date` (`string`, required): The start time to filter by in ISO 8601 format (YYYY-MM-DD) Example: 2026-02-02
- `time_clock_id` (`integer`, required): The unique identifier of the time clock. Example: 1234567
- `activity_types` (`array`, optional): The time activity types: shift, manual_break or time_off. Example: ["shift"]
- `job_ids` (`array`, optional): The job IDs of shifts. Example: ["value"]
- `manual_break_ids` (`array`, optional): The manual break IDs of manual breaks. Example: ["value"]
- `policy_type_ids` (`array`, optional): The policy type IDs of time offs. Example: ["value"]
- `user_ids` (`array`, optional): 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]

Example input: `{"end_date":"<end_date>","start_date":"<start_date>","time_clock_id":1234567}`

### `connecteam_time_clocks_list`

List Time Clocks · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `connecteam_time_off_balances_list`

List Time Off Balances · Read-only

List users' time off balances for one policy type.
Returns data (balances).
Get the policy type ID from connecteam_time_off_policy_types_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `policy_type_id` (`string`, required): Policy type id. Example: 64f1c2a9e4b0a1b2c3d4e602
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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_ids` (`array`, optional): List of user ids. Example: [1203456]

Example input: `{"policy_type_id":"<policy_type_id>"}`

### `connecteam_time_off_policy_types_list`

List Time Off Policy Types · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `connecteam_time_off_requests_list`

List Time Off Requests · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): 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_date` (`string`, required): Start of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Any request overlapping [startDate, endDate] is returned. Example: 2026-02-02
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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
- `statuses` (`array`, optional): Filter by status. Allowed: approved, pending, denied. Repeat the param for multiple values. Defaults to ['approved'] when omitted. Example: []
- `user_ids` (`array`, optional): Filter by one or more employee IDs. Omit to include all employees. Example: [1203456]

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `connecteam_timesheet_totals_get`

Get Timesheet Totals · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): 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_date` (`string`, required): 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_id` (`integer`, required): The unique identifier of the time clock. Example: 1234567
- `group_ids` (`array`, optional): 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_actual` (`boolean`, optional): 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_approved` (`boolean`, optional): 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_locked` (`boolean`, optional): 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_submitted` (`boolean`, optional): 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_ids` (`array`, optional): 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_ids` (`array`, optional): 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]

Example input: `{"end_date":"<end_date>","start_date":"<start_date>","time_clock_id":1234567}`

### `connecteam_user_assignments_list`

List User Assignments · Read-only

List the schedules, time clocks and other assets a user is assigned to.
Returns data (smartGroups, assets).
Get user IDs from connecteam_users_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `asset_types` (`array`, required): Specify the asset types for which you wish to retrieve details. Multiple asset types can be selected. Example: ["quickTasks"]
- `user_id` (`integer`, required): The unique identifier of the user. Example: 1203456

Example input: `{"asset_types":["quickTasks"],"user_id":1203456}`

### `connecteam_user_custom_fields_list`

List User Custom Fields · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category_ids` (`array`, optional): Custom field category ids to filter by. Example: [12345]
- `custom_field_ids` (`array`, optional): Custom field ids to filter by. Example: [12345]
- `custom_field_names` (`array`, optional): Custom field names to filter by. Example: ["value"]
- `custom_field_types` (`array`, optional): Custom field types to filter by. Example: ["email"]
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `offset` (`integer`, optional): 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
- `order` (`string`, optional): Sort order, set only if sort key is set. One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `sort` (`string`, optional): Sort key. One of: id, name, type. Example: id. One of: `id`, `name`, `type`.

Example input: `{}`

### `connecteam_user_unavailabilities_list`

List User Unavailabilities · Read-only

List the times users marked themselves unavailable in a date range.
Returns data (userUnavailabilities).
Use this before assigning shifts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_time` (`integer`, required): The end time to filter by in Unix format (in seconds) Example: 1767283200
- `start_time` (`integer`, required): The start time to filter by in Unix format (in seconds) Example: 1767254400
- `user_id` (`integer`, required): The unique identifier of the user. Example: 1203456

Example input: `{"end_time":1767283200,"start_time":1767254400,"user_id":1203456}`

### `connecteam_users_list`

List Users · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `archived_at` (`integer`, optional): Parameter specifying the date in Unix format (in seconds). Only users archived after this date will be included in the results. Example: 1735689600
- `created_at` (`integer`, optional): Parameter specifying the date in Unix format (in seconds). Only users created after this date will be included in the results. Example: 1735689600
- `email_addresses` (`array`, optional): List of email addresses to filter by (in format test@test.com). Example: ["jane@example.com"]
- `full_names` (`array`, optional): 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_login` (`integer`, optional): 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
- `limit` (`integer`, optional): The maximum number of results to display per page. Example: 50
- `modified_at` (`integer`, optional): 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
- `offset` (`integer`, optional): 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
- `order` (`string`, optional): Sort order, set only if sort key is set. One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `phone_numbers` (`array`, optional): List of phone numbers to filter by (in format + ). Example: ["+15555550101"]
- `sort` (`string`, optional): Sort key. One of: created_at. Example: created_at. One of: `created_at`.
- `user_ids` (`array`, optional): List of user IDs for filtering. Example: [1203456]
- `user_status` (`string`, optional): Filter users by status. Default is active. One of: active, archived, all. Example: active. One of: `active`, `archived`, `all`.

Example input: `{}`

### `connecteam_clock_in`

Clock In · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `time_clock_id` (`integer`, required): The unique identifier of the time clock. Example: 1234567
- `user_id` (`integer`, required): The unique identifier of the user. Make sure the user is assigned to the specified time clock. Example: 1203456
- `job_id` (`string`, optional): 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_data` (`object`, optional): 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_id` (`string`, optional): The scheduled shift from the schedule associated with the clocking in event. Example: 64f1c2a9e4b0a1b2c3d4e5f9
- `timestamp` (`integer`, optional): 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
- `timezone` (`string`, optional): 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

Example input: `{"time_clock_id":1234567,"user_id":1203456}`

### `connecteam_clock_out`

Clock Out · Write

Clock a user out on a time clock, optionally saving shift attachment values.
Returns data (shift).
Use after connecteam_clock_in.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `time_clock_id` (`integer`, required): The unique identifier of the time clock. Example: 1234567
- `user_id` (`integer`, required): The unique identifier of the user. Make sure the user is assigned to the specified time clock. Example: 1203456
- `location_data` (`object`, optional): GPS data associated with the clocking out event. Example: {"isReferencedToJob": false, "gps": {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}}
- `shift_attachments` (`array`, optional): 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: []
- `timestamp` (`integer`, optional): 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
- `timezone` (`string`, optional): 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

Example input: `{"time_clock_id":1234567,"user_id":1203456}`

### `connecteam_conversation_create`

Create Conversation · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `title` (`string`, required): The conversation title shown in the chat clients. Must be non-empty after trimming whitespace. Example: Morning shift
- `type` (`string`, required): The conversation type. team = collaborative chat, all members can send messages. channel = broadcast group, only admins can send messages. One of: team, channel. Example: team. One of: `team`, `channel`.
- `admin_user_ids` (`array`, optional): 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_ids` (`array`, optional): 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_ids` (`array`, optional): Individual user IDs assigned as members. At least one of assignedUserIds or assignedSmartGroupIds must be provided. Defaults to an empty array. Example: [1203456]
- `is_locked` (`boolean`, optional): Whether the conversation is created locked (members cannot send messages until an admin unlocks it). Defaults to unlocked. Example: true
- `is_members_hidden` (`boolean`, optional): Whether the member list is hidden from members in the chat clients. Defaults to false. Example: false

Example input: `{"title":"<title>","type":"team"}`

### `connecteam_conversation_message_send`

Send Conversation Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `conversation_id` (`string`, required): The unique identifier of the conversation. Example: 64f1c2a9e4b0a1b2c3d4e601
- `sender_id` (`integer`, required): The unique identifier of the sender (custom publisher). The custom publishers page can be found in the UI under Settings -> Feed settings. Example: 556677
- `text` (`string`, required): 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.
- `attachments` (`array`, optional): List of attachments to be associated with the message. Example: []

Example input: `{"conversation_id":"<conversation_id>","sender_id":556677,"text":"<text>"}`

### `connecteam_daily_note_create`

Create Daily Note · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): The date for the note in ISO 8601 format (e.g. YYYY-MM-DD) Example: 2026-02-02
- `instance_id` (`integer`, required): The unique identifier of the schedule. Example: 9876543
- `title` (`string`, required): The title of the note. Example: Morning shift
- `qualified_group_ids` (`array`, optional): The groups qualified to see the note. Example: []
- `qualified_user_ids` (`array`, optional): The users qualified to see the note. Example: [1203456]

Example input: `{"date":"<date>","instance_id":9876543,"title":"<title>"}`

### `connecteam_job_create`

Create Job · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `title` (`string`, required): The title of the job. Example: Morning shift
- `assign` (`object`, optional): Data related to job assignment. Example: {"type": "users", "userIds": [1203456]}
- `code` (`string`, optional): The code of the job. Example: J-100
- `color` (`string`, optional): 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_fields` (`array`, optional): The job's custom fields. Example: [{"customFieldId": 101, "value": "North"}]
- `description` (`string`, optional): The description of the job. Example: Downtown warehouse
- `fence_size` (`integer`, optional): The geofence size of the job. Example: 100
- `gps` (`object`, optional): The GPS data of the job. Example: {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}
- `instance_ids` (`array`, optional): List of instance IDs (schedule id or time clock id) Example: [9876543]
- `parent_id` (`string`, optional): The ID of the parent job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567899
- `sub_jobs` (`array`, optional): List of sub jobs to create. Example: []
- `use_parent_data` (`boolean`, optional): Indicates whether to use the parent job's data or not. Example: true

Example input: `{"title":"<title>"}`

### `connecteam_job_update`

Update Job · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): The unique identifier of the job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
- `assign` (`object`, optional): Settings related to job assignment. Omit to keep the job's current assign. Example: {"type": "users", "userIds": [1203456]}
- `code` (`string`, optional): The code of the job. Example: J-100
- `color` (`string`, optional): 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_fields` (`array`, optional): The job's custom fields. Example: [{"customFieldId": 101, "value": "North"}]
- `description` (`string`, optional): The description of the job. Example: Downtown warehouse
- `fence_size` (`integer`, optional): The geofence size of the job. Example: 100
- `gps` (`object`, optional): The GPS data of the job. Example: {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}
- `instance_ids` (`array`, optional): 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_id` (`string`, optional): The ID of the parent job, if any. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567899
- `title` (`string`, optional): The title of the job. Example: Morning shift
- `use_parent_data` (`boolean`, optional): Indicates whether to use the parent job's data or not. Example: true

Example input: `{"job_id":"<job_id>"}`

### `connecteam_onboarding_pack_assign`

Assign Onboarding Pack · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `pack_id` (`integer`, required): The onboarding pack ID. Example: 2233445
- `user_ids` (`array`, required): List of user IDs to assign (max: 500) Example: [1203456]

Example input: `{"pack_id":2233445,"user_ids":[1203456]}`

### `connecteam_private_message_send`

Send Private Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `sender_id` (`integer`, required): The unique identifier of the sender (custom publisher). The custom publishers page can be found in the UI under Settings -> Feed settings. Example: 556677
- `text` (`string`, required): 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_id` (`integer`, required): The unique identifier of the user. Example: 1203456
- `attachments` (`array`, optional): List of attachments to be associated with the message. Example: []

Example input: `{"sender_id":556677,"text":"<text>","user_id":1203456}`

### `connecteam_shift_create`

Create Shift · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `end_time` (`integer`, required): The end time of the shift in Unix format (in seconds) Example: 1767283200
- `scheduler_id` (`integer`, required): The unique identifier of the schedule. Example: 9876543
- `start_time` (`integer`, required): The start time of the shift in Unix format (in seconds) Example: 1767254400
- `assigned_user_ids` (`array`, optional): 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]
- `breaks` (`array`, optional): A list of breaks to create for the shift. Example: [{"name": "Lunch", "type": "unpaid", "duration": 30}]
- `color` (`string`, optional): 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_fields` (`array`, optional): Custom field values for the shift. Example: [{"customFieldId": 101, "value": "North"}]
- `is_open_shift` (`boolean`, optional): Indicates whether the shift is an open shift. Creates only with 1 open spot. Example: false
- `is_published` (`boolean`, optional): Indicates whether the shift is published. Example: false
- `is_require_admin_approval` (`boolean`, optional): Indicates whether admin approval is required for claiming the shift. Can only be set if the shift is an open shift. Example: true
- `job_id` (`string`, optional): The ID of the associated job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
- `location_data` (`object`, optional): The location data for the shift. Example: {"isReferencedToJob": false, "gps": {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}}
- `notes` (`array`, optional): Additional notes for the shift. Example: [{"html": "Open the store
"}]
- `notify_users` (`boolean`, optional): Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published. Example: true
- `open_spots` (`integer`, optional): The number of open spots for the shift. Can only be set for open shifts. Example: 2
- `shift_details` (`object`, optional): The additional details on the shift, if applicable. Example: {}
- `statuses` (`array`, optional): The list of statuses associated with the shift. Example: []
- `tasks` (`array`, optional): The list of tasks associated with the shift. Example: [{"title": "Count the register"}]
- `timezone` (`string`, optional): 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
- `title` (`string`, optional): The title of the shift, If this field remains empty, the jobId field must be specified. Example: Morning shift

Example input: `{"end_time":1767283200,"scheduler_id":9876543,"start_time":1767254400}`

### `connecteam_shift_update`

Update Shift · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `scheduler_id` (`integer`, required): The unique identifier of the schedule. Example: 9876543
- `shift_id` (`string`, required): The unique identifier of the shift. Example: 64f1c2a9e4b0a1b2c3d4e5f9
- `assigned_user_ids` (`array`, optional): 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]
- `breaks` (`array`, optional): The list of breaks for the shift. Example: [{"name": "Lunch", "type": "unpaid", "duration": 30}]
- `color` (`string`, optional): 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_fields` (`array`, optional): Custom field values for the shift. Example: [{"customFieldId": 101, "value": "North"}]
- `end_time` (`integer`, optional): The end time of the shift in Unix format (in seconds) Example: 1767283200
- `is_edit_for_all_users` (`boolean`, optional): 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_shift` (`boolean`, optional): Indicates whether the shift is an open shift. Creates only with 1 open spot. Example: true
- `is_published` (`boolean`, optional): Indicates whether the shift is published. Example: true
- `is_require_admin_approval` (`boolean`, optional): Indicates whether admin approval is required for the shift. Can only be set if the shift is an open shift. Example: true
- `job_id` (`string`, optional): The ID of the associated job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
- `location_data` (`object`, optional): The location data for the shift. Example: {"isReferencedToJob": false, "gps": {"address": "1 Main St, Springfield", "latitude": 40.7, "longitude": -74.0}}
- `notes` (`array`, optional): Additional notes for the shift. Example: [{"html": "Open the store
"}]
- `notify_users` (`boolean`, optional): Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published. Example: true
- `open_spots` (`integer`, optional): 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_time` (`integer`, optional): The start time of the shift in Unix format (in seconds) Example: 1767254400
- `tasks` (`array`, optional): 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"}]
- `timezone` (`string`, optional): The timezone in Tz format (e.g. America/New_York) Example: America/New_York
- `title` (`string`, optional): The title of the shift. Example: Morning shift

Example input: `{"scheduler_id":9876543,"shift_id":"<shift_id>"}`

### `connecteam_subtask_create`

Create Sub-Task · Write

Add a sub-task to a task.
Returns data (id, title, isCompleted).
Get the task ID from connecteam_tasks_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `task_board_id` (`string`, required): The unique identifier of the task board. Example: 64f1c2a9e4b0a1b2c3d4e5f6
- `task_id` (`string`, required): The unique identifier of the parent task. Example: 64f1c2a9e4b0a1b2c3d4e5f7
- `title` (`string`, required): The title of the sub task. Example: Morning shift
- `is_completed` (`boolean`, optional): Indicates whether the status of the sub-task is set to completed. Example: false

Example input: `{"task_board_id":"<task_board_id>","task_id":"<task_id>","title":"<title>"}`

### `connecteam_task_create`

Create Task · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `status` (`string`, required): The status of the task. One of: draft, published, completed. Example: draft. One of: `draft`, `published`, `completed`.
- `task_board_id` (`string`, required): The unique identifier of the taskBoard. Example: 64f1c2a9e4b0a1b2c3d4e5f6
- `title` (`string`, required): The title of the task. Example: Morning shift
- `user_ids` (`array`, required): 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]
- `description` (`object`, optional): Specifies additional description on the task. Example: {"content": "Restock aisle 4"}
- `due_date` (`integer`, optional): The due date of the task in Unix format (in seconds) Example: 1767340800
- `is_archived` (`boolean`, optional): Indicates if the task is archived. Example: false
- `label_ids` (`array`, optional): List of labels IDs associated with the task. Example: ["64f1c2a9e4b0a1b2c3d4e606"]
- `start_time` (`integer`, optional): The start time of the task in Unix format (in seconds) Example: 1767254400
- `sub_tasks` (`array`, optional): List of subtasks associated with the task. Example: [{"title": "Check stock"}]
- `type` (`string`, optional): The type of the task. Currently set to 'oneTime' by default. One of: oneTime, recurring. Example: oneTime. One of: `oneTime`, `recurring`.

Example input: `{"status":"draft","task_board_id":"<task_board_id>","title":"<title>","user_ids":[1203456]}`

### `connecteam_task_update`

Update Task · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `status` (`string`, required): The status of the task. One of: draft, published, completed. Example: draft. One of: `draft`, `published`, `completed`.
- `task_board_id` (`string`, required): The unique identifier of the taskBoard. Example: 64f1c2a9e4b0a1b2c3d4e5f6
- `task_id` (`string`, required): The unique identifier of the task. Example: 64f1c2a9e4b0a1b2c3d4e5f7
- `title` (`string`, required): The title of the task. Example: Morning shift
- `user_ids` (`array`, required): 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]
- `description` (`object`, optional): Specifies additional description on the task. Example: {"content": "Restock aisle 4"}
- `due_date` (`integer`, optional): The due date of the task in Unix format (in seconds) Example: 1767340800
- `is_archived` (`boolean`, optional): Indicates if the task is archived. Example: false
- `label_ids` (`array`, optional): List of labels IDs associated with the task. Example: ["64f1c2a9e4b0a1b2c3d4e606"]
- `start_time` (`integer`, optional): The start time of the task in Unix format (in seconds) Example: 1767254400
- `sub_tasks` (`array`, optional): List of subtasks associated with the task. Example: [{"title": "Check stock"}]
- `type` (`string`, optional): The type of the task. Currently set to 'oneTime' by default. One of: oneTime, recurring. Example: oneTime. One of: `oneTime`, `recurring`.

Example input: `{"status":"draft","task_board_id":"<task_board_id>","task_id":"<task_id>","title":"<title>","user_ids":[1203456]}`

### `connecteam_time_activities_create`

Create Time Activities · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `time_activities` (`array`, required): 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_id` (`integer`, required): The unique identifier of the time clock. Example: 1234567
- `is_split_shift_on_manual_break` (`boolean`, optional): 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

Example input: `{"time_activities":[],"time_clock_id":1234567}`

### `connecteam_time_activities_update`

Update Time Activities · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `time_activities` (`array`, required): List of time activities of the users. Example: [{"userId": 1203456, "shifts": [{"id": "64f1c2a9e4b0a1b2c3d4e604", "end": {"timestamp": 1767283200, "timezone": "America/New_York"}}]}]
- `time_clock_id` (`integer`, required): The unique identifier of the time clock. Example: 1234567

Example input: `{"time_activities":[],"time_clock_id":1234567}`

### `connecteam_time_off_request_create`

Create Time Off Request · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `end_date` (`string`, required): 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_day` (`boolean`, required): 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_id` (`string`, required): The ID of the policy type. Example: 64f1c2a9e4b0a1b2c3d4e602
- `start_date` (`string`, required): The start date of the time off in ISO format (YYYY-MM-DD) Example: 2026-02-02
- `status` (`string`, required): The status of the time off request. One of: approved, pending, denied. Example: approved. One of: `approved`, `pending`, `denied`.
- `timezone` (`string`, required): The timezone in Tz format (e.g. America/New_York) Example: America/New_York
- `user_id` (`integer`, required): The ID of the user to create the time off request. Example: 1203456
- `employee_note` (`string`, optional): Employee note providing additional details. Example: Doctor appointment
- `end_time` (`string`, optional): 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_saving` (`boolean`, optional): 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_note` (`string`, optional): Manager note providing additional details. Example: Approved
- `start_time` (`string`, optional): 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_id` (`integer`, optional): The unique identifier of the time clock where the time off will be presented in the timesheet. Example: 1234567

Example input: `{"end_date":"<end_date>","is_all_day":true,"policy_type_id":"<policy_type_id>","start_date":"<start_date>","status":"approved","timezone":"<timezone>","user_id":1203456}`

### `connecteam_time_off_request_update`

Update Time Off Request · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `request_id` (`string`, required): The unique identifier of the time off request. Example: 64f1c2a9e4b0a1b2c3d4e603
- `end_date` (`string`, optional): 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_time` (`string`, optional): 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_saving` (`boolean`, optional): 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_day` (`boolean`, optional): Specifies the type of the time period. If set to false, start and end time fields must be specified. Example: true
- `manager_note` (`string`, optional): Manager note providing additional details. Example: Approved
- `start_date` (`string`, optional): The start date of the time off in ISO format (YYYY-MM-DD) Example: 2026-02-02
- `start_time` (`string`, optional): The start time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false. Example: 1767254400
- `status` (`string`, optional): The status of the time off request. One of: approved, pending, denied. Example: approved. One of: `approved`, `pending`, `denied`.
- `time_clock_id` (`integer`, optional): The unique identifier of the time clock where the time off will be presented in the timesheet. Example: 1234567
- `timezone` (`string`, optional): The timezone in Tz format (e.g. America/New_York) Example: America/New_York

Example input: `{"request_id":"<request_id>"}`

### `connecteam_user_create`

Create User · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `first_name` (`string`, required): The user's first name. Example: Jane
- `last_name` (`string`, required): The user's last name. Example: Doe
- `phone_number` (`string`, required): The user's phone number. Example: +15555550101
- `user_type` (`string`, required): 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: user. One of: `user`, `manager`, `owner`.
- `custom_fields` (`array`, optional): The user's custom fields. Example: [{"customFieldId": 101, "value": "North"}]
- `email` (`string`, optional): The user's email (mandatory for managers and owners) Example: jane@example.com
- `is_archived` (`boolean`, optional): The user's archived status. Example: false
- `send_activation` (`boolean`, optional): Optional flag to send activation sms. Example: false

Example input: `{"first_name":"<first_name>","last_name":"<last_name>","phone_number":"<phone_number>","user_type":"user"}`

### `connecteam_user_note_create`

Create User Note · Write

Add a note to a user's profile.
Returns data (id, title, text, createdBy, modifiedBy, createdAt, modifiedAt).
Get user IDs from connecteam_users_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `text` (`string`, required): The text of the user note to be created. Example: Please remember to bring your safety vest.
- `user_id` (`integer`, required): The unique identifier of user to create note for. Example: 1203456
- `title` (`string`, optional): The title of the user note to be created. Example: Morning shift

Example input: `{"text":"<text>","user_id":1203456}`

### `connecteam_user_update`

Update User · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `custom_fields` (`array`, optional): The user's custom fields. Example: [{"customFieldId": 101, "value": "North"}]
- `edit_users_by_phone` (`boolean`, optional): Optional flag to edit users by phone (default by user id). Example: false
- `email` (`string`, optional): The user's email (mandatory for managers and owners) Example: jane@example.com
- `first_name` (`string`, optional): The user's first name. Example: Jane
- `include_smart_group_ids` (`boolean`, optional): 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_archived` (`boolean`, optional): The user status.Note that restoring a user is not applicable with the editUserByPhone field (you must provide the user ID). Example: true
- `last_name` (`string`, optional): The user's last name. Example: Doe
- `phone_number` (`string`, optional): The user's phone number. Example: +15555550101
- `user_id` (`integer`, optional): The user's unique id. Example: 1203456
- `user_type` (`string`, optional): 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: user. One of: `user`, `manager`, `owner`.

Example input: `{}`

### `connecteam_job_delete`

Delete Job · Destructive

Delete a job.
Returns requestId, data.
Get the job ID from connecteam_jobs_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): The unique identifier of the job. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Example input: `{"job_id":"<job_id>"}`

### `connecteam_shift_delete`

Delete Shift · Destructive

Delete one shift from a schedule.
Returns data (shiftId).
Get the shift ID from connecteam_shifts_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `scheduler_id` (`integer`, required): The unique identifier of the schedule. Example: 9876543
- `shift_id` (`string`, required): The ID of the shift to delete. Example: 64f1c2a9e4b0a1b2c3d4e5f9
- `notify_users` (`boolean`, optional): Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published. Example: true

Example input: `{"scheduler_id":9876543,"shift_id":"<shift_id>"}`

### `connecteam_shifts_delete`

Delete Shifts · Destructive

Delete several shifts from a schedule in one call.
Returns data (shiftsIds).
Use connecteam_shift_delete for a single shift.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `scheduler_id` (`integer`, required): The unique identifier of the schedule. Example: 9876543
- `shifts_ids` (`array`, required): The unique identifiers of the shifts to delete. Example: ["64f1c2a9e4b0a1b2c3d4e5f9"]
- `notify_users` (`boolean`, optional): Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published. Example: true

Example input: `{"scheduler_id":9876543,"shifts_ids":["64f1c2a9e4b0a1b2c3d4e5f9"]}`

### `connecteam_task_delete`

Delete Task · Destructive

Delete a task.
Returns requestId, data.
Get the task ID from connecteam_tasks_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `task_board_id` (`string`, required): The unique identifier of the taskBoard. Example: 64f1c2a9e4b0a1b2c3d4e5f6
- `task_id` (`string`, required): The unique identifier of the task. Example: 64f1c2a9e4b0a1b2c3d4e5f7

Example input: `{"task_board_id":"<task_board_id>","task_id":"<task_id>"}`

### `connecteam_time_activity_delete`

Delete Time Activity · Destructive

Delete a clocked shift or break from a time clock.
Returns requestId, data.
Get the ID from connecteam_time_activities_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `time_activity_id` (`string`, required): The unique identifier of the time activity to delete. Example: 64f1c2a9e4b0a1b2c3d4e604
- `time_clock_id` (`integer`, required): The unique identifier of the time clock. Example: 1234567

Example input: `{"time_activity_id":"<time_activity_id>","time_clock_id":1234567}`

### `connecteam_users_archive`

Archive or Delete Users · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `user_ids` (`array`, required): IDs of the users to archive or delete. Example: [1203456]
- `deletion_type` (`string`, optional): 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: archive. One of: `archive`, `delete`.

Example input: `{"user_ids":[1203456]}`

## Related

Other Productivity connectors ([all 203](/agentkit/connectors/?category=productivity)):

- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Notion](/agentkit/connectors/notion/): Scalekit connector, OAuth, 51 tools
- [Google Workspace (DWD)](/agentkit/connectors/googledwd/): Scalekit connector, Service account, 100 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
