### Link a user with the installed video call integration

Source: https://developers.pipedrive.com/docs/api/v1/Meetings

A video calling provider must call this endpoint after a user has installed the video calling app so that the new user's information is sent.

```APIDOC
## POST /api/v1/meetings/userProviderLinks

### Description
Links a user with an installed video call integration.

### Method
POST

### Endpoint
/api/v1/meetings/userProviderLinks

### Parameters
#### Request Body
- **user_provider_id** (string) - required - Unique identifier linking a user to the installed integration. Generated by the integration. Format: uuid
- **user_id** (integer) - required - Pipedrive user ID
- **company_id** (integer) - required - Pipedrive company ID
- **marketplace_client_id** (string) - required - Pipedrive Marketplace client ID of the installed integration

### Response
#### Success Response (200)
OK
- **success** (boolean)
- **data** (object)
```

--------------------------------

### Get deals summary

Source: https://developers.pipedrive.com/docs/api/v1/Deals

Provides a summary of all deals.

```APIDOC
## GET /api/v1/deals/summary

### Description
Get deals summary.

### Method
GET

### Endpoint
/api/v1/deals/summary
```

--------------------------------

### Token Response Example

Source: https://developers.pipedrive.com/docs/api/v1/Oauth

This is an example of the JSON response received when successfully obtaining or refreshing OAuth 2.0 tokens. It includes the access token, its type, expiration time, refresh token, granted scope, and the API domain.

```json
{
  "access_token":"v1u:AQIBAHj+LzTNK1yuuuaLqifzhWb9crUNKTpk4FlQ9rjnXqp/6AErhI98syaV25RmpLJLIgOkAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMbGNxa4UccVoXAmLNAgEQgDsiQ7cNdoRBJeFr1i3KW84RYyM1Qtwq1oSBJOl/NFQdVjDI2iQH0LBhS28DbL2KDvoVIihea9Ryt/9rIQ==:RIDnTOIXo8QirT3DMYw0Y0s8xBbxz59f5IMq7T7WhSz313e2MXRHB6g+8OTNCSqVO7QsUhluoAmOfBP1FNkPycy9txn7t2Uoz9y/JDVf4Givv4MMiK/Xq3I7hO4N6FeD+2GqDJDBn24OW6b0SRIr4FEROhGo3BpcPRGehv46NLn1n5LrqXrQwO9qrGD4gIZe40oO2IQgGL9QAPDfqvZ+JhUtcpAipRLp7cCDRfYU8+sdOFJ+hLffqC8isFcV6iPsNrmj",
  "token_type":"Bearer",
  "expires_in":3599,
  "refresh_token":"1:1:2a5496a8bdd0f829dcb09dc8ba82b188f0ea4481",
  "scope":"base",
  "api_domain":"https://user-company.pipedrive.com"
}
```

--------------------------------

### Get All Webhooks

Source: https://developers.pipedrive.com/docs/api/v1/Webhooks

Retrieve data about all the Webhooks configured for a company. This is a simple GET request to the webhooks endpoint.

```bash
GET
/api/v1/webhooks
```

--------------------------------

### Get all files

Source: https://developers.pipedrive.com/docs/api/v1/Files

Returns data about all files. Supports pagination and sorting.

```APIDOC
## GET /api/v1/files

### Description
Returns data about all files.

### Method
GET

### Endpoint
/api/v1/files

### Query Parameters
- **start** (integer) - Optional - Pagination start. Default: 0
- **limit** (integer) - Optional - Items shown per page. Maximum value is 100.
- **sort** (string) - Optional - Supported fields: `id`, `update_time`

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (array) - Array of file objects.
- **additional_data** (object)
```

--------------------------------

### Get all product variations

Source: https://developers.pipedrive.com/docs/api/v1/Products

Returns data about all product variations.

```APIDOC
## GET /api/v2/products/{id}/variations

### Description
Returns data about all product variations.

### Method
GET

### Endpoint
/api/v2/products/{id}/variations

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the product

#### Query Parameters
- **cursor** (string) - Optional - For pagination, the marker (an opaque string value) representing the first item on the next page
- **limit** (integer) - Optional - For pagination, the limit of entries to be returned. Default: 100. Maximum value: 500

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (array)
- **additional_data** (object)

#### Response Example
{
  "success": true,
  "data": [...],
  "additional_data": {...}
}
```

