Workforce Management

Connecteam

Learn how to use Connecteam with Composio

Overview

SLUG: CONNECTEAM

Description

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

Authentication Details

generic_api_key
stringRequired

Connecting to Connecteam

Create an auth config

Use the dashboard to create an auth config for the Connecteam toolkit. This allows you to connect multiple Connecteam accounts to Composio for agents to use.

1

Select App

Navigate to Connecteam.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Connecteam Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4connecteam_auth_config_id = "ac_YOUR_CONNECTEAM_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Connecteam for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, connecteam_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Connecteam toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["CONNECTEAM"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Archive Users

Description

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

Action Parameters

userIds
arrayRequired

Action Response

data
objectRequired
error
string
requestId
stringRequired
successful
booleanRequired

Tool Name: Create Users

Description

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

Action Parameters

users
arrayRequired

Action Response

data
objectRequired
error
string
requestId
stringRequired
successful
booleanRequired

Tool Name: Generate Upload URL

Description

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

Action Parameters

featureType
stringRequired
fileName
stringRequired
fileTypeHint
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Chat

Description

Tool to retrieve chat conversations. use when you need to list all team chats/channels after confirming your communications hub is on expert plan.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Custom Fields

Description

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

Action Parameters

categoryIds
array
customFieldIds
array
customFieldNames
array
customFieldTypes
array
limit
integerDefaults to 10
offset
integer
order
stringDefaults to asc
sort
string

Action Response

data
objectRequired
error
string
requestId
stringRequired
successful
booleanRequired

Tool Name: Get Custom Field Categories

Description

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

Action Parameters

categoryIds
array
limit
integer
names
array

Action Response

data
objectRequired
error
string
paging
objectRequired
requestId
stringRequired
successful
booleanRequired

Tool Name: Get Forms

Description

Tool to retrieve all form definitions from connecteam. use when you need to list all existing forms after enabling the forms api.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Jobs

Description

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.

Action Parameters

includeDeleted
booleanDefaults to True
instanceIds
array
jobCodes
array
jobIds
array
jobNames
array
limit
integer
offset
integer
order
stringDefaults to asc
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Performance Indicators

Description

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".

Action Parameters

limit
integerDefaults to 10
offset
integer

Action Response

data
objectRequired
error
string
requestId
string
successful
booleanRequired

Tool Name: Get Policy Types

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
requestId
stringRequired
successful
booleanRequired

Tool Name: Get Publishers

Description

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

Action Parameters

limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Schedulers

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Smart Groups

Description

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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Task Boards

Description

Tool to retrieve all task boards. use after authenticating with a valid api key to list available task boards.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Users

Description

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

Action Parameters

createdAt
integer
emailAddresses
array
fullNames
array
limit
integer
modifiedAt
integer
offset
integer
order
stringDefaults to asc
phoneNumbers
array
sort
string
userIds
array
userStatus
string

Action Response

data
objectRequired
error
string
requestId
stringRequired
successful
booleanRequired