{
"opencollection": "1.0.0",
"info": {
"name": "Pipedrive API v1 Activities Products API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Products",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get deals where a product is attached to",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/products/:id/deals",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Pagination start"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Items shown per page"
},
{
"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."
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns data about deals that have a product attached to it."
},
{
"info": {
"name": "List files attached to a product",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/products/:id/files",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
},
{
"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 product."
},
{
"info": {
"name": "List followers of a product",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/products/:id/followers",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
},
{
"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 followers of a product."
},
{
"info": {
"name": "Add a follower to a product",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/products/:id/followers",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Adds a follower to a product."
},
{
"info": {
"name": "Delete a follower from a product",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/products/:id/followers/:follower_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
},
{
"name": "follower_id",
"value": "",
"type": "path",
"description": "The ID of the relationship between the follower and the product"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Deletes a follower from a product."
},
{
"info": {
"name": "List permitted users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/products/:id/permittedUsers",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Lists users permitted to access a product."
},
{
"info": {
"name": "Get all products",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/products",
"params": [
{
"name": "owner_id",
"value": "",
"type": "query",
"description": "If supplied, only products owned by the given user will be 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": "filter_id",
"value": "",
"type": "query",
"description": "The ID of the filter to use"
},
{
"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": "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": "sort_by",
"value": "",
"type": "query",
"description": "The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`."
},
{
"name": "sort_direction",
"value": "",
"type": "query",
"description": "The sorting direction. Supported values: `asc`, `desc`."
},
{
"name": "custom_fields",
"value": "",
"type": "query",
"description": "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 a smaller response.
A maximum of 15 keys is allowed."
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns data about all products."
},
{
"info": {
"name": "Add a product",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/products",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Adds a new product to the Products inventory. For more information, see the tutorial for adding a product."
},
{
"info": {
"name": "List followers changelog of a product",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/products/:id/followers/changelog",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
},
{
"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 product."
},
{
"info": {
"name": "Search products",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/products/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 here."
},
{
"name": "exact_match",
"value": "",
"type": "query",
"description": "When enabled, only full exact matches against the given term are returned. It is not case sensitive."
},
{
"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 products by name, code and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope."
},
{
"info": {
"name": "Get one product",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/products/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns data about a specific product."
},
{
"info": {
"name": "Update a product",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pipedrive.com/v1/products/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Updates product data."
},
{
"info": {
"name": "Delete a product",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/products/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Marks a product as deleted. After 30 days, the product will be permanently deleted."
},
{
"info": {
"name": "Duplicate a product",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/products/:id/duplicate",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Creates a duplicate of an existing product including all variations, prices, and custom fields."
},
{
"info": {
"name": "Get all product variations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/products/:id/variations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
},
{
"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": "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."
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns data about all product variations."
},
{
"info": {
"name": "Add a product variation",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/products/:id/variations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Adds a new product variation."
},
{
"info": {
"name": "Update a product variation",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pipedrive.com/v1/products/:id/variations/:product_variation_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
},
{
"name": "product_variation_id",
"value": "",
"type": "path",
"description": "The ID of the product variation"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Updates product variation data."
},
{
"info": {
"name": "Delete a product variation",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/products/:id/variations/:product_variation_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
},
{
"name": "product_variation_id",
"value": "",
"type": "path",
"description": "The ID of the product variation"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Deletes a product variation."
},
{
"info": {
"name": "Get image of a product",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/products/:id/images",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Retrieves the image of a product. The public URL has a limited lifetime of 7 days."
},
{
"info": {
"name": "Upload an image for a product",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/products/:id/images",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "data",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Uploads an image for a product."
},
{
"info": {
"name": "Update an image for a product",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.pipedrive.com/v1/products/:id/images",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "data",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Updates the image of a product."
},
{
"info": {
"name": "Delete an image of a product",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/products/:id/images",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Deletes the image of a product."
}
]
}
],
"bundled": true
}