--------------------------------

### Get one product

Source: https://developers.pipedrive.com/docs/api/v1/Products

Returns data about a specific product identified by its ID.

```APIDOC
## Get one product

### Description
Returns data about a specific product identified by its ID.

### Method
GET

### Endpoint
/api/v2/products/{id}

### Path Parameters
- **id** (integer) - Required - The ID of the product.

### Response
#### Success Response (200)
OK
- **success** (boolean)
- **data** (object) - The product object.
```

--------------------------------

### Get all products

Source: https://developers.pipedrive.com/docs/api/v1/Products

Returns data about all products. Supports filtering, pagination, sorting, and custom field selection.

```APIDOC
## Get all products

### Description
Returns data about all products. Supports filtering, pagination, sorting, and custom field selection.

### Method
GET

### Endpoint
/api/v2/products

### Query Parameters
- **owner_id** (integer) - Optional - If supplied, only products owned by the given user will be returned.
- **ids** (string) - 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.
- **filter_id** (integer) - Optional - The ID of the filter to use.
- **cursor** (string) - Optional - For pagination, the marker (an opaque string value) representing the first item on the next page.
- **limit** (integer) - Optional - 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.
- **sort_by** (string) - Optional - The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`. Default: `id`.
- **sort_direction** (string) - Optional - The sorting direction. Supported values: `asc`, `desc`. Default: `asc`.
- **custom_fields** (string) - Optional - Comma separated string array of custom fields keys to include. A maximum of 15 keys is allowed.

### Response
#### Success Response (200)
OK
- **success** (boolean)
- **data** (array) - Array of product objects.
- **additional_data** (object) - Additional data related to the response.
```

--------------------------------

### Get all pipelines

Source: https://developers.pipedrive.com/docs/api/v1/Pipelines

Returns data about all pipelines. Supports sorting and pagination.

```APIDOC
## Get all pipelines

### Description
Returns data about all pipelines.

### Method
GET

### Endpoint
/api/v2/pipelines

### Query Parameters
- **sort_by** (string) - Optional - The field to sort by. Supported fields: `id`, `update_time`, `add_time`. Default: `id`
- **sort_direction** (string) - Optional - The sorting direction. Supported values: `asc`, `desc`. Default: `asc`
- **limit** (integer) - Optional - For pagination, the limit of entries to be returned. Maximum value is 500. Default: 100
- **cursor** (string) - Optional - For pagination, the marker (an opaque string value) representing the first item on the next page

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (array) - Array of pipeline objects.
- **additional_data** (object)
```

--------------------------------

### Get all activities

Source: https://developers.pipedrive.com/docs/api/v1/Activities

Returns data about all activities. Supports filtering, sorting, and pagination.

```APIDOC
## GET /api/v2/activities

### Description
Returns data about all activities. Supports filtering, sorting, and pagination.

### Method
GET

### Endpoint
/api/v2/activities

### Query Parameters
- **filter_id** (integer) - Optional - If supplied, only activities matching the specified filter are returned.
- **ids** (string) - 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.
- **owner_id** (integer) - Optional - If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
- **deal_id** (integer) - Optional - If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
- **lead_id** (string) - Optional - If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
- **person_id** (integer) - Optional - If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
- **org_id** (integer) - Optional - If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
- **done** (boolean) - Optional - If supplied, only activities with specified 'done' flag value are returned.
- **updated_since** (string) - Optional - If set, only activities with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
- **updated_until** (string) - Optional - If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
- **sort_by** (string) - Optional - The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`. Default: `id`.
- **sort_direction** (string) - Optional - The sorting direction. Supported values: `asc`, `desc`. Default: `asc`.
- **include_fields** (string) - Optional - Optional comma separated string array of additional fields to include.
- **limit** (integer) - Optional - 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.
- **cursor** (string) - Optional - For pagination, the marker (an opaque string value) representing the first item on the next page.

### Response
#### Success Response (200)
OK
- **success** (boolean)
- **data** (array)
- **additional_data** (object)

### Response Example
```json
{
  "success": true,
  "data": [
    ...
  ],
  "additional_data": {
    ...
  }
}
```
```

