# Parma

Parma CRM is a relationship management app designed to help you accelerate growth by deepening and nurturing your business relationships.

- **Category:** crm
- **Auth:** OAUTH2, API_KEY
- **Composio Managed App Available?** No
- **Tools:** 23
- **Triggers:** 0
- **Slug:** `PARMA`
- **Version:** 20260227_00

## Tools

### Add Relationship to Group

**Slug:** `PARMA_ADD_RELATIONSHIP_TO_GROUP`

Tool to add a relationship to a group in Parma. Use when you need to associate an existing relationship with a group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | Unique identifier of the group to add the relationship to |
| `relationship_id` | string | Yes | Unique identifier of the relationship to add to the group |

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

**Slug:** `PARMA_CREATE_NOTE`

Tool to create a new note in the Parma account. Use when you need to add a note linked to specific relationships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The note body content |
| `datetime` | string | No | Custom datetime for the note in ISO 8601 format |
| `relationship_ids` | array | Yes | Array of relationship IDs to link the note to |

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

**Slug:** `PARMA_CREATE_RELATIONSHIP`

Tool to create a new relationship in Parma. Use when you need to add a new person or company to your Parma account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the relationship |
| `type` | string ("person" | "company") | No | Type of relationship to create. |
| `about` | string | No | Description or notes about the relationship |
| `group_ids` | array | Yes | Array of group IDs to add the relationship to |
| `company_id` | integer | No | Company ID if the relationship is a person belonging to a 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 |

### Get data.json metadata

**Slug:** `PARMA_DATA_JSON`

Tool to retrieve DCAT-US 1.1 compliant metadata of all datasets. Use when you need the complete catalog JSON (data.json) from Parma’s open data portal.

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

### Delete Relationship

**Slug:** `PARMA_DELETE_RELATIONSHIP`

Tool to delete a relationship from Parma by its ID. Use when you need to remove an existing relationship between entities. Returns success confirmation after deletion (HTTP 204).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the relationship to delete |

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

**Slug:** `PARMA_GET_PIPELINE`

Tool to retrieve a pipeline by its ID. Use when you need to fetch details about a specific pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the pipeline 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 Relationship

**Slug:** `PARMA_GET_RELATIONSHIP`

Tool to retrieve a relationship by its unique ID. Use when you need to get detailed information about a specific relationship.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the relationship 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 Stage

**Slug:** `PARMA_GET_STAGE`

Tool to retrieve a stage by its unique identifier. Use when you need to fetch details about a specific stage in a pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the stage 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 User by ID

**Slug:** `PARMA_GET_USER`

Tool to retrieve a user by their unique ID. Use when you need to fetch details for a specific user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | 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 User Profile

**Slug:** `PARMA_GET_USER_PROFILE`

Tool to retrieve the authenticated user's profile. Use after obtaining a valid auth token to fetch current user account details.

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

**Slug:** `PARMA_LIST_DEALS`

Tool to retrieve all deals from the Parma account. Use when you need to list deals, filter by pagination, or get an overview of all deals in the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Page number for pagination. Use to retrieve a specific page of deals. |

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

**Slug:** `PARMA_LIST_GROUPS`

Tool to retrieve all groups in the Parma account. Use when you need to list groups, optionally filtered by a search query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Search query to filter groups by name or properties |

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

**Slug:** `PARMA_LIST_NOTES`

Tool to retrieve all notes from the Parma account. Use when you need to list or search through notes associated with relationships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Page number for pagination. Use to navigate through multiple pages of notes. |

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

**Slug:** `PARMA_LIST_PIPELINES`

Tool to list all pipelines in the Parma account. Use when you need to retrieve available pipelines and their details.

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

**Slug:** `PARMA_LIST_RELATIONSHIP_GROUPS`

Tool to retrieve all groups linked to a specific relationship. Use when you need to see which groups are associated with a given relationship ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `relationship_id` | string | Yes | The unique identifier of the relationship to retrieve groups for |

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

**Slug:** `PARMA_LIST_RELATIONSHIP_NOTES`

Tool to list all notes linked to a relationship. Use when you need to retrieve all notes associated with a specific relationship ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Page number for pagination of results |
| `relationship_id` | string | Yes | The unique identifier of the relationship to retrieve notes for |

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

**Slug:** `PARMA_LIST_RELATIONSHIPS`

Tool to list all relationships in the Parma account. Use when you need to retrieve and filter relationships by various criteria such as name, type, or contact details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sms` | string | No | Filter by SMS/phone number |
| `name` | string | No | Filter relationships by name |
| `page` | string | No | Page number for pagination |
| `type` | string | No | Filter relationships by type |
| `email` | string | No | Filter by email address |
| `phone` | string | No | Filter by phone number |
| `twitter` | string | No | Filter by Twitter/X handle or URL |
| `linkedin` | string | No | Filter by LinkedIn profile URL |
| `telegram` | string | No | Filter by Telegram handle |
| `whatsapp` | string | No | Filter by WhatsApp number |
| `instagram` | string | No | Filter by Instagram handle or URL |
| `schedulinglink` | string | No | Filter by scheduling link |

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

**Slug:** `PARMA_LIST_STAGES`

Tool to retrieve all stages in the Parma account. Use when you need to list pipeline stages or check available stage configurations.

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

**Slug:** `PARMA_LIST_USERS`

Tool to list all users in the Parma account. Use when you need to retrieve the complete list of users with their IDs, names, and email addresses.

#### 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 Parma CKAN datasets

**Slug:** `PARMA_PACKAGE_LIST`

Tool to retrieve all dataset identifiers from the Parma CKAN instance. Use when you need to list every available dataset 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 |

### Remove Relationship From Group

**Slug:** `PARMA_REMOVE_RELATIONSHIP_FROM_GROUP`

Tool to remove a relationship from a group. Use when you need to dissociate a relationship from a specific relationship group. Returns success status on completion (HTTP 204).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `relationship_id` | string | Yes | The unique identifier of the relationship to remove from the group |
| `relationship_group_id` | string | Yes | The unique identifier of the group from which to remove the relationship |

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

### Update Note

**Slug:** `PARMA_UPDATE_NOTE`

Tool to update an existing note in the Parma account. Use when you need to modify the content, datetime, or relationships of a specific note.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the note to update |
| `body` | string | No | Updated content/text of the note |
| `datetime` | string | No | Datetime associated with the note (ISO 8601 format) |
| `relationship_ids` | array | No | List of relationship IDs to associate with this note |

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

### Update Relationship

**Slug:** `PARMA_UPDATE_RELATIONSHIP`

Tool to update an existing relationship in the Parma account. Use when you need to modify relationship details such as name, description, type, or associated groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the relationship to update |
| `name` | string | No | Updated name of the relationship |
| `type` | string ("person" | "company") | No | Type of relationship entity. |
| `about` | string | No | Updated description or notes about the relationship |
| `group_ids` | array | No | List of group IDs to associate with this relationship |
| `company_id` | integer | No | Company ID to associate with this relationship |
| `properties` | array | No | Custom properties array for the relationship |

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