Pipedrive

New activity added. response includes `more activities scheduled in context` to show if more are planned with the same entity. see tutorial on adding activities [here](https://pipedrive.readme.io/docs/adding-an-activity).

Add a new deal to pipedrive with any custom fields, which vary by account and are identified by long hash keys. check dealfields for existing custom fields. for details, visit the tutorial on adding a deal.

Pipedrive api lets you add leads linked to people or organizations and tags them with 'api' source. custom fields from deals apply to leads and appear in responses if set. details are in the tutorials for adding and updating leads.

Adds a new note.

Add a new contact in pipedrive with optional custom fields unique to each account found using the `personfields` endpoint. the endpoint also handles `data.marketing status` for campaigns product users.

Adds a new product to the products inventory. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-product" target=" blank" rel="noopener noreferrer">adding a product</a>.

The api returns sorted leads by creation time, supporting pagination via `limit` and `start`. custom field values are included if set, mimicking the `deals` endpoint structure; unset fields are omitted. leads share custom fields with deals.

Returns data about all products.

Api returns specific lead details with custom field values in the deals format. unset custom fields are omitted. leads share custom fields with deals, not having a unique set.

Updates the properties of a deal. for more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/updating-a-deal" target=" blank" rel="noopener noreferrer">updating a deal</a>.

Modifies a person’s details in pipedrive. see the linked tutorial for guidance. if utilizing campaigns, the endpoint also handles `data.marketing status`.

Adds a new installment subscription.

Set up a new pipedrive organization using custom fields with unique key hashes. retrieve `organizationfields` for configuration. check the linked tutorial for guidance.

Adds a new call log.

New messaging channel added; registration limited to admins. utilizes getconversations endpoint for data retrieval. requires messengers integration oauth scope and a prepared messaging app extension manifest.

Adds a new comment to a note.

Adds a follower to an organization.

Adds a follower to a deal.

Adds a follower to a person.

Adds a follower to a product.

Creates a lead label.

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

New filter creation returns an id. only one primary condition group with 'and' and two secondary groups (one 'and', one 'or') are supported. future syntax expansion possible. see tutorial for details.

Adds a new goal. along with adding a new goal, a report is created to track the progress of your goal.

Adds a new organization 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>.

Adds a new person 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>.

Adds a new pipeline.

Adds a new product 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>.

Adds a new stage, returns the id upon success.

Adds a new team to the company and returns the created object.

Adds a new user to the company, returns the id upon success.

Adds a participant to a deal.

Adds a product to a deal, creating a new item called a deal-product.

Adds a new project. 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.

Adds a new recurring subscription.

Adds a new role.

Adds a new task.

Upload and link files to deals, people, organizations, activities, products, or leads in pipedrive. see the "adding a file" tutorial for details.

Adds a new activity type.

Adds or updates the visibility setting for a role.

This service allows adding a photo to a person's profile, replacing any existing one. images must be square with a minimum size of 128 pixels and in gif, jpg, or png formats. they will be resized to 128 and 512 pixels.

Assigns a user to a role.

Adds users to an existing team.

Archives a project.

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

Cancels a recurring subscription.

Creates and returns an organization relationship.

Creates and returns details of a new webhook. trigger events combine `event action` and `event object`, like `*.*` for all events or `added.deal`, `deleted.persons` for specific actions. more info in the webhooks guide.

Creates an empty file on google drive linked to an item. for details, refer to the pipedrive remote file adding tutorial.

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

Marks an activity type as deleted.

Deletes a product attachment from a deal, using the `product attachment id`.

Marks an organization as deleted. after 30 days, the organization will be permanently deleted.

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

Deletes an organization relationship and returns the deleted id.

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 endpoint removes a messenger channel along with conversations and messages. requires messengers integration oauth and messaging app extension manifest.

Deletes a comment.

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

Marks a deal as deleted. after 30 days, the deal will be permanently deleted.

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

Marks a file as deleted. after 30 days, the file will be permanently deleted.

Marks a filter as deleted.

Deletes a follower from an organization. you can retrieve the `follower id` from the <a href="https://developers.pipedrive.com/docs/api/v1/organizations#getorganizationfollowers">list followers of an organization</a> endpoint.

Deletes a follower from a deal.

Deletes a follower from a person.

Deletes a follower from a product.

Deletes a specific lead.

Deletes a specific lead label.

Deletes a specific note.

Deletes a participant from a deal.

Marks a person as deleted. after 30 days, the person will be permanently deleted.

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

Marks a pipeline as deleted.

Marks a product as deleted. after 30 days, the product will be permanently deleted.

Marks a product 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>.

Marks a project as deleted.

Marks a role as deleted.

Removes the assigned user from a role and adds to the default role.

Marks a stage as deleted.

Marks an installment or a recurring subscription as deleted.

Marks a task as deleted. if the task has subtasks then those will also be deleted.

Marks a goal as deleted.

Deletes the specified webhook.

Marks a mail thread as deleted.

Marks multiple activities as deleted. after 30 days, the activities will be permanently deleted.

Marks multiple activity types as deleted.

Marks multiple deals as deleted. after 30 days, the deals will be permanently deleted.

Marks multiple deal fields as deleted.

Marks multiple filters as deleted.

Marks multiple organizations as deleted. after 30 days, the organizations will be permanently deleted.

Marks multiple fields as deleted.

Marks multiple persons as deleted. after 30 days, the persons will be permanently deleted.

Marks multiple fields as deleted.

Marks multiple fields as deleted.

Marks multiple stages as deleted.

Deletes a person’s picture.

Deletes users from an existing team.

Initializes a file download.

Duplicates a deal.

Lists the users permitted to access a lead.

Query goal data by appending `{searchfield}={searchvalue}` to the url with dot-notation fields and values. include `is active` to filter by goal status and specify both `period.start` and `period.end` for time-based searches.

Returns details of an installment or a recurring subscription by the deal id.

Finds users by their name.

Returns all activities assigned to a particular user.

This beta cursor-paginated endpoint returns all activities, accessible only to global admins, not regular users who get a 403 error. refer to pipedrive's documentation for pagination and global permissions.

Returns all activity fields.

Returns all activity types.

Returns the add-ons for a single company.

Returns all call logs assigned to a particular user.

Returns all comments associated with a note.

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

This endpoint returns all deals with cursor pagination (in beta). only global admins can access it; others get a 403 error. more info on pagination and permissions is available online.

Returns data about all deal fields.

Returns data about all files.

Returns data about all filters.

The text provides links to documentation for adding or updating filters, and information on all supported filter helpers in an api. it encourages consulting a tutorial for more details on adding a filter.

Returns details of all lead labels. this endpoint does not support pagination and all labels are always returned.

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.

Returns all the mail messages inside a specified mail thread.

Returns all notes.

Returns data about all note fields.

Returns all organizations.

This beta api endpoint lists all organizations with cursor pagination. only global admins have access; others get a 403 error. see docs for pagination and global permissions.

Returns data about all organization fields.

Returns all payments of an installment or recurring subscription.

Returns data about all permission sets.

Returns all persons.

This beta endpoint returns all persons, using cursor pagination. only global admins have access; others get a 403 error. info on pagination and permissions is in the linked docs.

Returns data about all person fields.<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.

Returns data about all pipelines.

Returns data about all product fields.

Returns all projects. 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>.

Returns all projects boards that are not deleted.

The endpoint retrieves all non-deleted project templates with cursor-based pagination. refer to the provided documentation link for more details on pagination.

Gets all of the relationships for a supplied organization id.

Returns all the roles within the company.

Returns data about all stages.

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.

Returns all tasks. 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>.

Returns data about teams within the company.

Returns data about all teams which have the specified user as a member.

Returns data about all users within the company.

Returns a list of all user ids within a team.

Returns data about all connections for the authorized user.