Crm

Folk

Learn how to use Folk with Composio

Overview

SLUG: FOLK

Description

folk is a next-generation CRM designed for teams to manage and nurture their relationships efficiently.

Authentication Details

generic_api_key
stringRequired

Connecting to Folk

Create an auth config

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

1

Select App

Navigate to Folk.

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 Folk 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
4folk_auth_config_id = "ac_YOUR_FOLK_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": user_api_key}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Folk 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, folk_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 Folk 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=["FOLK"])
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: Create Company

Description

Tool to create a new company in the workspace. use after gathering all required company details and ensuring the name is unique.

Action Parameters

addresses
array
customFieldValues
object
description
string
emails
array
groups
array
name
stringRequired
phones
array
urls
array

Action Response

data
objectRequired
deprecations
array
error
string
successful
booleanRequired

Tool Name: Delete Company

Description

Tool to delete a company from the workspace (irreversible). use after confirming this company should be removed.

Action Parameters

company_id
stringRequired

Action Response

data
objectRequired
deprecations
array
error
string
successful
booleanRequired

Tool Name: Delete Person

Description

Tool to delete an existing person in the workspace (irreversible). use after confirming this person should be permanently removed.

Action Parameters

person_id
stringRequired

Action Response

data
objectRequired
deprecations
array
error
string
successful
booleanRequired

Tool Name: List Companies

Description

Tool to list companies in the workspace. use when you need a paginated overview of companies, optionally filtered.

Action Parameters

combinator
stringDefaults to and
cursor
string
filter
object
limit
integerDefaults to 20

Action Response

data
objectRequired
deprecations
array
error
string
successful
booleanRequired

Tool Name: Get Company

Description

Tool to retrieve an existing company by its id. use after authentication has been verified.

Action Parameters

company_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Current Workspace User

Description

Tool to get details of the current authenticated workspace user. use after authentication to retrieve the user's profile information.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Person

Description

Tool to retrieve an existing person by their id. use when you need full profile details of a person by their unique identifier.

Action Parameters

person_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Groups

Description

Tool to list workspace groups. use when you need to retrieve a paginated list of all workspace groups after authentication.

Action Parameters

cursor
string
limit
integerDefaults to 20

Action Response

data
objectRequired
deprecations
array
error
string
successful
booleanRequired

Tool Name: List People

Description

Tool to list people in the workspace. use when you need to paginate through contacts after authentication.

Action Parameters

combinator
stringDefaults to and
cursor
string
filter
object
limit
integerDefaults to 20

Action Response

data
objectRequired
deprecations
array
error
string
successful
booleanRequired

Tool Name: List Users

Description

Tool to list workspace users. use when you need to paginate through users list.

Action Parameters

cursor
string
limit
integerDefaults to 20

Action Response

data
objectRequired
deprecations
array
error
string
successful
booleanRequired

Tool Name: Update Company

Description

Tool to update an existing company in the workspace. use after confirming the company id; only provided fields are updated and list fields replace existing values.

Action Parameters

addresses
array
company_id
stringRequired
customFieldValues
object
description
string
emails
array
groups
array
name
string
phones
array
urls
array

Action Response

data
objectRequired
deprecations
array
error
string
successful
booleanRequired

Tool Name: List Group Custom Fields

Description

Tool to list custom fields for a specific group and entity type. use after selecting a group and entity type to inspect available custom fields.

Action Parameters

cursor
string
entity_type
stringRequired
group_id
stringRequired
limit
integerDefaults to 20

Action Response

data
objectRequired
deprecations
array
error
string
successful
booleanRequired