{
  "service": "jiminny",
  "displayName": "Jiminny",
  "categories": [
    "Data",
    "Marketing"
  ],
  "authTypes": [
    "api_key"
  ],
  "auth": [
    {
      "type": "api_key",
      "label": "API Key",
      "placeholder": "JIMINNY_API_KEY",
      "description": "Jiminny API key sent as a Bearer token. Admins and owners can generate it in Jiminny under Organisation Settings > General > API Key: https://help.jiminny.com/en/articles/9527212-what-is-the-jiminny-api",
      "extraFields": [
        {
          "key": "region",
          "label": "Region",
          "inputType": "text",
          "required": false,
          "secret": false,
          "placeholder": "us",
          "description": "Jiminny API region for your account. Use us for https://app.jiminny.com or eu for https://app.jiminny.eu."
        }
      ]
    }
  ],
  "homepageUrl": "https://jiminny.com",
  "actions": [
    {
      "id": "jiminny.get_action_items",
      "service": "jiminny",
      "name": "get_action_items",
      "description": "Retrieve generated action items for a Jiminny activity.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "activityId": {
            "type": "string",
            "description": "The Jiminny activity UUID to retrieve reporting data for.",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "description": "Activity action item lookup parameters."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "actionItems": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "content": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "description": "One action item."
                    },
                    "description": "Action item text entries returned by Jiminny."
                  }
                },
                "additionalProperties": true,
                "description": "The action items payload returned by Jiminny."
              },
              {
                "type": "null"
              }
            ]
          },
          "actionItemsStatus": {
            "type": "string",
            "enum": [
              "available",
              "not_available",
              "generating"
            ],
            "description": "Whether Jiminny returned action items, has no action items, or is still generating it."
          }
        },
        "additionalProperties": false,
        "description": "The Jiminny action items response."
      }
    },
    {
      "id": "jiminny.get_activity",
      "service": "jiminny",
      "name": "get_activity",
      "description": "Retrieve one Jiminny activity by activity UUID.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "activityId": {
            "type": "string",
            "description": "The Jiminny activity UUID to retrieve reporting data for.",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "description": "Activity lookup parameters."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "activity": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The activity payload returned by Jiminny."
          }
        },
        "additionalProperties": false,
        "description": "The Jiminny activity response."
      }
    },
    {
      "id": "jiminny.get_ai_scorecard",
      "service": "jiminny",
      "name": "get_ai_scorecard",
      "description": "Retrieve AI scorecard results for a Jiminny activity.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "activityId": {
            "type": "string",
            "description": "The Jiminny activity UUID to retrieve reporting data for.",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "description": "Activity AI scorecard lookup parameters."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "aiScorecard": {
            "anyOf": [
              {
                "type": "object",
                "properties": {},
                "additionalProperties": true,
                "description": "The AI scorecard result returned by Jiminny."
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false,
        "description": "The Jiminny AI scorecard response."
      }
    },
    {
      "id": "jiminny.get_current_organization",
      "service": "jiminny",
      "name": "get_current_organization",
      "description": "Return the current authenticated Jiminny organization.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false,
        "description": "No input is required to retrieve the current organization."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "organization": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The organization payload returned by Jiminny."
          }
        },
        "additionalProperties": false,
        "description": "The current Jiminny organization."
      }
    },
    {
      "id": "jiminny.get_summary",
      "service": "jiminny",
      "name": "get_summary",
      "description": "Retrieve the generated summary for a Jiminny activity.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "activityId": {
            "type": "string",
            "description": "The Jiminny activity UUID to retrieve reporting data for.",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "description": "Activity summary lookup parameters."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "summary": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "content": {
                    "type": "string",
                    "description": "The generated summary content."
                  }
                },
                "additionalProperties": true,
                "description": "The summary payload returned by Jiminny, including content when available."
              },
              {
                "type": "null"
              }
            ]
          },
          "summaryStatus": {
            "type": "string",
            "enum": [
              "available",
              "not_available",
              "generating"
            ],
            "description": "Whether Jiminny returned a summary, has no a summary, or is still generating it."
          }
        },
        "additionalProperties": false,
        "description": "The Jiminny summary response."
      }
    },
    {
      "id": "jiminny.get_transcription",
      "service": "jiminny",
      "name": "get_transcription",
      "description": "Retrieve transcription segments for a Jiminny activity.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "activityId": {
            "type": "string",
            "description": "The Jiminny activity UUID to retrieve reporting data for.",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "description": "Activity transcription lookup parameters."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "segments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Jiminny transcription segment."
            },
            "description": "Transcription segments returned by Jiminny."
          }
        },
        "additionalProperties": false,
        "description": "The Jiminny transcription response."
      }
    },
    {
      "id": "jiminny.list_activities",
      "service": "jiminny",
      "name": "list_activities",
      "description": "List completed and processed Jiminny activities with date and CRM filters.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "fromDate": {
            "type": "string",
            "minLength": 1,
            "description": "Filter activities that happened on or after this UTC date-time. Use with toDate."
          },
          "toDate": {
            "type": "string",
            "minLength": 1,
            "description": "Filter activities that happened on or before this UTC date-time. Use with fromDate."
          },
          "updatedFrom": {
            "type": "string",
            "minLength": 1,
            "description": "Filter activities updated on or after this UTC date-time. Use with updatedTo when available."
          },
          "updatedTo": {
            "type": "string",
            "minLength": 1,
            "description": "Filter activities updated on or before this UTC date-time. Jiminny defaults it when omitted."
          },
          "status": {
            "type": "string",
            "enum": [
              "received",
              "sent",
              "delivered",
              "in-progress",
              "completed"
            ],
            "description": "Filter activities by Jiminny processing status."
          },
          "page": {
            "type": "integer",
            "minimum": 1,
            "description": "Page number to retrieve. Jiminny pages start at 1."
          },
          "accountId": {
            "type": "string",
            "minLength": 1,
            "description": "Filter activities by the external CRM account ID scoped to the Jiminny organization."
          },
          "opportunityId": {
            "type": "string",
            "minLength": 1,
            "description": "Filter activities by the external CRM opportunity or deal ID scoped to the Jiminny organization."
          }
        },
        "additionalProperties": false,
        "description": "Filters for listing completed and processed Jiminny activities. Provide either fromDate and toDate, or updatedFrom with optional updatedTo.",
        "anyOf": [
          {
            "required": [
              "fromDate",
              "toDate"
            ]
          },
          {
            "required": [
              "updatedFrom"
            ]
          }
        ]
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "activities": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Jiminny activity record."
            },
            "description": "Activities returned by Jiminny."
          },
          "metadata": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "Pagination metadata returned by Jiminny, including page, pageSize, maxPage, and nextPage when available."
          },
          "failed": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "The upstream record ID that failed while building the response."
            },
            "description": "Upstream record IDs that Jiminny could not build for the current page."
          }
        },
        "additionalProperties": false,
        "required": [
          "activities"
        ],
        "description": "The Jiminny activities page."
      }
    },
    {
      "id": "jiminny.list_ai_scorecards",
      "service": "jiminny",
      "name": "list_ai_scorecards",
      "description": "List Jiminny AI scorecard results completed within a date range.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "fromDate": {
            "type": "string",
            "minLength": 1,
            "description": "Start of the UTC date-time range accepted by Jiminny."
          },
          "toDate": {
            "type": "string",
            "minLength": 1,
            "description": "End of the UTC date-time range accepted by Jiminny."
          },
          "page": {
            "type": "integer",
            "minimum": 1,
            "description": "Page number to retrieve. Jiminny pages start at 1."
          }
        },
        "additionalProperties": false,
        "required": [
          "fromDate",
          "toDate"
        ],
        "description": "Date range and page filters for listing Jiminny AI scorecard results."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "scorecardResults": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Jiminny AI scorecard result."
            },
            "description": "AI scorecard results returned by Jiminny."
          },
          "metadata": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "Pagination metadata returned by Jiminny, including page, pageSize, maxPage, and nextPage when available."
          }
        },
        "additionalProperties": false,
        "required": [
          "scorecardResults"
        ],
        "description": "The Jiminny AI scorecards page."
      }
    },
    {
      "id": "jiminny.list_automated_call_scoring",
      "service": "jiminny",
      "name": "list_automated_call_scoring",
      "description": "List Jiminny automated call scoring records with optional filters.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "description": "Filter results by Jiminny user UUID.",
            "format": "uuid"
          },
          "fromDate": {
            "type": "string",
            "minLength": 1,
            "description": "Start of the UTC date-time range accepted by Jiminny."
          },
          "toDate": {
            "type": "string",
            "minLength": 1,
            "description": "End of the UTC date-time range accepted by Jiminny."
          }
        },
        "additionalProperties": false,
        "description": "Optional user and date filters for a Jiminny reporting endpoint."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "scoringResults": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Jiminny automated call scoring record."
            },
            "description": "Automated call scoring records returned by Jiminny."
          },
          "metadata": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "Pagination metadata returned by Jiminny, including page, pageSize, maxPage, and nextPage when available."
          },
          "failed": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "The upstream record ID that failed while building the response."
            },
            "description": "Upstream record IDs that Jiminny could not build for the current page."
          }
        },
        "additionalProperties": false,
        "required": [
          "scoringResults"
        ],
        "description": "The Jiminny automated call scoring page."
      }
    },
    {
      "id": "jiminny.list_coaching_feedback",
      "service": "jiminny",
      "name": "list_coaching_feedback",
      "description": "List Jiminny coaching feedback records for a required date range.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "fromDate": {
            "type": "string",
            "minLength": 1,
            "description": "Start of the UTC date-time range accepted by Jiminny."
          },
          "toDate": {
            "type": "string",
            "minLength": 1,
            "description": "End of the UTC date-time range accepted by Jiminny."
          },
          "coachId": {
            "type": "string",
            "description": "Filter coaching feedback by Jiminny coach user UUID.",
            "format": "uuid"
          },
          "coacheeId": {
            "type": "string",
            "description": "Filter coaching feedback by Jiminny coachee user UUID.",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "required": [
          "fromDate",
          "toDate"
        ],
        "description": "Date range and optional coach filters for listing Jiminny coaching feedback."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "coachingFeedback": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Jiminny coaching feedback record."
            },
            "description": "Coaching feedback records returned by Jiminny."
          },
          "metadata": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "Pagination metadata returned by Jiminny, including page, pageSize, maxPage, and nextPage when available."
          },
          "failed": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "The upstream record ID that failed while building the response."
            },
            "description": "Upstream record IDs that Jiminny could not build for the current page."
          }
        },
        "additionalProperties": false,
        "required": [
          "coachingFeedback"
        ],
        "description": "The Jiminny coaching feedback page."
      }
    },
    {
      "id": "jiminny.list_comments",
      "service": "jiminny",
      "name": "list_comments",
      "description": "List Jiminny activity comments with optional user and date filters.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "description": "Filter results by Jiminny user UUID.",
            "format": "uuid"
          },
          "fromDate": {
            "type": "string",
            "minLength": 1,
            "description": "Start of the UTC date-time range accepted by Jiminny."
          },
          "toDate": {
            "type": "string",
            "minLength": 1,
            "description": "End of the UTC date-time range accepted by Jiminny."
          }
        },
        "additionalProperties": false,
        "description": "Optional user and date filters for a Jiminny reporting endpoint."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "comments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Jiminny activity comment record."
            },
            "description": "Comment records returned by Jiminny."
          },
          "metadata": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "Pagination metadata returned by Jiminny, including page, pageSize, maxPage, and nextPage when available."
          },
          "failed": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "The upstream record ID that failed while building the response."
            },
            "description": "Upstream record IDs that Jiminny could not build for the current page."
          }
        },
        "additionalProperties": false,
        "required": [
          "comments"
        ],
        "description": "The Jiminny comments page."
      }
    },
    {
      "id": "jiminny.list_listens",
      "service": "jiminny",
      "name": "list_listens",
      "description": "List listened activity data for a Jiminny date range.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "fromDate": {
            "type": "string",
            "minLength": 1,
            "description": "Start of the UTC date-time range accepted by Jiminny."
          },
          "toDate": {
            "type": "string",
            "minLength": 1,
            "description": "End of the UTC date-time range accepted by Jiminny."
          },
          "userId": {
            "type": "string",
            "description": "Filter listened activity data by Jiminny user UUID.",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "required": [
          "fromDate",
          "toDate"
        ],
        "description": "Date range and optional user filter for listing Jiminny listened activity data."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "listens": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Jiminny listened activity record."
            },
            "description": "Listened activity records returned by Jiminny."
          },
          "metadata": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "Pagination metadata returned by Jiminny, including page, pageSize, maxPage, and nextPage when available."
          },
          "failed": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "The upstream record ID that failed while building the response."
            },
            "description": "Upstream record IDs that Jiminny could not build for the current page."
          }
        },
        "additionalProperties": false,
        "required": [
          "listens"
        ],
        "description": "The Jiminny listened activity data page."
      }
    },
    {
      "id": "jiminny.list_matched_topic_triggers",
      "service": "jiminny",
      "name": "list_matched_topic_triggers",
      "description": "List topic trigger matches for a Jiminny activity.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "activityId": {
            "type": "string",
            "description": "The Jiminny activity UUID to retrieve reporting data for.",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "description": "Activity matched topic trigger lookup parameters."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "matchedTopicTriggers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One matched Jiminny topic trigger record."
            },
            "description": "Topic trigger matches returned by Jiminny for the activity."
          }
        },
        "additionalProperties": false,
        "description": "The matched Jiminny topic triggers response."
      }
    },
    {
      "id": "jiminny.list_questions",
      "service": "jiminny",
      "name": "list_questions",
      "description": "List playback questions detected in a Jiminny activity.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "activityId": {
            "type": "string",
            "description": "The Jiminny activity UUID to retrieve reporting data for.",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "description": "Activity playback question lookup parameters."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Jiminny playback question."
            },
            "description": "Playback questions returned by Jiminny."
          }
        },
        "additionalProperties": false,
        "description": "The Jiminny playback questions response."
      }
    },
    {
      "id": "jiminny.list_topic_triggers",
      "service": "jiminny",
      "name": "list_topic_triggers",
      "description": "List Jiminny topic trigger definitions for the authenticated organization.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false,
        "description": "No input is required to list Jiminny topic triggers."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "topicTriggers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Jiminny topic trigger definition."
            },
            "description": "Topic trigger definitions returned by Jiminny."
          }
        },
        "additionalProperties": false,
        "description": "The Jiminny topic triggers response."
      }
    },
    {
      "id": "jiminny.list_users",
      "service": "jiminny",
      "name": "list_users",
      "description": "List Jiminny users for the authenticated organization.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false,
        "description": "No input is required to list Jiminny users."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "users": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Jiminny user record."
            },
            "description": "Users returned by Jiminny."
          },
          "links": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "Navigation links returned by Jiminny for the users response."
          }
        },
        "additionalProperties": false,
        "required": [
          "users"
        ],
        "description": "The Jiminny users response."
      }
    }
  ]
}
