{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pipedrive API v1 Activities Deals API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Deals",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all archived deals",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/archived",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied."
              },
              {
                "name": "filter_id",
                "value": "",
                "type": "query",
                "description": "The ID of the filter to use"
              },
              {
                "name": "person_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored."
              },
              {
                "name": "org_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored."
              },
              {
                "name": "product_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored."
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored."
              },
              {
                "name": "stage_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Pagination start"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items shown per page"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys)."
              },
              {
                "name": "owned_by_you",
                "value": "",
                "type": "query",
                "description": "When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns all archived deals."
        },
        {
          "info": {
            "name": "Get deals summary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/summary",
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Only fetch deals with a specific status. open = Open, won = Won, lost = Lost."
              },
              {
                "name": "filter_id",
                "value": "",
                "type": "query",
                "description": "<code>user_id</code> will not be considered. Only deals matching the given filter will be returned."
              },
              {
                "name": "user_id",
                "value": "",
                "type": "query",
                "description": "Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`."
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "query",
                "description": "Only deals within the given pipeline will be returned"
              },
              {
                "name": "stage_id",
                "value": "",
                "type": "query",
                "description": "Only deals within the given stage will be returned"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns a summary of all not archived deals."
        },
        {
          "info": {
            "name": "Get archived deals summary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/summary/archived",
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Only fetch deals with a specific status. open = Open, won = Won, lost = Lost."
              },
              {
                "name": "filter_id",
                "value": "",
                "type": "query",
                "description": "<code>user_id</code> will not be considered. Only deals matching the given filter will be returned."
              },
              {
                "name": "user_id",
                "value": "",
                "type": "query",
                "description": "Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`."
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "query",
                "description": "Only deals within the given pipeline will be returned"
              },
              {
                "name": "stage_id",
                "value": "",
                "type": "query",
                "description": "Only deals within the given stage will be returned"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns a summary of all archived deals."
        },
        {
          "info": {
            "name": "Get deals timeline",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/timeline",
            "params": [
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "The date when the first interval starts. Format: YYYY-MM-DD."
              },
              {
                "name": "interval",
                "value": "",
                "type": "query",
                "description": "The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>"
              },
              {
                "name": "amount",
                "value": "",
                "type": "query",
                "description": "The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months)."
              },
              {
                "name": "field_key",
                "value": "",
                "type": "query",
                "description": "The date field key which deals will be retrieved from"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals matching the given user will be returned"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals matching the given pipeline will be returned"
              },
              {
                "name": "filter_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals matching the given filter will be returned"
              },
              {
                "name": "exclude_deals",
                "value": "",
                "type": "query",
                "description": "Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned."
              },
              {
                "name": "totals_convert_currency",
                "value": "",
                "type": "query",
                "description": "The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user's default currency is used."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`."
        },
        {
          "info": {
            "name": "Get archived deals timeline",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/timeline/archived",
            "params": [
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "The date when the first interval starts. Format: YYYY-MM-DD."
              },
              {
                "name": "interval",
                "value": "",
                "type": "query",
                "description": "The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>"
              },
              {
                "name": "amount",
                "value": "",
                "type": "query",
                "description": "The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months)."
              },
              {
                "name": "field_key",
                "value": "",
                "type": "query",
                "description": "The date field key which deals will be retrieved from"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals matching the given user will be returned"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals matching the given pipeline will be returned"
              },
              {
                "name": "filter_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals matching the given filter will be returned"
              },
              {
                "name": "exclude_deals",
                "value": "",
                "type": "query",
                "description": "Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned."
              },
              {
                "name": "totals_convert_currency",
                "value": "",
                "type": "query",
                "description": "The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user's default currency is used."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`."
        },
        {
          "info": {
            "name": "List updates about deal field values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/changelog",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items shown per page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Lists updates about field values of a deal."
        },
        {
          "info": {
            "name": "Duplicate deal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/deals/:id/duplicate",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Duplicates a deal."
        },
        {
          "info": {
            "name": "List files attached to a deal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/files",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Pagination start"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items shown per page. Please note that a maximum value of 100 is allowed."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Supported fields: `id`, `update_time`"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Lists files associated with a deal."
        },
        {
          "info": {
            "name": "List updates about a deal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/flow",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Pagination start"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items shown per page"
              },
              {
                "name": "all_changes",
                "value": "",
                "type": "query",
                "description": "Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates."
              },
              {
                "name": "items",
                "value": "",
                "type": "query",
                "description": "A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Lists updates about a deal."
        },
        {
          "info": {
            "name": "List updates about participants of a deal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/participantsChangelog",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items shown per page"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>."
        },
        {
          "info": {
            "name": "List followers of a deal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/followers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Lists the followers of a deal."
        },
        {
          "info": {
            "name": "Add a follower to a deal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/deals/:id/followers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds a follower to a deal."
        },
        {
          "info": {
            "name": "Delete a follower from a deal",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/deals/:id/followers/:follower_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "follower_id",
                "value": "",
                "type": "path",
                "description": "The ID of the relationship between the follower and the deal"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Deletes a follower from a deal."
        },
        {
          "info": {
            "name": "List mail messages associated with a deal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/mailMessages",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Pagination start"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items shown per page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Lists mail messages associated with a deal."
        },
        {
          "info": {
            "name": "Merge two deals",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.pipedrive.com/v1/deals/:id/merge",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>."
        },
        {
          "info": {
            "name": "List participants of a deal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/participants",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Pagination start"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items shown per page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field."
        },
        {
          "info": {
            "name": "Add a participant to a deal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/deals/:id/participants",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds a participant to a deal."
        },
        {
          "info": {
            "name": "Delete a participant from a deal",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/deals/:id/participants/:deal_participant_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "deal_participant_id",
                "value": "",
                "type": "path",
                "description": "The ID of the participant of the deal"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Deletes a participant from a deal."
        },
        {
          "info": {
            "name": "List permitted users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/permittedUsers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Lists the users permitted to access a deal."
        },
        {
          "info": {
            "name": "Get all deals",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals",
            "params": [
              {
                "name": "filter_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals matching the specified filter are returned"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response."
              },
              {
                "name": "owner_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored."
              },
              {
                "name": "person_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored."
              },
              {
                "name": "org_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored."
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored."
              },
              {
                "name": "stage_id",
                "value": "",
                "type": "query",
                "description": "If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored."
              },
              {
                "name": "updated_since",
                "value": "",
                "type": "query",
                "description": "If set, only deals with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z."
              },
              {
                "name": "updated_until",
                "value": "",
                "type": "query",
                "description": "If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`."
              },
              {
                "name": "sort_direction",
                "value": "",
                "type": "query",
                "description": "The sorting direction. Supported values: `asc`, `desc`."
              },
              {
                "name": "include_fields",
                "value": "",
                "type": "query",
                "description": "Optional comma separated string array of additional fields to include"
              },
              {
                "name": "custom_fields",
                "value": "",
                "type": "query",
                "description": "Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed."
              },
              {
                "name": "include_option_labels",
                "value": "",
                "type": "query",
                "description": "When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id"
              },
              {
                "name": "include_labels",
                "value": "",
                "type": "query",
                "description": "When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns data about all not archived deals."
        },
        {
          "info": {
            "name": "Add a new deal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/deals",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds a new deal."
        },
        {
          "info": {
            "name": "Get details of a deal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "include_fields",
                "value": "",
                "type": "query",
                "description": "Optional comma separated string array of additional fields to include"
              },
              {
                "name": "custom_fields",
                "value": "",
                "type": "query",
                "description": "Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed."
              },
              {
                "name": "include_option_labels",
                "value": "",
                "type": "query",
                "description": "When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id"
              },
              {
                "name": "include_labels",
                "value": "",
                "type": "query",
                "description": "When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns the details of a specific deal."
        },
        {
          "info": {
            "name": "Update a deal",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pipedrive.com/v1/deals/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Updates the properties of a deal."
        },
        {
          "info": {
            "name": "Delete a deal",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/deals/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Marks a deal as deleted. After 30 days, the deal will be permanently deleted."
        },
        {
          "info": {
            "name": "List followers changelog of a deal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/followers/changelog",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Lists changelogs about users have followed the deal."
        },
        {
          "info": {
            "name": "Search deals",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/search",
            "params": [
              {
                "name": "term",
                "value": "",
                "type": "query",
                "description": "The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>."
              },
              {
                "name": "exact_match",
                "value": "",
                "type": "query",
                "description": "When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive."
              },
              {
                "name": "person_id",
                "value": "",
                "type": "query",
                "description": "Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000."
              },
              {
                "name": "organization_id",
                "value": "",
                "type": "query",
                "description": "Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000."
              },
              {
                "name": "include_fields",
                "value": "",
                "type": "query",
                "description": "Supports including optional fields in the results which are not provided by default"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID."
        },
        {
          "info": {
            "name": "List discounts added to a deal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/discounts",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Lists discounts attached to a deal."
        },
        {
          "info": {
            "name": "Add a discount to a deal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/deals/:id/discounts",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds a discount to a deal, changing the deal value if the deal has one-time products attached."
        },
        {
          "info": {
            "name": "Update a discount added to a deal",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pipedrive.com/v1/deals/:id/discounts/:discount_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "discount_id",
                "value": "",
                "type": "path",
                "description": "The ID of the discount"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Edits a discount added to a deal, changing the deal value if the deal has one-time products attached."
        },
        {
          "info": {
            "name": "Delete a discount from a deal",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/deals/:id/discounts/:discount_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "discount_id",
                "value": "",
                "type": "path",
                "description": "The ID of the discount"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Removes a discount from a deal, changing the deal value if the deal has one-time products attached."
        },
        {
          "info": {
            "name": "Convert a deal to a lead",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/deals/:id/convert/lead",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal to convert"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call t"
        },
        {
          "info": {
            "name": "Get Deal conversion status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/convert/status/:conversion_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of a deal"
              },
              {
                "name": "conversion_id",
                "value": "",
                "type": "path",
                "description": "The ID of the conversion"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days."
        }
      ]
    }
  ],
  "bundled": true
}