--------------------------------

### Get all user connections

Source: https://developers.pipedrive.com/docs/api/v1/UserConnections

Returns data about all connections for the authorized user.

```APIDOC
## GET /api/v1/userConnections

### Description
Returns data about all connections for the authorized user.

### Method
GET

### Endpoint
/api/v1/userConnections

### Response
#### Success Response (200)
- "success" (boolean) - Indicates if the request was successful.
- "data" (object) - Contains the user connection data.

### Response Example
```json
{
  "success": true,
  "data": { ... }
}
```
```

--------------------------------

### Get All Lead Labels

Source: https://developers.pipedrive.com/docs/api/v1/LeadLabels

Retrieves all lead labels. This endpoint does not support pagination and returns all labels.

```http
GET /api/v1/leadLabels
```

--------------------------------

### Get deals where a product is attached to

Source: https://developers.pipedrive.com/docs/api/v1/Products

Retrieves a list of deals that have a specific product attached to them.

```APIDOC
## Get deals where a product is attached to

### Description
Retrieves a list of deals that have a specific product attached to them.

### Method
GET

### Endpoint
/api/v1/products/{id}/deals

### Path Parameters
- **id** (integer) - Required - The ID of the product.

### Query Parameters
- **start** (integer) - Optional - Pagination start. Default: 0.
- **limit** (integer) - Optional - Items shown per page.
- **status** (string) - Optional - 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. Supported values: `open`, `won`, `lost`, `deleted`, `all_not_deleted`. Default: `all_not_deleted`.
```

--------------------------------

### Get all project fields

Source: https://developers.pipedrive.com/docs/api/v1/Beta

Retrieves metadata for all project fields within the company. Supports pagination.

```APIDOC
## GET /api/v2/projectFields

### Description
Returns metadata about all project fields in the company.

### Method
GET

### Endpoint
/api/v2/projectFields

### Query Parameters
- **limit** (integer) - Optional - For pagination, the limit of entries to be returned. Defaults to 100. Maximum value is 500.
- **cursor** (string) - Optional - For pagination, the marker representing the first item on the next page.

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (array) - Contains project field metadata.
- **additional_data** (object) - Contains additional data related to the response.
```

--------------------------------

### Get image of a product

Source: https://developers.pipedrive.com/docs/api/v1/Products

Retrieves the image of a product. The public URL has a limited lifetime of 7 days.

```APIDOC
## GET /api/v2/products/{id}/images

### Description
Retrieves the image of a product. The public URL has a limited lifetime of 7 days.

### Method
GET

### Endpoint
/api/v2/products/{id}/images

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the product

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (object)

#### Response Example
{
  "success": true,
  "data": {...}
}
```

--------------------------------

### Get all call logs assigned to a particular user

Source: https://developers.pipedrive.com/docs/api/v1/CallLogs

Returns all call logs assigned to a particular user. Supports pagination with 'start' and 'limit' query parameters.

```APIDOC
## Get all call logs assigned to a particular user

### Description
Returns all call logs assigned to a particular user.

### Method
GET

### Endpoint
/api/v1/callLogs

### Query Parameters
- **start** (integer) - Optional - Pagination start. Default: 0
- **limit** (integer) - Optional - For pagination, the limit of entries to be returned. The upper limit is 50.
```

--------------------------------

### Create Product

Source: https://developers.pipedrive.com/docs/api/v1/Products

Creates a new product with specified details including name, code, description, pricing, and custom fields.

