# Magnetic

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

- **Category:** project management
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 16
- **Triggers:** 0
- **Slug:** `MAGNETIC`
- **Version:** 20260312_00

## Tools

### Get Current Follow-ups

**Slug:** `MAGNETIC_CLIENTS_GET_CURRENT_FOLLOWUPS`

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

#### 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 |

### Search Client Contacts

**Slug:** `MAGNETIC_CLIENTS_SEARCH_CONTACTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field` | string | No | The contact field to search by (e.g., 'email', 'name'). |
| `limit` | integer | No | Maximum number of results to return. |
| `value` | string | No | The value to match in the specified field. |
| `offset` | integer | No | Number of items to skip for pagination. |
| `clientId` | integer | No | Filter results to contacts belonging to this client ID. |

#### 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 Magnetic Grouping

**Slug:** `MAGNETIC_CREATE_GROUPING`

Tool to create a new opportunity or job (grouping) in Magnetic HQ. Use when you need to organize tasks and track project progress for a new opportunity or job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the new opportunity or job grouping |
| `extra` | string | No | Description or additional details about the opportunity/job |
| `owner` | object | Yes | The user who will be the owner of this grouping. Must provide user ID. |
| `contact` | object | No | Contact object to associate with the grouping. |
| `contactCompany` | object | No | Company object to associate with the grouping. |

#### 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 Magnetic Task

**Slug:** `MAGNETIC_CREATE_TASK`

Tool to create a new task in Magnetic HQ. Use when you need to add tasks to the system, optionally assigning them to users or linking to opportunities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task` | string | Yes | Name of the task to create. This is the primary identifier displayed for the task. |
| `user` | object | No | Reference to a user to assign the task to. |
| `endDate` | string | No | End date or due date for the task in ISO 8601 format (e.g., '2024-01-20T17:00:00Z'). |
| `billable` | boolean | No | Whether time tracked on this task should be billable. Set to true for client-billable work. |
| `grouping` | object | No | Reference to a grouping/opportunity to associate with the task. |
| `startDate` | string | No | Start date for the task in ISO 8601 format (e.g., '2024-01-15T09:00:00Z'). |
| `description` | string | No | Detailed description of the task. Can contain additional context or instructions. |
| `timeMinutes` | integer | No | Amount of time already tracked on this task, in minutes. |
| `effortMinutes` | integer | No | Estimated effort for this task, in minutes. Used for time estimation and planning. |

#### 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 Contact Tags

**Slug:** `MAGNETIC_GET_CONTACT_TAGS`

Tool to get all tags associated with a contact. Use after confirming the contactId to list contact tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactId` | integer | Yes | Unique ID of the contact whose tags to retrieve. |

#### 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 Magnetic Grouping by ID

**Slug:** `MAGNETIC_GET_GROUPING_BY_ID`

Tool to retrieve details for a specific grouping (opportunity/job) by its ID. Use when you need detailed information about a specific grouping.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique ID of the grouping/opportunity to retrieve (must be positive). |

#### 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 Grouping Statuses

**Slug:** `MAGNETIC_GET_GROUPING_STATUSES`

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

#### 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 Grouping Tags

**Slug:** `MAGNETIC_GET_GROUPING_TAGS`

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

#### 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 Magnetic Opportunity Statuses

**Slug:** `MAGNETIC_GET_OPPORTUNITY_STATUSES`

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

#### 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 Magnetic Task

**Slug:** `MAGNETIC_GET_TASK`

Tool to retrieve a task by its ID. Use after confirming you have the taskId.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | The unique ID of the task to retrieve (must be positive). |

#### 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 User by ID

**Slug:** `MAGNETIC_GET_USER_BY_ID`

Tool to retrieve details for a specific Magnetic user by their ID. Use when you need to fetch a user's profile information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the user to retrieve |

#### 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:** `MAGNETIC_GET_USERS`

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

#### 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 Companies

**Slug:** `MAGNETIC_LIST_COMPANIES`

Tool to retrieve all companies from the Magnetic HQ account. Use after authentication to view all client companies.

#### 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 Grouping Custom Field Definitions

**Slug:** `MAGNETIC_TASKS_GET_GROUPING_CUSTOM_FIELD_DEFINITIONS`

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

#### 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 |