# Suitedash

All-in-one business software for client management, CRM, project management, and invoicing

- **Category:** productivity
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `SUITEDASH`
- **Version:** 00000000_00

## Tools

### Create Company

**Slug:** `SUITEDASH_CREATE_COMPANY`

Tool to create a new company in SuiteDash CRM. Use when you need to add a new Lead, Client, or Prospect company to the system. You can optionally specify primary contact information when creating the company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the company to create |
| `role` | string ("Lead" | "Client" | "Prospect") | Yes | Role/status of the company in the CRM: Lead, Client, or Prospect |
| `primaryContact` | object | No | Primary contact details for the company |

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

**Slug:** `SUITEDASH_CREATE_CONTACT`

Tool to create a new contact in SuiteDash CRM. Use when you need to add a new Lead, Client, or Prospect contact to the system. Requires first name, last name, role, and email address for all contact types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("Lead" | "Client" | "Prospect") | Yes | Role/status of the contact in the CRM: Lead, Client, or Prospect |
| `email` | string | Yes | Email address of the contact. Required for all roles including Lead. |
| `last_name` | string | Yes | Last name of the contact |
| `first_name` | string | Yes | First name of the contact |
| `send_welcome_email` | boolean | No | Whether to send a Portal Access Invitation email to the contact. If not specified, defaults to the system default setting. |

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

**Slug:** `SUITEDASH_GET_COMPANY`

Tool to retrieve a single company by UID or Name from SuiteDash. Use when you need to fetch detailed information about a specific company including contact details, address, tags, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | string | No | Set to 'yes' to receive meta information about attributes |
| `identifier` | string | Yes | Company UID or Name 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 Company Meta Attributes

**Slug:** `SUITEDASH_GET_COMPANY_META`

Tool to retrieve CRM company meta attributes information. Returns a complete schema of all the CRM Company Custom Fields that exist in the account along with all the Meta Attributes including field types, formats, validation rules, and allowed operations.

#### 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 by UID or Email

**Slug:** `SUITEDASH_GET_CONTACT`

Tool to retrieve a single contact from SuiteDash by their UID or email address. Use when you need to fetch detailed information about a specific contact including their personal details, contact information, address, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | string | No | Set to 'yes' to receive meta information about contact attributes. When enabled, provides additional metadata about the contact fields and structure |
| `identifier` | string | Yes | Contact UID (unique identifier) or email address. Can be either a UUID string (e.g., 'b9d7def5-a852-4230-b6a7-513b8f124fa1') or an email address (e.g., 'user@example.com') |

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

**Slug:** `SUITEDASH_GET_CONTACT_META`

Tool to retrieve CRM contact meta attributes information. Returns a complete schema of all the CRM Contact Custom Fields that exist in the account along with all the Meta Attributes including field types, formats, validation rules, and allowed operations.

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

Tool to retrieve all existing companies from SuiteDash. Returns a paginated list with optional filtering by creation date and ordering options. Use this when you need to list, search, or export companies. Note that idle companies are not included in the results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | string | No | Set to 'yes' to receive meta information about attributes in the response. Use this when you need additional metadata about the fields. |
| `page` | integer | No | Page number for pagination. Must be a positive integer. |
| `orderBy` | string ("created" | "created.desc" | "name" | "name.desc") | No | Enum for ordering options |
| `createdMax` | string | No | Upper bound for filtering by creation date-time in RFC3339 format (e.g., '2024-12-31T23:59:59Z'). Returns only companies created on or before this date. |
| `createdMin` | string | No | Lower bound for filtering by creation date-time in RFC3339 format (e.g., '2024-01-01T00:00:00Z'). Returns only companies created on or after this date. |

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

**Slug:** `SUITEDASH_LIST_CONTACTS`

Tool to get all existing contacts from SuiteDash. Returns a paginated list of contacts with optional filtering by creation date and custom ordering. Use when you need to retrieve, browse, or export contact lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | string ("yes" | "no") | No | Meta parameter options. |
| `page` | integer | No | Page number for pagination. Use to navigate through multiple pages of results. |
| `orderBy` | string ("created" | "created.desc" | "name" | "name.desc") | No | Order options for contacts listing. |
| `createdMax` | string | No | Upper bound for filtering by creation date-time in RFC3339 format (e.g., '2024-12-31T23:59:59Z'). Returns contacts created on or before this date. |
| `createdMin` | string | No | Lower bound for filtering by creation date-time in RFC3339 format (e.g., '2024-01-01T00:00:00Z'). Returns contacts created on or after this date. |

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