{
  "opencollection": "1.0.0",
  "info": {
    "name": "Proton Call Notes Opportunities API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Api-Key",
      "value": "{{X-Api-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Opportunities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Opportunity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.proton.ai/:company/opportunities",
            "headers": [
              {
                "name": "X-User-Id",
                "value": ""
              },
              {
                "name": "X-Company",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "We think of an opportunity which could be in serveral possible discreet stages as defined initially.\nRequest Body fields\n\npipeline_id: The uid of the pipline in which this opportunity gets created.\nstage_id: The id of the stage in which this opportunity is created.\ntitle : Title of the opportunity\nowner : List of user ids (generally emails) for the owners of the opportunities\ncustomer_id : Customer or Account id for which this opportunity is meant to be\ncontact_id: The id of the contact associat"
        },
        {
          "info": {
            "name": "Get Opportunity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.proton.ai/:company/opportunities/:opportunity_id",
            "headers": [
              {
                "name": "X-User-Id",
                "value": ""
              },
              {
                "name": "X-Company",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company",
                "value": "",
                "type": "path"
              },
              {
                "name": "opportunity_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Opportunity"
        },
        {
          "info": {
            "name": "Update Opportunity",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.proton.ai/:company/opportunities/:opportunity_id",
            "headers": [
              {
                "name": "X-User-Id",
                "value": ""
              },
              {
                "name": "X-Company",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company",
                "value": "",
                "type": "path"
              },
              {
                "name": "opportunity_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Update Opportunity"
        },
        {
          "info": {
            "name": "Delete Opportunity",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.proton.ai/:company/opportunities/:opportunity_id",
            "headers": [
              {
                "name": "X-User-Id",
                "value": ""
              },
              {
                "name": "X-Company",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company",
                "value": "",
                "type": "path"
              },
              {
                "name": "opportunity_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete Opportunity"
        },
        {
          "info": {
            "name": "Get Opportunity Activity Feed",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.proton.ai/:company/opportunities/:opportunity_id/activity_feed",
            "headers": [
              {
                "name": "X-User-Id",
                "value": ""
              },
              {
                "name": "X-Company",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company",
                "value": "",
                "type": "path"
              },
              {
                "name": "opportunity_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Opportunity Activity Feed"
        },
        {
          "info": {
            "name": "Search Opportunities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.proton.ai/:company/opportunities/search",
            "headers": [
              {
                "name": "X-User-Id",
                "value": ""
              },
              {
                "name": "X-Company",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "The search route allows users to query opportunities based on various attributes using a structured filtering syntax. Each attribute can be filtered using specific operators that act on the values of the fields within an opportunity. The operators define conditions such as equality, inequality, containment, and comparisons.\nConstructing Queries\nQuery Syntax\nQueries are constructed as JSON objects where each key corresponds to an opportunity attribute, and the value is another JSON object specify"
        },
        {
          "info": {
            "name": "Export Opportunities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.proton.ai/:company/pipelines/:pipeline_id/export",
            "headers": [
              {
                "name": "X-User-Id",
                "value": ""
              },
              {
                "name": "X-Company",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company",
                "value": "",
                "type": "path"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "The search route allows users to query opportunities based on various attributes using a structured filtering syntax. Each attribute can be filtered using specific operators that act on the values of the fields within an opportunity. The operators define conditions such as equality, inequality, containment, and comparisons.\nConstructing Queries\nQuery Syntax\nQueries are constructed as JSON objects where each key corresponds to an opportunity attribute, and the value is another JSON object specify"
        },
        {
          "info": {
            "name": "Calculate Pipeline Metrics",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.proton.ai/:company/pipelines/:pipeline_id/metrics",
            "headers": [
              {
                "name": "X-User-Id",
                "value": ""
              },
              {
                "name": "X-Company",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company",
                "value": "",
                "type": "path"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Given a search query (like the /search endpoint), this API endpoint calculates and returns the total count, total value, and forecasted value of opportunities within a specific pipeline and satisfying the search query. The calculation takes into account the stages of opportunities and their respective probabilities of closing.\n\nTotal Count: The aggregate number of opportunities within the pipeline.\nTotal Value: The total financial value of the pipeline.\nForecast Value: A predictive metric estima"
        },
        {
          "info": {
            "name": "Calculate Pipeline Metrics All",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.proton.ai/:company/pipelines/metrics",
            "headers": [
              {
                "name": "X-User-Id",
                "value": ""
              },
              {
                "name": "X-Company",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Given a search query (like the /search endpoint), this API endpoint calculates and returns the total count, total value, and forecasted value of opportunities for all pipelines and satisfying the search query. The calculation takes into account the stages of opportunities and their respective probabilities of closing. A pipeline_id filter can be added to narrow the results.\n\nTotal Count: The aggregate number of opportunities within the pipeline.\n\nTotal Value: The total financial value of the pip"
        },
        {
          "info": {
            "name": "Get Pipeline Mockable Users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.proton.ai/:company/pipelines/:pipeline_id/mock_users",
            "headers": [
              {
                "name": "X-User-Id",
                "value": ""
              },
              {
                "name": "X-Company",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company",
                "value": "",
                "type": "path"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Pipeline Mockable Users"
        }
      ]
    }
  ],
  "bundled": true
}