A lead source indicates where your lead came from. Currently, these are the possible lead sources: `Manually created`, `Deal`, `Web forms`, `Prospector`, `Leadbooster`, `Live chat`, `Import`, `Website visitors`, `Workflow automation`, and `API`. Lead sources are pre-defined and cannot be edited. Please note that leads sourced from the Chatbot feature are assigned the value `Leadbooster`. Please also note that this list is not final and new sources may be added as needed.


LeadSources

Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the Pipedrive API will have a lead source `API` assigned.


The successful response containing payload in the `data` field.

Activities

Get all activities assigned to a particular user

ActivityFields

ActivityTypes

Billing

CallLogs

Get all call logs assigned to a particular user

Channels

Currencies

DealFields

Deals

List updates about participants of a deal

List mail messages associated with a deal

List installments added to a list of deals

Files

Create a remote file and link it to an item

Filters

Goals

ItemSearch

Perform a search from multiple item types

Perform a search using a specific field from an item type

LeadLabels

Leads

LegacyTeams

Mailbox

Meetings

Link a user with the installed video call integration

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

NoteFields

Notes

Oauth

OrganizationFields

Delete multiple organization fields in bulk

OrganizationRelationships

Organizations

List activities associated with an organization

List updates about organization field values

List deals associated with an organization

List mail messages associated with an organization

List followers changelog of an organization

PermissionSets

PersonFields

Persons

List mail messages associated with a person

Pipelines

ProductFields

Products

Projects

ProjectTemplates

Recents

Roles

Stages

Subscriptions

Tasks

UserConnections

UserSettings

Users

Webhooks

Adds a new activity. Includes `more_activities_scheduled_in_context` property in response's `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-an-activity" target="_blank" rel="noopener noreferrer">adding an activity</a>. ***Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync***

Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted. This endpoint has been deprecated. Please use <a href="https://developers.pipedrive.com/docs/api/v1/Activities#deleteActivity" target="_blank" rel="noopener noreferrer">DELETE /api/v2/activities/{id}</a> instead.

The comma-separated IDs of activities that will be deleted

Returns all activities assigned to a particular user.

The ID of the user whose activities will be fetched. If omitted, the user associated with the API token will be used. If 0, activities for all company users will be fetched based on the permission sets.

user_id

The ID of the filter to use (will narrow down results if used together with `user_id` parameter)

filter_id

The type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the `key_string` parameter of ActivityTypes.

type

For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.

limit

For pagination, the position that represents the first result for the page

start

Use the activity due date where you wish to begin fetching activities from. Insert due date in YYYY-MM-DD format.

start_date

Use the activity due date where you wish to stop fetching activities from. Insert due date in YYYY-MM-DD format.

end_date

Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both done and not done activities.

done

numberBoolean

If supplied, only activities matching the specified filter are returned

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.

If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.

owner_id

If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.

deal_id

If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.

lead_id

If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.

person_id

If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.

org_id

If supplied, only activities with specified 'done' flag value are returned

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_since

If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.

updated_until

The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.

sort_by

The sorting direction. Supported values: `asc`, `desc`.

sort_direction

Optional comma separated string array of additional fields to include

include_fields

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.

For pagination, the marker (an opaque string value) representing the first item on the next page

cursor

Returns all activities. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href="https://support.pipedrive.com/en/article/global-user-management" target="_blank" rel="noopener noreferrer">here</a>. This endpoint has been deprecated. Please use <a href="https://developers.pipedrive.com/docs/api/v1/Activities#getActivities" target="_blank" rel="noopener noreferrer">GET /api/v2/activities</a> instead.

The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.

since

The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.

until

The ID of the user whose activities will be fetched. If omitted, all activities are returned.

Whether the activity is done or not. `false` = Not done, `true` = Done. If omitted, returns both done and not done activities.

Marks an activity as deleted. After 30 days, the activity will be permanently deleted.

Returns the details of a specific activity.

Updates an activity. Includes `more_activities_scheduled_in_context` property in response's `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). ***Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync***

The activity type was successfully created

Marks multiple activity types as deleted.

The activity types were successfully deleted

The activity type was successfully deleted

The activity type was successfully updated

Returns the add-ons for a single company.

The request contains wrong or incorrectly formatted arguments.

You don't have permission to access the resource.

A resource required to process the request was not found.

There was an error processing the request.

Returns all call logs assigned to a particular user.

For pagination, the limit of entries to be returned. The upper limit is 50.

Deletes a call log. If there is an audio recording attached to it, it will also be deleted. The related activity will not be removed by this request. If you want to remove the related activities, please use the endpoint which is specific for activities.

The ID received when you create the call log

The callLog you are trying to access is no longer available.

Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.

The audio recording was successfully added to the log.

Adds a new messaging channel, only admins are able to register new channels. It will use the getConversations endpoint to fetch conversations, participants and messages afterward. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Adds a message to a conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

The message was registered in the conversation

Deletes an existing conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

The ID of the channel provided by the integration

channel-id

The ID of the conversation provided by the integration

conversation-id

Deletes an existing messenger’s channel and all related entities (conversations and messages). To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Returns all supported currencies in given account which should be used when saving monetary values with other objects. The `code` parameter of the returning objects is the currency code according to ISO 4217 for all non-custom currencies.

Optional search term that is searched for from currency's name and/or code

term

Adds a new deal field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.

Marks a field as deleted. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/deleting-a-custom-field" target="_blank" rel="noopener noreferrer">deleting a custom field</a>.

Returns data about a specific deal field.

Updates a deal field. For more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.

Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/creating-a-deal" target="_blank" rel="noopener noreferrer">adding a deal</a>.

Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. This endpoint has been deprecated. Please use <a href="https://developers.pipedrive.com/docs/api/v1/Deals#deleteDeal" target="_blank" rel="noopener noreferrer">DELETE /api/v2/deals/{id}</a> instead.

The comma-separated IDs that will be deleted

Returns all not archived deals. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/getting-all-deals" target="_blank" rel="noopener noreferrer">getting all deals</a>.

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.

If supplied, only deals within the given stage will be returned

stage_id

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.

status

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).

sort

When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.

owned_by_you

Returns data about all not archived deals.

If supplied, only deals matching the specified filter are returned

If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.

If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.

If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.

If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.

pipeline_id

If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.

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.

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.

If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.

The field to sort by. Supported fields: `id`, `update_time`, `add_time`.

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. A maximum of 15 keys is allowed.

custom_fields

If supplied, only deals linked to the specified product are returned. If filter_id is provided, this is ignored.

product_id

Returns all deals. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href="https://support.pipedrive.com/en/article/global-user-management" target="_blank" rel="noopener noreferrer">here</a>. This endpoint has been deprecated. Please use <a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDeals" target="_blank" rel="noopener noreferrer">GET /api/v2/deals</a> instead.

If supplied, only deals matching the given user will be returned

Lists installments attached to a list of deals.

Only available in Advanced and above plans.


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.

deal_ids

The field to sort by. Supported fields: `id`, `billing_date`, `deal_id`.

Returns data about products attached to deals

An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.

The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`.

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.

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.

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

fields

When enabled, only full exact matches against the given term are returned. It is not case sensitive.

exact_match

Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.

Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.

organization_id

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.

Supports including optional fields in the results which are not provided by default

API Reference

Endpoints

LeadSources

Get all lead sources

Cost

Request

Response

Subscribe to Pipedrive’s Developer Newsletter