> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Parma

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

![Parma logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/parma.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=a97a9832f403fdabe2a98fbbf3cf7ac2)

* **Category:** crm
* **Auth:** OAUTH2, API\_KEY
* **Composio-managed OAuth available?** No
* **Tools:** 23
* **Triggers:** 0
* **Slug:** `PARMA`
* **Version:** 20261101\_00

## Tools

> [accordion] 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
>
> **group\_id** `integer` *required*
>
> Unique identifier of the group to add the relationship to
>
> **relationship\_id** `string` *required*
>
> Unique identifier of the relationship to add to the group
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **body** `string` *required*
>
> The note body content
>
> **datetime** `string`
>
> Custom datetime for the note in ISO 8601 format
>
> **relationship\_ids** `array` *required*
>
> Array of relationship IDs to link the note to
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> The name of the relationship
>
> **type** `string ("person" | "company")`
>
> Type of relationship to create.
>
> **about** `string`
>
> Description or notes about the relationship
>
> **group\_ids** `array` *required*
>
> Array of group IDs to add the relationship to
>
> **company\_id** `integer`
>
> Company ID if the relationship is a person belonging to a company
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get data.json metadata
>
> **Slug:** `PARMA_DATA_JSON`
>
> Retrieve dataset metadata from Parma’s open data portal data.json, returning dataset entries and catalog conformance metadata.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> Unique identifier of the relationship to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> The unique identifier of the pipeline to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> The unique identifier of the relationship to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> The unique identifier of the stage to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> The unique identifier of the user to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Deals
>
> **Slug:** `PARMA_LIST_DEALS`
>
> List deals in the Parma account, optionally selecting a page.
>
> #### Input Parameters
>
> **page** `string`
>
> Page number for pagination. Use to retrieve a specific page of deals.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Groups
>
> **Slug:** `PARMA_LIST_GROUPS`
>
> List groups in the Parma account, optionally filtered by a search query and selected by page.
>
> #### Input Parameters
>
> **page** `string`
>
> Page number for pagination. Use to navigate through multiple pages of groups.
>
> **query** `string`
>
> Search query to filter groups by name or properties
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Notes
>
> **Slug:** `PARMA_LIST_NOTES`
>
> List notes in the Parma account, optionally selecting a page.
>
> #### Input Parameters
>
> **page** `string`
>
> Page number for pagination. Use to navigate through multiple pages of notes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **relationship\_id** `string` *required*
>
> The unique identifier of the relationship to retrieve groups for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Relationship Notes
>
> **Slug:** `PARMA_LIST_RELATIONSHIP_NOTES`
>
> List notes linked to a specific relationship, optionally selecting a page.
>
> #### Input Parameters
>
> **page** `string`
>
> Page number for pagination of results
>
> **relationship\_id** `string` *required*
>
> The unique identifier of the relationship to retrieve notes for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Relationships
>
> **Slug:** `PARMA_LIST_RELATIONSHIPS`
>
> List relationships in the Parma account, with optional filters such as name, type, or contact details. Results can be requested by page.
>
> #### Input Parameters
>
> **sms** `string`
>
> Filter by SMS/phone number
>
> **name** `string`
>
> Filter relationships by name
>
> **page** `string`
>
> Page number for pagination
>
> **type** `string`
>
> Filter relationships by type
>
> **email** `string`
>
> Filter by email address
>
> **phone** `string`
>
> Filter by phone number
>
> **twitter** `string`
>
> Filter by Twitter/X handle or URL
>
> **linkedin** `string`
>
> Filter by LinkedIn profile URL
>
> **telegram** `string`
>
> Filter by Telegram handle
>
> **whatsapp** `string`
>
> Filter by WhatsApp number
>
> **instagram** `string`
>
> Filter by Instagram handle or URL
>
> **schedulinglink** `string`
>
> Filter by scheduling link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Users
>
> **Slug:** `PARMA_LIST_USERS`
>
> List users in the Parma account, including their IDs, names, and email addresses. Results can be requested by page.
>
> #### Input Parameters
>
> **page** `string`
>
> Page number for pagination. Use to navigate through multiple pages of users.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **relationship\_id** `string` *required*
>
> The unique identifier of the relationship to remove from the group
>
> **relationship\_group\_id** `string` *required*
>
> The unique identifier of the group from which to remove the relationship
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> Unique identifier of the note to update
>
> **body** `string`
>
> Updated content/text of the note
>
> **datetime** `string`
>
> Datetime associated with the note (ISO 8601 format)
>
> **relationship\_ids** `array`
>
> List of relationship IDs to associate with this note
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> The unique identifier of the relationship to update
>
> **name** `string`
>
> Updated name of the relationship
>
> **type** `string ("person" | "company")`
>
> Type of relationship entity.
>
> **about** `string`
>
> Updated description or notes about the relationship
>
> **group\_ids** `array`
>
> List of group IDs to associate with this relationship
>
> **company\_id** `integer`
>
> Company ID to associate with this relationship
>
> **properties** `array`
>
> Custom properties array for the relationship
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