```APIDOC
## Create Product

### Description
Creates a new product with specified details including name, code, description, pricing, and custom fields.

### Method
POST

### Endpoint
/api/v2/products

### Parameters
#### Request Body
- **name** (string) - required - The name of the product. Cannot be an empty string
- **code** (string) - The product code
- **description** (string) - The product description
- **unit** (string) - The unit in which this product is sold
- **tax** (number) - The tax percentage
- **category** (number) - The category of the product
- **owner_id** (integer) - The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used
- **is_linkable** (boolean) - Whether this product can be added to a deal or not
- **visible_to** (number) - The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user.
- **prices** (array) - An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `direct_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and the user's default currency will be assigned.
- **custom_fields** (object) - An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
- **billing_frequency** (string) - Only available in Growth and above plans. How often a customer is billed for access to a service or product. Values: one-time, annually, semi-annually, quarterly, monthly, weekly. Default: one-time
- **billing_frequency_cycles** (integer) - Only available in Growth and above plans. The number of times the billing frequency repeats for a product in a deal. When `billing_frequency` is set to `one-time`, this field must be `null`. When `billing_frequency` is set to `weekly`, this field cannot be `null`. For all the other values of `billing_frequency`, `null` represents a product billed indefinitely. Must be a positive integer less or equal to 208.

### Response
#### Success Response (201)
- **success** (boolean)
- **data** (object)

### Response Example
{
  "success": true,
  "data": { ... }
}
```

--------------------------------

### Get deals timeline

Source: https://developers.pipedrive.com/docs/api/v1/Deals

Returns not archived open and won deals, grouped by a defined interval of time. Requires start date, interval, amount, and a date field key.

```APIDOC
## GET /api/v1/deals/timeline

### Description
Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`).

### Method
GET

### Endpoint
/api/v1/deals/timeline

### Query Parameters
#### start_date (string) - Required - The date when the first interval starts. Format: YYYY-MM-DD.
#### interval (string) - Required - The type of the interval. Values: day, week, month, quarter.
#### amount (integer) - Required - The number of given intervals, starting from `start_date`, to fetch.
#### field_key (string) - Required - The date field key which deals will be retrieved from.
#### user_id (integer) - Optional - If supplied, only deals matching the given user will be returned.
#### pipeline_id (integer) - Optional - If supplied, only deals matching the given pipeline will be returned.
#### filter_id (integer) - Optional - If supplied, only deals matching the given filter will be returned.
#### exclude_deals (number) - Optional - Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. Values: 0, 1.
#### totals_convert_currency (string) - Optional - 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`.

### Response
#### Success Response (200)
- success (boolean) - Indicates if the request was successful.
- data (object) - Contains the deal timeline data.

### Response Example
```json
{
  "success": true,
  "data": { ... }
}
```
```

--------------------------------

### Add a project

Source: https://developers.pipedrive.com/docs/api/v1/Projects

Adds a new project to the system. Custom fields should be included within the `custom_fields` object.

```APIDOC
## Add a project

### Description
Adds a new project. Custom fields should be wrapped in the `custom_fields` object.

### Method
POST

### Endpoint
/api/v2/projects
```

--------------------------------

### Create Project

Source: https://developers.pipedrive.com/docs/api/v1/Projects

Creates a new project with specified details. This endpoint is used for creating projects from scratch or based on a template.

```APIDOC
## POST /api/v2/projects

### Description
Creates a new project.

### Method
POST

### Endpoint
/api/v2/projects

### Parameters
#### Request Body
- **title** (string) - required - The title of the project
- **description** (string) - optional - The description of the project
- **status** (string) - optional - The status of the project
- **board_id** (integer) - optional - The ID of the board this project is associated with
- **phase_id** (integer) - optional - The ID of the phase this project is associated with
- **owner_id** (integer) - optional - The ID of the user who owns the project
- **start_date** (string) - optional - The start date of the project. Format: YYYY-MM-DD
- **end_date** (string) - optional - The end date of the project. Format: YYYY-MM-DD
- **deal_ids** (array) - optional - An array of IDs of the deals this project is associated with
- **person_ids** (array) - optional - An array of IDs of the persons this project is associated with
- **org_ids** (array) - optional - An array of IDs of the organizations this project is associated with
- **label_ids** (array) - optional - An array of IDs of the labels this project has
- **template_id** (integer) - optional - The ID of the template the project will be based on. Only used when creating a new project.
- **custom_fields** (object) - optional - An object where each key represents a custom field. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.

### Response
#### Success Response (201)
- **success** (boolean)
- **data** (object)
```

--------------------------------

### Delete an installment from a deal

Source: https://developers.pipedrive.com/docs/api/v1/DealInstallments

Removes an installment from a deal. This functionality is available in Growth and above plans.

```APIDOC
## Delete an installment from a deal

