# Connecteam

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

- **Category:** human resources
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 16
- **Triggers:** 0
- **Slug:** `CONNECTEAM`
- **Version:** 20260227_00

## Tools

### Archive Users

**Slug:** `CONNECTEAM_ARCHIVE_USERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `userIds` | array | Yes | List of unique user IDs to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Users

**Slug:** `CONNECTEAM_CREATE_USERS`

Tool to create multiple users in Connecteam. Use when you need to add several staff or admin accounts at once.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `users` | array | Yes | List of users to create in batch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Upload URL

**Slug:** `CONNECTEAM_GENERATE_UPLOAD_URL`

Tool to generate a pre-signed URL for uploading a file. Use when you need a secure, time-limited URL prior to file upload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileName` | string | Yes | Name of the file to be uploaded, e.g., 'document.pdf' |
| `featureType` | string | Yes | Application feature associated with the file, such as 'chat' |
| `fileTypeHint` | string | No | Optional MIME type hint for the file, e.g., 'image/jpeg' or 'application/pdf' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Chat

**Slug:** `CONNECTEAM_GET_CHAT`

Tool to retrieve chat conversations. Use when you need to list all team chats/channels after confirming your Communications hub is on Expert plan.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Field Categories

**Slug:** `CONNECTEAM_GET_CUSTOM_FIELD_CATEGORIES`

Tool to retrieve all custom field categories. Use when you need to list or filter custom field categories in your Connecteam account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of custom field categories to retrieve |
| `names` | array | No | List of custom field category names to filter results |
| `categoryIds` | array | No | List of custom field category IDs to filter results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Fields

**Slug:** `CONNECTEAM_GET_CUSTOM_FIELDS`

Tool to retrieve all custom fields associated with the account. Use when you need to filter, sort, or page through custom fields after authentication.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("id" | "name" | "type") | No | Sort key: 'id', 'name', or 'type' |
| `limit` | integer | No | Maximum number of results per page (1-500) |
| `order` | string ("asc" | "desc") | No | Sort order, only honored if 'sort' is set |
| `offset` | integer | No | Resource offset for pagination (>=0) |
| `categoryIds` | array | No | Custom field category IDs to filter by |
| `customFieldIds` | array | No | Custom field IDs to filter by |
| `customFieldNames` | array | No | Custom field names to filter by |
| `customFieldTypes` | array | No | Custom field types to filter by |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Forms

**Slug:** `CONNECTEAM_GET_FORMS`

Tool to retrieve all form definitions from Connecteam. Use when you need to list all existing forms after enabling the Forms API.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Jobs

**Slug:** `CONNECTEAM_GET_JOBS`

Tool to retrieve a list of job objects relevant to a specific instance ID. Use after confirming scheduler or time clock instance ID when you need to filter and page through jobs.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Performance Indicators

**Slug:** `CONNECTEAM_GET_PERFORMANCE_INDICATORS`

Tool to retrieve the list of performance metric indicators. Use when you need to list available performance indicators for data analysis. Examples: "List performance metrics".

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of performance indicators to return per page (1-100, default is 10) |
| `offset` | integer | No | Resource offset for pagination (>=0, default is 0) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Policy Types

**Slug:** `CONNECTEAM_GET_POLICY_TYPES`

Tool to retrieve available time-off policy types. Use before filtering or creating time-off requests by policyTypeId.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Publishers

**Slug:** `CONNECTEAM_GET_PUBLISHERS`

Tool to retrieve a list of all custom publishers. Use when you need to list custom publishers after confirming API access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of publishers to return per page (1-100). |
| `offset` | integer | No | Offset for pagination; the number of items to skip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Schedulers

**Slug:** `CONNECTEAM_GET_SCHEDULERS`

Tool to retrieve a list of job schedulers associated with the account. Use after authentication when you need to enumerate all schedulers.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Smart Groups

**Slug:** `CONNECTEAM_GET_SMART_GROUPS`

Tool to retrieve all smart groups associated with the account. Use when you need to list all smart groups after authenticating with a valid API key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Task Boards

**Slug:** `CONNECTEAM_GET_TASK_BOARDS`

Tool to retrieve all task boards. Use after authenticating with a valid API key to list available task boards.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Users

**Slug:** `CONNECTEAM_GET_USERS`

Tool to retrieve a list of all users associated with your account. Use when you need to fetch and filter user data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sorting criteria (e.g., creation time) |
| `limit` | integer | No | Maximum number of results per page (1 to 500, default is 10) |
| `order` | string ("asc" | "desc") | No | Order of results. Defaults to ascending. |
| `offset` | integer | No | Resource offset for pagination (>= 0, default is 0) |
| `userIds` | array | No | List of user IDs to filter results |
| `createdAt` | integer | No | Filter users created after a specific Unix timestamp |
| `fullNames` | array | No | Filter by exact full names |
| `modifiedAt` | integer | No | Filter users modified after a specific Unix timestamp |
| `userStatus` | string | No | Filter users by status (e.g., 'active') |
| `phoneNumbers` | array | No | Filter by phone numbers in E.164 format (e.g., +1234567890) |
| `emailAddresses` | array | No | Filter by email addresses |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Me

**Slug:** `CONNECTEAM_LIST_ME`

Tool to retrieve account information including company name and company ID. Use when you need to get details about the authenticated account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |