Magnetic

Learn how to use Magnetic with Composio

Overview

SLUG: MAGNETIC

Description

Magnetic is an all-in-one platform designed to help professional services firms manage projects, resources, and finances efficiently.

Authentication Details

generic_api_key
stringRequired

Connecting to Magnetic

Create an auth config

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

1

Select App

Navigate to Magnetic.

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 Magnetic 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
4magnetic_auth_config_id = "ac_YOUR_MAGNETIC_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 Magnetic 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, magnetic_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 Magnetic 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=["MAGNETIC"])
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: Get Current Follow-ups

Description

Tool to retrieve upcoming follow-ups assigned to the authenticated user. use after authentication to view scheduled tasks.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Client Contacts

Description

Tool to search contacts by field or client id. use when you need to retrieve client contacts matching given criteria after authentication.

Action Parameters

clientId
integer
field
string
limit
integer
offset
integer
value
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact Tags

Description

Tool to get all tags associated with a contact. use after confirming the contactid to list contact tags.

Action Parameters

contactId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Magnetic Groupings

Description

Tool to retrieve a list of groupings. use after authentication when you need to select a grouping to comment on.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Grouping Statuses

Description

Tool to retrieve the list of statuses for signed groupings. use after authentication when you need available grouping status options for tasks or jobs.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Grouping Tags

Description

Tool to retrieve tags associated with any groupings owned by the company. use after authentication when grouping tags are needed.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Magnetic Opportunity Statuses

Description

Tool to retrieve opportunity statuses. use when you need current status options for unsigned groupings (opportunities).

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Magnetic Task

Description

Tool to retrieve a task by its id. use after confirming you have the taskid.

Action Parameters

taskId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Magnetic User by ID

Description

Tool to get a magnetic user's details by id. use after confirming a valid user id to fetch their profile.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Users

Description

Tool to retrieve the list of all users in the authenticated user's company. use after authentication to audit or manage user accounts.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Grouping Custom Field Definitions

Description

Tool to retrieve all custom field definitions for groupings. use after authentication when you need to fetch available grouping custom field definitions for tasks.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Magnetic Tasks

Description

Tool to search tasks by a specified field and value. use when you need to filter and page tasks after authentication.

Action Parameters

field_name
string
field_value
string
page
integer
page_size
integer
sort_field
string
sort_order
string

Action Response

data
objectRequired
error
string
successful
booleanRequired