### Description
Removes an installment from a deal. Only available in Growth and above plans.

### Method
DELETE

### Endpoint
/api/v2/deals/{id}/installments/{installment_id}

### Path Parameters
- **id** (integer) - Required - The ID of the deal
- **installment_id** (integer) - Required - The ID of the installment

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (object)
```

--------------------------------

### Get all note fields

Source: https://developers.pipedrive.com/docs/api/v1/NoteFields

Returns data about all note fields. This is a GET request to the /api/v1/noteFields endpoint.

```APIDOC
## Get all note fields

### Description
Returns data about all note fields.

### Method
GET

### Endpoint
/api/v1/noteFields

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - An array containing note field objects.
- **additional_data** (object) - Contains additional data related to the request.
```

--------------------------------

### Add a product

Source: https://developers.pipedrive.com/docs/api/v1/Products

Adds a new product to the Products inventory.

```APIDOC
## POST /api/v2/products

### Description
Adds a new product to the Products inventory. For more information, see the tutorial for adding a product.

### Method
POST

### Endpoint
/api/v2/products

### Response
#### Success Response (200)
- **success** (boolean)

#### Response Example
{
  "success": true
}
```

--------------------------------

### Create a remote file and link it to an item

Source: https://developers.pipedrive.com/docs/api/v1/Files

Creates a new empty file in a remote location (e.g., Google Drive) and links it to a specified item.

```APIDOC
## POST /api/v1/files/remote

### Description
Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply.

### Method
POST

### Endpoint
/api/v1/files/remote

### Request Body
- **file_type** (string) - Required - The file type (e.g., `gdoc`, `gsheet`).
- **title** (string) - Required - The title of the file.
- **item_type** (string) - Required - The item type (`deal`, `organization`, `person`).
- **item_id** (integer) - Required - The ID of the item to associate the file with.
- **remote_location** (string) - Required - The location type to send the file to (`googledrive`).

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (object)
```

--------------------------------

### Update an installment added to a deal

Source: https://developers.pipedrive.com/docs/api/v1/DealInstallments

Edits an installment added to a deal. This operation is available in Growth and above plans.

```APIDOC
## Update an installment added to a deal

### Description
Edits an installment added to a deal. Only available in Growth and above plans.

### Method
PATCH

### Endpoint
/api/v2/deals/{id}/installments/{installment_id}

### Path Parameters
- **id** (integer) - Required - The ID of the deal
- **installment_id** (integer) - Required - The ID of the installment

### Request Body
#### application/json
- **description** (string) - Optional - The name of the installment.
- **amount** (number) - Optional - The installment amount. Must be a positive number (excluding 0).
- **billing_date** (string) - Optional - The date on which the installment will be charged. Must be in the format YYYY-MM-DD.

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (object)
```

--------------------------------

### List settings of an authorized user

Source: https://developers.pipedrive.com/docs/api/v1/UserSettings

Lists the settings of an authorized user. The example response contains a shortened list of settings.

```APIDOC
## GET /api/v1/userSettings

### Description
Lists the settings of an authorized user.

### Method
GET

### Endpoint
/api/v1/userSettings

### Response
#### Success Response (200)
- "success" (boolean) - Indicates if the request was successful.
- "data" (object) - Contains the user settings data.

### Response Example
```json
{
  "success": true,
  "data": { ... }
}
```
```

--------------------------------

### Get result of a goal

Source: https://developers.pipedrive.com/docs/api/v1/Goals

Gets the progress of a goal for the specified period. Requires goal ID and a date range.

```APIDOC
## Get result of a goal

### Description
Gets the progress of a goal for the specified period.

### Method
GET

### Endpoint
/api/v1/goals/{id}/results

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the goal that the results are looked for

#### Query Parameters
- **period.start** (string) - Required - The start date of the period for which to find the goal's progress. Format: YYYY-MM-DD.
- **period.end** (string) - Required - The end date of the period for which to find the goal's progress. Format: YYYY-MM-DD.

