{
"opencollection": "1.0.0",
"info": {
"name": "Pipedrive API v1 Activities Pipelines API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Pipelines",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get deals conversion rates in pipeline",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/pipelines/:id/conversion_statistics",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the pipeline"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "The start of the period. Date in format of YYYY-MM-DD."
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "The end of the period. Date in format of YYYY-MM-DD."
},
{
"name": "user_id",
"value": "",
"type": "query",
"description": "The ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used."
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period."
},
{
"info": {
"name": "Get deals in a pipeline",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/pipelines/:id/deals",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the pipeline"
},
{
"name": "filter_id",
"value": "",
"type": "query",
"description": "If supplied, only deals matching the given filter will be returned"
},
{
"name": "user_id",
"value": "",
"type": "query",
"description": "If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned."
},
{
"name": "everyone",
"value": "",
"type": "query",
"description": "If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned"
},
{
"name": "stage_id",
"value": "",
"type": "query",
"description": "If supplied, only deals within the given stage will be returned"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Pagination start"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Items shown per page"
},
{
"name": "get_summary",
"value": "",
"type": "query",
"description": "Whether to include a summary of the pipeline in the `additional_data` or not"
},
{
"name": "totals_convert_currency",
"value": "",
"type": "query",
"description": "The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled."
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?pipeline_id={id} instead."
},
{
"info": {
"name": "Get deals movements in pipeline",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/pipelines/:id/movement_statistics",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the pipeline"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "The start of the period. Date in format of YYYY-MM-DD."
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "The end of the period. Date in format of YYYY-MM-DD."
},
{
"name": "user_id",
"value": "",
"type": "query",
"description": "The ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used."
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns statistics for deals movements for the given time period."
},
{
"info": {
"name": "Get all pipelines",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/pipelines",
"params": [
{
"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": "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 pipelines."
},
{
"info": {
"name": "Add a new pipeline",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/pipelines",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Adds a new pipeline."
},
{
"info": {
"name": "Get one pipeline",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/pipelines/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the pipeline"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns data about a specific pipeline."
},
{
"info": {
"name": "Update a pipeline",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pipedrive.com/v1/pipelines/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the pipeline"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Updates the properties of a pipeline."
},
{
"info": {
"name": "Delete a pipeline",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/pipelines/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the pipeline"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Marks a pipeline as deleted."
}
]
}
],
"bundled": true
}