NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Parma connects to a Nagent workspace with OAuth sign-in. Once it is connected, agents can call 23 Parma actions, such as "Add Relationship to Group", "Create Note" and "Create Relationship". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Parma, with input parameters and output schema.
PARMA_ADD_RELATIONSHIP_TO_GROUPTool to add a relationship to a group in Parma. Use when you need to associate an existing relationship with a group.
Input parameters
Unique identifier of the group to add the relationship to
Unique identifier of the relationship to add to the group
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_CREATE_NOTETool to create a new note in the Parma account. Use when you need to add a note linked to specific relationships.
Input parameters
The note body content
Custom datetime for the note in ISO 8601 format
Array of relationship IDs to link the note to
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_CREATE_RELATIONSHIPTool to create a new relationship in Parma. Use when you need to add a new person or company to your Parma account.
Input parameters
The name of the relationship
Type of relationship to create.
Description or notes about the relationship
Array of group IDs to add the relationship to
Company ID if the relationship is a person belonging to a company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_DATA_JSONTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_DELETE_RELATIONSHIPTool 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
Unique identifier of the relationship to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_GET_PIPELINETool to retrieve a pipeline by its ID. Use when you need to fetch details about a specific pipeline.
Input parameters
The unique identifier of the pipeline to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_GET_RELATIONSHIPTool to retrieve a relationship by its unique ID. Use when you need to get detailed information about a specific relationship.
Input parameters
The unique identifier of the relationship to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_GET_STAGETool to retrieve a stage by its unique identifier. Use when you need to fetch details about a specific stage in a pipeline.
Input parameters
The unique identifier of the stage to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_GET_USERTool to retrieve a user by their unique ID. Use when you need to fetch details for a specific user.
Input parameters
The unique identifier of the user to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_GET_USER_PROFILETool to retrieve the authenticated user's profile. Use after obtaining a valid auth token to fetch current user account details.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_LIST_DEALSTool 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
Page number for pagination. Use to retrieve a specific page of deals.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_LIST_GROUPSTool to retrieve all groups in the Parma account. Use when you need to list groups, optionally filtered by a search query.
Input parameters
Page number for pagination. Use to navigate through multiple pages of groups.
Search query to filter groups by name or properties
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_LIST_NOTESTool to retrieve all notes from the Parma account. Use when you need to list or search through notes associated with relationships.
Input parameters
Page number for pagination. Use to navigate through multiple pages of notes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_LIST_PIPELINESTool to list all pipelines in the Parma account. Use when you need to retrieve available pipelines and their details.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_LIST_RELATIONSHIP_GROUPSTool 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
The unique identifier of the relationship to retrieve groups for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_LIST_RELATIONSHIP_NOTESTool to list all notes linked to a relationship. Use when you need to retrieve all notes associated with a specific relationship ID.
Input parameters
Page number for pagination of results
The unique identifier of the relationship to retrieve notes for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_LIST_RELATIONSHIPSTool 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
Filter by SMS/phone number
Filter relationships by name
Page number for pagination
Filter relationships by type
Filter by email address
Filter by phone number
Filter by Twitter/X handle or URL
Filter by LinkedIn profile URL
Filter by Telegram handle
Filter by WhatsApp number
Filter by Instagram handle or URL
Filter by scheduling link
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_LIST_STAGESTool to retrieve all stages in the Parma account. Use when you need to list pipeline stages or check available stage configurations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_LIST_USERSTool 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.
Input parameters
Page number for pagination. Use to navigate through multiple pages of users.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_PACKAGE_LISTTool to retrieve all dataset identifiers from the Parma CKAN instance. Use when you need to list every available dataset ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_REMOVE_RELATIONSHIP_FROM_GROUPTool 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
The unique identifier of the relationship to remove from the group
The unique identifier of the group from which to remove the relationship
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_UPDATE_NOTETool 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
Unique identifier of the note to update
Updated content/text of the note
Datetime associated with the note (ISO 8601 format)
List of relationship IDs to associate with this note
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PARMA_UPDATE_RELATIONSHIPTool 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
The unique identifier of the relationship to update
Updated name of the relationship
Type of relationship entity.
Updated description or notes about the relationship
List of group IDs to associate with this relationship
Company ID to associate with this relationship
Custom properties array for the relationship
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 23 Parma actions on Nagent, including "Add Relationship to Group", "Create Note" and "Create Relationship". Add Relationship to Group: Add a relationship to a group in Parma. Each action is listed on this page with its input parameters and its output.
Parma connects with OAuth sign-in, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Add Relationship to Group takes 2 required inputs: group_id and relationship_id. It returns data, error and successful.