### Response
#### Success Response (200)
- **success** (boolean)
- **statusCode** (integer)
- **statusText** (string)
- **service** (string)
- **data** (object)

### Response Example
```json
{
  "success": true,
  "statusCode": 20000,
  "statusText": "OK",
  "service": "statistics-goals-api",
  "data": { ... }
}
```
```

--------------------------------

### Add Project Board

Source: https://developers.pipedrive.com/docs/api/v1/Beta

Creates a new project board, which can be used to visualize projects.

```APIDOC
## POST /api/v2/boards

### Description
Adds a new project board.

### Method
POST

### Endpoint
/api/v2/boards

### Parameters
#### Request Body
- **name** (string) - required - The name of the project board
- **order_nr** (integer) - The order of the board. Must be between 1 and the total number of boards + 1.

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (object)

### Request Example
```json
{
  "name": "New Project Board",
  "order_nr": 1
}
```
```

--------------------------------

### List installments added to a list of deals

Source: https://developers.pipedrive.com/docs/api/v1/DealInstallments

Lists installments attached to a list of deals. This endpoint is available in Growth and above plans.

```APIDOC
## List installments added to a list of deals

### Description
Lists installments attached to a list of deals. Only available in Growth and above plans.

### Method
GET

### Endpoint
/api/v2/deals/installments

### Query Parameters
- **deal_ids** (array) - Required - An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
- **cursor** (string) - Optional - For pagination, the marker (an opaque string value) representing the first item on the next page
- **limit** (integer) - Optional - 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.
- **sort_by** (string) - Optional - The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`. Default: `id`
- **sort_direction** (string) - Optional - The sorting direction. Supported values: `asc`, `desc`. Default: `asc`

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (array)
```

--------------------------------

### Add Project Phase - API v2

Source: https://developers.pipedrive.com/docs/api/v1/Beta

Adds a new project phase to a specified board. Requires the phase name and board ID.

```bash
POST /api/v2/phases
Content-Type: application/json

{
  "name": "New Phase Name",
  "board_id": 123,
  "order_nr": 1
}
```

--------------------------------

### Add an installment to a deal

Source: https://developers.pipedrive.com/docs/api/v1/DealInstallments

Adds an installment to a deal. This is only possible if the deal includes at least one one-time product. Available in Growth and above plans.

```APIDOC
## Add an installment to a deal

### Description
Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.

### Method
POST

### Endpoint
/api/v2/deals/{id}/installments

### Path Parameters
- **id** (integer) - Required - The ID of the deal

### Request Body
#### application/json
- **description** (string) - Required - The name of the installment.
- **amount** (number) - Required - The installment amount. Must be a positive number (excluding 0).
- **billing_date** (string) - Required - The date on which the installment will be charged. Must be in the format YYYY-MM-DD.

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (object)
```

--------------------------------

### Add a project board

Source: https://developers.pipedrive.com/docs/api/v1/ProjectBoards

Adds a new project board to the system. Requires a name for the board.

```APIDOC
## Add a project board

### Description
Adds a new project board.

### Method
POST

### Endpoint
/api/v2/boards

### Parameters
#### Request Body
- **name** (string) - Required - The name of the project board.
- **order_nr** (integer) - Optional - The order of the board. Must be between 1 and the total number of boards + 1.

### Request Example
```json
{
  "name": "New Board Name",
  "order_nr": 1
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - An object containing the details of the newly created project board.

### Response Example
```json
{
  "success": true,
  "data": {
    // ... new project board details
  }
}
```
```

--------------------------------

### Get deals in a stage

Source: https://developers.pipedrive.com/docs/api/v1/Stages

Lists deals associated with a specific stage. Note: This endpoint is deprecated; use GET /api/v2/deals?stage_id={id} instead.

```APIDOC
## Get deals in a stage

### Description
Lists deals in a specific stage. 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?stage_id={id} instead.

### Method
GET

### Endpoint
/api/v1/stages/{id}/deals

### Path Parameters
- **id** (integer) - Required - The ID of the stage

### Query Parameters
- **filter_id** (integer) - Optional - If supplied, only deals matching the given filter will be returned
- **user_id** (integer) - Optional - 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.
- **everyone** (number) - Optional - If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned. Values: 0, 1.
- **start** (integer) - Optional - Pagination start. Default: 0.
- **limit** (integer) - Optional - Items shown per page.

### Response
#### Success Response (200)
OK
- **success** (boolean)
- **data** (array)
- **additional_data** (object)
```

--------------------------------

### Get deals in a pipeline

Source: https://developers.pipedrive.com/docs/api/v1/Pipelines

Lists deals in a specific pipeline across all its stages. This endpoint is deprecated; use GET /api/v2/deals?pipeline_id={id} instead.

```APIDOC
## Get deals in a pipeline

### Description
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.

### Method
GET

### Endpoint
/api/v1/pipelines/{id}/deals

### Path Parameters
- **id** (integer) - Required - The ID of the pipeline

### Query Parameters
- **filter_id** (integer) - Optional - If supplied, only deals matching the given filter will be returned
- **user_id** (integer) - Optional - 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.
- **everyone** (number) - Optional - If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned. Values: 0, 1
- **stage_id** (integer) - Optional - If supplied, only deals within the given stage will be returned
- **start** (integer) - Optional - Pagination start. Default: 0
- **limit** (integer) - Optional - Items shown per page
- **get_summary** (number) - Optional - Whether to include a summary of the pipeline in the `additional_data` or not. Values: 0, 1
- **totals_convert_currency** (string) - Optional - 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. Only works when `get_summary` parameter flag is enabled.

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (array) - Array of deal objects.
- **additional_data** (object)
```

--------------------------------

### Add a product to a deal

Source: https://developers.pipedrive.com/docs/api/v1/DealProducts

Attaches a product to a deal, creating a new deal-product item. This operation has a cost of 5 API units.

```bash
POST
/api/v2/deals/{id}/products
```

--------------------------------

### Delete the link between a user and the installed video call integration

Source: https://developers.pipedrive.com/docs/api/v1/Meetings

A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.

```APIDOC
## DELETE /api/v1/meetings/userProviderLinks/{id}

### Description
Deletes the link between a user and the installed video call integration.

### Method
DELETE

### Endpoint
/api/v1/meetings/userProviderLinks/{id}

### Parameters
#### Path Parameters
- **id** (string) - required - Unique identifier linking a user to the installed integration. Format: uuid

### Response
#### Success Response (200)
OK
- **success** (boolean)
- **data** (object)
```

--------------------------------

### Get deal products of several deals

Source: https://developers.pipedrive.com/docs/api/v1/DealProducts

Fetches products attached to multiple deals by providing their IDs. Supports pagination and sorting.

```bash
GET
/api/v2/deals/products
```

--------------------------------

### Add Follower to Product

Source: https://developers.pipedrive.com/docs/api/v1/Products

Adds a user as a follower to the product.

```APIDOC
## Add Follower to Product

### Description
Adds a user as a follower to the product.

### Method
POST

### Endpoint
/api/v2/products/{id}/followers

### Parameters
#### Path Parameters
- **id** (integer) - required - The ID of the product
#### Request Body
- **user_id** (integer) - required - The ID of the user to add as a follower

### Response
#### Success Response (201)
- **success** (boolean)
- **data** (object)

### Response Example
{
  "success": true,
  "data": { ... }
}
```

--------------------------------

### Get all Webhooks

Source: https://developers.pipedrive.com/docs/api/v1/Webhooks

Returns data about all the Webhooks of a company.

```APIDOC
## Get all Webhooks

### Description
Returns data about all the Webhooks of a company.

### Method
GET

### Endpoint
/api/v1/webhooks

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the response.
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - Contains an array of webhook objects.
```

--------------------------------

### Create Activity

Source: https://developers.pipedrive.com/docs/api/v1/Activities

Creates a new activity. This endpoint allows for detailed configuration of the activity, including subject, type, owner, associated deal/lead/person/organization/project, due dates, location, participants, and notes.

```APIDOC
## POST /api/v1/Activities

### Description
Creates a new activity with the provided details.

### Method
POST

### Endpoint
/api/v1/Activities

### Parameters
#### Request Body
- **subject** (string) - Required - The subject of the activity
- **type** (string) - Required - The type of the activity
- **owner_id** (integer) - Optional - The ID of the user who owns the activity
- **deal_id** (integer) - Optional - The ID of the deal linked to the activity
- **lead_id** (string) - Optional - The ID of the lead linked to the activity
- **person_id** (integer) - Optional - The ID of the person linked to the activity
- **org_id** (integer) - Optional - The ID of the organization linked to the activity
- **project_id** (integer) - Optional - The ID of the project linked to the activity
- **due_date** (string) - Optional - The due date of the activity
- **due_time** (string) - Optional - The due time of the activity
- **duration** (string) - Optional - The duration of the activity
- **busy** (boolean) - Optional - Whether the activity marks the assignee as busy or not in their calendar
- **done** (boolean) - Optional - Whether the activity is marked as done or not
- **location** (object) - Optional - Location of the activity
  - **value** (string) - Optional - The full address of the activity
  - **country** (string) - Optional - Country of the activity
  - **admin_area_level_1** (string) - Optional - Admin area level 1 (e.g. state) of the activity
  - **admin_area_level_2** (string) - Optional - Admin area level 2 (e.g. county) of the activity
  - **locality** (string) - Optional - Locality (e.g. city) of the activity
  - **sublocality** (string) - Optional - Sublocality (e.g. neighborhood) of the activity
  - **route** (string) - Optional - Route (e.g. street) of the activity
  - **street_number** (string) - Optional - Street number of the activity
  - **subpremise** (string) - Optional - Subpremise (e.g. apartment/suite number) of the activity
  - **postal_code** (string) - Optional - Postal code of the activity
- **participants** (array) - Optional - The participants of the activity
  - **person_id** (integer) - Required - The ID of the person
  - **primary** (boolean) - Optional - Whether the person is the primary participant or not
- **attendees** (array) - Optional - The attendees of the activity
  - **email** (string) - Required - The email address of the attendee
  - **name** (string) - Optional - The name of the attendee
  - **status** (string) - Optional - The status of the attendee
  - **is_organizer** (boolean) - Optional - Whether the attendee is the organizer or not
  - **person_id** (integer) - Optional - The ID of the person if the attendee has a person record
  - **user_id** (integer) - Optional - The ID of the user if the attendee is a user
- **public_description** (string) - Optional - The public description of the activity
- **priority** (integer) - Optional - The priority of the activity. Mappable to a specific string using activityFields API.
- **note** (string) - Optional - The note of the activity

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (object) - Contains the created activity data.
```

--------------------------------

### Get deals timeline

Source: https://developers.pipedrive.com/docs/api/v1/Deals

Retrieves a timeline view of all deals.

```APIDOC
## GET /api/v1/deals/timeline

### Description
Get deals timeline.

### Method
GET

### Endpoint
/api/v1/deals/timeline
```

--------------------------------

### List files attached to a product

Source: https://developers.pipedrive.com/docs/api/v1/Products

Lists files associated with a specific product.

```APIDOC
## GET /api/v1/products/{id}/files

### Description
Lists files associated with a product.

### Method
GET

### Endpoint
/api/v1/products/{id}/files

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the product

#### Query Parameters
- **start** (integer) - Optional - Pagination start. Default: 0
- **limit** (integer) - Optional - Items shown per page. Maximum value: 100
- **sort** (string) - Optional - Supported fields: `id`, `update_time`

### Response
#### Success Response (200)
- **success** (boolean)
- **data** (array)
- **additional_data** (object)

#### Response Example
{
  "success": true,
  "data": [...],
  "additional_data": {...},
  "related_objects": {...}
}
```

--------------------------------

### List products attached to a deal

Source: https://developers.pipedrive.com/docs/api/v1/DealProducts

Retrieves a list of products associated with a specific deal. Supports pagination and sorting.

```bash
GET
/api/v2/deals/{id}/products
```

--------------------------------

### Get all archived deals

Source: https://developers.pipedrive.com/docs/api/v1/Deals

Retrieves a list of all deals that have been archived.

```APIDOC
## GET /api/v2/deals/archived

### Description
Get all archived deals.

### Method
GET

### Endpoint
/api/v2/deals/archived
```