> ## Documentation Index
> Fetch the complete documentation index at: https://docs.push.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipedrive

Pipedrive is a sales management tool built around pipeline visualization, lead tracking, activity reminders, and automation to keep deals progressing

<Accordion title="Add an activity">
  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).
</Accordion>

<Accordion title="Add an installment subscription">
  Adds a new installment subscription.
</Accordion>

<Accordion title="Add a follower to an organization">
  Adds a follower to an organization.
</Accordion>

<Accordion title="Add a comment to a note">
  Adds a new comment to a note.
</Accordion>

<Accordion title="Add a follower to a deal">
  Adds a follower to a deal.
</Accordion>

<Accordion title="Add an organization">
  Set up a new pipedrive organization using custom fields with unique key hashes. retrieve `organizationfields` for configuration. check the linked tutorial for guidance.
</Accordion>

<Accordion title="Add a follower to a person">
  Adds a follower to a person.
</Accordion>

<Accordion title="Add a deal">
  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.
</Accordion>

<Accordion title="Add a channel">
  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.
</Accordion>

<Accordion title="Add a call log">
  Adds a new call log.
</Accordion>

<Accordion title="Add a follower to a product">
  Adds a follower to a product.
</Accordion>

<Accordion title="Add a lead label">
  Creates a lead label.
</Accordion>

<Accordion title="Add a new deal field">
  Adds a new deal field. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-new-custom-field](https://pipedrive.readme.io/docs/adding-a-new-custom-field)" target=" blank" rel="noopener noreferrer">adding a new custom field\</a>.
</Accordion>

<Accordion title="Add a lead">
  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.
</Accordion>

<Accordion title="Add a new filter">
  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.
</Accordion>

<Accordion title="Add a new person field">
  Adds a new person field. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-new-custom-field](https://pipedrive.readme.io/docs/adding-a-new-custom-field)" target=" blank" rel="noopener noreferrer">adding a new custom field\</a>.
</Accordion>

<Accordion title="Add a new organization field">
  Adds a new organization field. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-new-custom-field](https://pipedrive.readme.io/docs/adding-a-new-custom-field)" target=" blank" rel="noopener noreferrer">adding a new custom field\</a>.
</Accordion>

<Accordion title="Add a new goal">
  Adds a new goal. along with adding a new goal, a report is created to track the progress of your goal.
</Accordion>

<Accordion title="Add a new pipeline">
  Adds a new pipeline.
</Accordion>

<Accordion title="Add a new team">
  Adds a new team to the company and returns the created object.
</Accordion>

<Accordion title="Add a new product field">
  Adds a new product field. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-new-custom-field](https://pipedrive.readme.io/docs/adding-a-new-custom-field)" target=" blank" rel="noopener noreferrer">adding a new custom field\</a>.
</Accordion>

<Accordion title="Add a new user">
  Adds a new user to the company, returns the id upon success.
</Accordion>

<Accordion title="Add a note">
  Adds a new note.
</Accordion>

<Accordion title="Add a participant to a deal">
  Adds a participant to a deal.
</Accordion>

<Accordion title="Add a person">
  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.
</Accordion>

<Accordion title="Add a new stage">
  Adds a new stage, returns the id upon success.
</Accordion>

<Accordion title="Add a product to a deal">
  Adds a product to a deal, creating a new item called a deal-product.
</Accordion>

<Accordion title="Add a project">
  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.
</Accordion>

<Accordion title="Add a product">
  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](https://pipedrive.readme.io/docs/adding-a-product)" target=" blank" rel="noopener noreferrer">adding a product\</a>.
</Accordion>

<Accordion title="Add a role">
  Adds a new role.
</Accordion>

<Accordion title="Delete a deal">
  Marks a deal as deleted. after 30 days, the deal will be permanently deleted.
</Accordion>

<Accordion title="Create a new webhook">
  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.
</Accordion>

<Accordion title="Attach an audio file to the call log">
  Adds an audio recording to the call log. that audio can be played by those who have access to the call log object.
</Accordion>

<Accordion title="Add users to a team">
  Adds users to an existing team.
</Accordion>

<Accordion title="Cancel a recurring subscription">
  Cancels a recurring subscription.
</Accordion>

<Accordion title="Add or update role setting">
  Adds or updates the visibility setting for a role.
</Accordion>

<Accordion title="Add a task">
  Adds a new task.
</Accordion>

<Accordion title="Add a recurring subscription">
  Adds a new recurring subscription.
</Accordion>

<Accordion title="Create a remote file and link it to an item">
  Creates an empty file on google drive linked to an item. for details, refer to the pipedrive remote file adding tutorial.
</Accordion>

<Accordion title="Archive a project">
  Archives a project.
</Accordion>

<Accordion title="Delete a person">
  Marks a person as deleted. after 30 days, the person will be permanently deleted.
</Accordion>

<Accordion title="Delete a deal field">
  Marks a field as deleted. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/deleting-a-custom-field](https://pipedrive.readme.io/docs/deleting-a-custom-field)" target=" blank" rel="noopener noreferrer">deleting a custom field\</a>.
</Accordion>

<Accordion title="Delete a file">
  Marks a file as deleted. after 30 days, the file will be permanently deleted.
</Accordion>

<Accordion title="Create an organization relationship">
  Creates and returns an organization relationship.
</Accordion>

<Accordion title="Add new activity type">
  Adds a new activity type.
</Accordion>

<Accordion title="Add person picture">
  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.
</Accordion>

<Accordion title="Delete a pipeline">
  Marks a pipeline as deleted.
</Accordion>

<Accordion title="Delete an activity">
  Marks an activity as deleted. after 30 days, the activity will be permanently deleted.
</Accordion>

<Accordion title="Delete users from a team">
  Deletes users from an existing team.
</Accordion>

<Accordion title="Enumerate accessible users for lead">
  Lists the users permitted to access a lead.
</Accordion>

<Accordion title="Delete a task">
  Marks a task as deleted. if the task has subtasks then those will also be deleted.
</Accordion>

<Accordion title="Delete person picture">
  Deletes a person’s picture.
</Accordion>

<Accordion title="Delete multiple filters in bulk">
  Marks multiple filters as deleted.
</Accordion>

<Accordion title="Add file">
  Upload and link files to deals, people, organizations, activities, products, or leads in pipedrive. see the "adding a file" tutorial for details.
</Accordion>

<Accordion title="Download one file">
  Initializes a file download.
</Accordion>

<Accordion title="Delete a person field">
  Marks a field as deleted. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/deleting-a-custom-field](https://pipedrive.readme.io/docs/deleting-a-custom-field)" target=" blank" rel="noopener noreferrer">deleting a custom field\</a>.
</Accordion>

<Accordion title="Delete a product">
  Marks a product as deleted. after 30 days, the product will be permanently deleted.
</Accordion>

<Accordion title="Duplicate deal">
  Duplicates a deal.
</Accordion>

<Accordion title="Delete multiple organizations in bulk">
  Marks multiple organizations as deleted. after 30 days, the organizations will be permanently deleted.
</Accordion>

<Accordion title="Delete existing goal">
  Marks a goal as deleted.
</Accordion>

<Accordion title="Delete multiple organization fields in bulk">
  Marks multiple fields as deleted.
</Accordion>

<Accordion title="Delete existing webhook">
  Deletes the specified webhook.
</Accordion>

<Accordion title="Get all activity fields">
  Returns all activity fields.
</Accordion>

<Accordion title="Get all activity types">
  Returns all activity types.
</Accordion>

<Accordion title="Get all activities beta">
  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.
</Accordion>

<Accordion title="Delete a filter">
  Marks a filter as deleted.
</Accordion>

<Accordion title="Get all call logs assigned to a particular user">
  Returns all call logs assigned to a particular user.
</Accordion>

<Accordion title="Delete a product field">
  Marks a product field as deleted. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/deleting-a-custom-field](https://pipedrive.readme.io/docs/deleting-a-custom-field)" target=" blank" rel="noopener noreferrer">deleting a custom field\</a>.
</Accordion>

<Accordion title="Get all lead labels">
  Returns details of all lead labels. this endpoint does not support pagination and all labels are always returned.
</Accordion>

<Accordion title="Delete mail thread">
  Marks a mail thread as deleted.
</Accordion>

<Accordion title="Get all filter helpers">
  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.
</Accordion>

<Accordion title="Get all files">
  Returns data about all files.
</Accordion>

<Accordion title="Get all comments for a note">
  Returns all comments associated with a note.
</Accordion>

<Accordion title="Get all add ons for a single company">
  Returns the add-ons for a single company.
</Accordion>

<Accordion title="Delete an activity type">
  Marks an activity type as deleted.
</Accordion>

<Accordion title="Get all filters">
  Returns data about all filters.
</Accordion>

<Accordion title="Get all deals">
  Returns all deals. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/getting-all-deals](https://pipedrive.readme.io/docs/getting-all-deals)" target=" blank" rel="noopener noreferrer">getting all deals\</a>.
</Accordion>

<Accordion title="Delete a follower from an organization">
  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"\&gt;list](https://developers.pipedrive.com/docs/api/v1/organizations#getorganizationfollowers"\&gt;list) followers of an organization\</a> endpoint.
</Accordion>

<Accordion title="Delete multiple activities in bulk">
  Marks multiple activities as deleted. after 30 days, the activities will be permanently deleted.
</Accordion>

<Accordion title="Get all leads">
  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.
</Accordion>

<Accordion title="Delete an attached product from a deal">
  Deletes a product attachment from a deal, using the `product attachment id`.
</Accordion>

<Accordion title="Find goals">
  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.
</Accordion>

<Accordion title="Get all mail messages of mail thread">
  Returns all the mail messages inside a specified mail thread.
</Accordion>

<Accordion title="Delete multiple persons in bulk">
  Marks multiple persons as deleted. after 30 days, the persons will be permanently deleted.
</Accordion>

<Accordion title="Get all lead sources">
  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.
</Accordion>

<Accordion title="Delete a follower from a deal">
  Deletes a follower from a deal.
</Accordion>

<Accordion title="Get all payments of a subscription">
  Returns all payments of an installment or recurring subscription.
</Accordion>

<Accordion title="Get all organizations">
  Returns all organizations.
</Accordion>

<Accordion title="Get all organizations beta">
  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.
</Accordion>

<Accordion title="Get all organization fields">
  Returns data about all organization fields.
</Accordion>

<Accordion title="Get all deals beta">
  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.
</Accordion>

<Accordion title="Delete a project">
  Marks a project as deleted.
</Accordion>

<Accordion title="Delete multiple person fields in bulk">
  Marks multiple fields as deleted.
</Accordion>

<Accordion title="Delete multiple activity types in bulk">
  Marks multiple activity types as deleted.
</Accordion>

<Accordion title="Get all persons">
  Returns all persons.
</Accordion>

<Accordion title="Delete a follower from a person">
  Deletes a follower from a person.
</Accordion>

<Accordion title="Get all deal fields">
  Returns data about all deal fields.
</Accordion>

<Accordion title="Get all persons beta">
  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.
</Accordion>

<Accordion title="Delete a role">
  Marks a role as deleted.
</Accordion>

<Accordion title="Get all product fields">
  Returns data about all product fields.
</Accordion>

<Accordion title="Delete multiple product fields in bulk">
  Marks multiple fields as deleted.
</Accordion>

<Accordion title="Get all permission sets">
  Returns data about all permission sets.
</Accordion>

<Accordion title="Get all person fields">
  Returns data about all person fields.

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

<Accordion title="Get all pipelines">
  Returns data about all pipelines.
</Accordion>

<Accordion title="Get all products">
  Returns data about all products.
</Accordion>

<Accordion title="Delete a role assignment">
  Removes the assigned user from a role and adds to the default role.
</Accordion>

<Accordion title="Delete multiple deals in bulk">
  Marks multiple deals as deleted. after 30 days, the deals will be permanently deleted.
</Accordion>

<Accordion title="Delete multiple stages in bulk">
  Marks multiple stages as deleted.
</Accordion>

<Accordion title="Delete a stage">
  Marks a stage as deleted.
</Accordion>

<Accordion title="Delete a lead">
  Deletes a specific lead.
</Accordion>

<Accordion title="Add role assignment">
  Assigns a user to a role.
</Accordion>

<Accordion title="Delete a lead label">
  Deletes a specific lead label.
</Accordion>

<Accordion title="Get all notes">
  Returns all notes.
</Accordion>

<Accordion title="Find users by name">
  Finds users by their name.
</Accordion>

<Accordion title="Delete a subscription">
  Marks an installment or a recurring subscription as deleted.
</Accordion>

<Accordion title="Delete multiple deal fields in bulk">
  Marks multiple deal fields as deleted.
</Accordion>

<Accordion title="Delete an organization field">
  Marks a field as deleted. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/deleting-a-custom-field](https://pipedrive.readme.io/docs/deleting-a-custom-field)" target=" blank" rel="noopener noreferrer">deleting a custom field\</a>.
</Accordion>

<Accordion title="Delete a channel">
  The endpoint removes a messenger channel along with conversations and messages. requires messengers integration oauth and messaging app extension manifest.
</Accordion>

<Accordion title="Delete an organization relationship">
  Deletes an organization relationship and returns the deleted id.
</Accordion>

<Accordion title="Get all activities assigned to a particular user">
  Returns all activities assigned to a particular user.
</Accordion>

<Accordion title="Delete a comment related to a note">
  Deletes a comment.
</Accordion>

<Accordion title="Find subscription by deal">
  Returns details of an installment or a recurring subscription by the deal id.
</Accordion>

<Accordion title="Delete a note">
  Deletes a specific note.
</Accordion>

<Accordion title="Delete a participant from a deal">
  Deletes a participant from a deal.
</Accordion>

<Accordion title="Get all note fields">
  Returns data about all note fields.
</Accordion>

<Accordion title="Delete an organization">
  Marks an organization as deleted. after 30 days, the organization will be permanently deleted.
</Accordion>

<Accordion title="Delete a call log">
  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.
</Accordion>

<Accordion title="Delete a 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).
</Accordion>

<Accordion title="Delete a follower from a product">
  Deletes a follower from a product.
</Accordion>

<Accordion title="Get all users">
  Returns data about all users within the company.
</Accordion>

<Accordion title="Get all supported currencies">
  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.
</Accordion>

<Accordion title="Get all tasks">
  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](https://pipedrive.readme.io/docs/core-api-concepts-pagination)" target=" blank" rel="noopener noreferrer">pagination\</a>.
</Accordion>

<Accordion title="Get all projects">
  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](https://pipedrive.readme.io/docs/core-api-concepts-pagination)" target=" blank" rel="noopener noreferrer">pagination\</a>.
</Accordion>

<Accordion title="Get all relationships for organization">
  Gets all of the relationships for a supplied organization id.
</Accordion>

<Accordion title="Get all project templates">
  The endpoint retrieves all non-deleted project templates with cursor-based pagination. refer to the provided documentation link for more details on pagination.
</Accordion>

<Accordion title="Get details of a phase">
  Returns the details of a specific project phase.
</Accordion>

<Accordion title="Get one file">
  Returns data about a specific file.
</Accordion>

<Accordion title="Get details of a deal">
  Fetches specific deal details, including exclusive fields like deal age and pipeline stage duration. custom fields show up as hashes, which can be matched using the 'key' from dealfields. see the deal details tutorial for more.
</Accordion>

<Accordion title="Get a single team">
  Returns data about a specific team.
</Accordion>

<Accordion title="Get all stages">
  Returns data about all stages.
</Accordion>

<Accordion title="Get current user data">
  Returns data about an authorized user within the company with bound company data: company id, company name, and domain. note that the `locale` property means 'date/number format' in the pipedrive account settings, not the chosen language.
</Accordion>

<Accordion title="Get deals timeline">
  Returns opened and won deals in time-based groups according to a specified dealfield, with examples of deals grouped by month over a 3-month period starting january 2012.
</Accordion>

<Accordion title="Get all project boards">
  Returns all projects boards that are not deleted.
</Accordion>

<Accordion title="Get details of a person">
  The text describes an api endpoint that returns detailed person information, including extra fields and custom fields as hashes. it also provides `data.marketing status` if the campaigns product is used.
</Accordion>

<Accordion title="Get details of a project">
  Returns the details of a specific project. also note that custom fields appear as long hashes in the resulting data. these hashes can be mapped against the `key` value of project fields.
</Accordion>

<Accordion title="Get all teams of a user">
  Returns data about all teams which have the specified user as a member.
</Accordion>

<Accordion title="Get all roles">
  Returns all the roles within the company.
</Accordion>

<Accordion title="Get all users in a team">
  Returns a list of all user ids within a team.
</Accordion>

<Accordion title="Get one organization field">
  Returns data about a specific organization field.
</Accordion>

<Accordion title="Get one filter">
  Returns data about a specific filter. note that this also returns the condition lines of the filter.
</Accordion>

<Accordion title="Get all user connections">
  Returns data about all connections for the authorized user.
</Accordion>

<Accordion title="Get one product field">
  Returns data about a specific product field.
</Accordion>

<Accordion title="Get one role">
  Returns the details of a specific role.
</Accordion>

<Accordion title="Get one product">
  Returns data about a specific product.
</Accordion>

<Accordion title="Get one deal field">
  Returns data about a specific deal field.
</Accordion>

<Accordion title="Get one lead">
  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.
</Accordion>

<Accordion title="Get one stage">
  Returns data about a specific stage.
</Accordion>

<Accordion title="Get result of a goal">
  Gets the progress of a goal for the specified period.
</Accordion>

<Accordion title="Get one user">
  Returns data about a specific user within the company.
</Accordion>

<Accordion title="Get all webhooks">
  Returns data about all the webhooks of a company.
</Accordion>

<Accordion title="Get one organization relationship">
  Finds and returns an organization relationship from its id.
</Accordion>

<Accordion title="Get one note">
  Returns details about a specific note.
</Accordion>

<Accordion title="Get one pipeline">
  Returns data about a specific pipeline. also returns the summary of the deals in this pipeline across its stages.
</Accordion>

<Accordion title="Get details of a subscription">
  Returns details of an installment or a recurring subscription.
</Accordion>

<Accordion title="Link a remote file to an item">
  Links an existing remote file (`googledrive`) to the item you supply. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-remote-file](https://pipedrive.readme.io/docs/adding-a-remote-file)" target=" blank" rel="noopener noreferrer">adding a remote file\</a>.
</Accordion>

<Accordion title="List all persons associated with a deal">
  The endpoint lists every person linked to a deal, including primary contacts and participants, and provides a `data.marketing status` field for users of the campaigns product.
</Accordion>

<Accordion title="List activities associated with a deal">
  Lists activities associated with a deal.
</Accordion>

<Accordion title="Get one mail message">
  Returns data about a specific mail message.
</Accordion>

<Accordion title="Get project phases">
  Returns all active project phases under a specific board.
</Accordion>

<Accordion title="Get deals conversion rates in pipeline">
  Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
</Accordion>

<Accordion title="Get recents">
  Returns data about all recent changes occurred after the given timestamp.
</Accordion>

<Accordion title="List activities associated with a person">
  Lists activities associated with a person.
</Accordion>

<Accordion title="List followers of an organization">
  Lists the followers of an organization.
</Accordion>

<Accordion title="List deals associated with an organization">
  Lists deals associated with an organization.
</Accordion>

<Accordion title="List files attached to a deal">
  Lists files associated with a deal.
</Accordion>

<Accordion title="List followers of a person">
  Lists the followers of a person.
</Accordion>

<Accordion title="List files attached to a person">
  Lists files associated with a person.
</Accordion>

<Accordion title="Get all teams">
  Returns data about teams within the company.
</Accordion>

<Accordion title="Get deals in a pipeline">
  Lists deals in a specific pipeline across all its stages.
</Accordion>

<Accordion title="Get one mail thread">
  Returns a specific mail thread.
</Accordion>

<Accordion title="List files attached to a product">
  Lists files associated with a product.
</Accordion>

<Accordion title="List activities associated with an organization">
  Lists activities associated with an organization.
</Accordion>

<Accordion title="List followers of a deal">
  Lists the followers of a deal.
</Accordion>

<Accordion title="Get details of a task">
  Returns the details of a specific task.
</Accordion>

<Accordion title="Get one permission set">
  Returns data about a specific permission set.
</Accordion>

<Accordion title="Get deals movements in pipeline">
  Returns statistics for deals movements for the given time period.
</Accordion>

<Accordion title="Link a user with the installed video call integration">
  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.
</Accordion>

<Accordion title="Get one person field">
  Returns data about a specific person field.
</Accordion>

<Accordion title="Get mail threads">
  Returns mail threads in a specified folder ordered by the most recent message within.
</Accordion>

<Accordion title="List deals associated with a person">
  Lists deals associated with a person.
</Accordion>

<Accordion title="Get deals in a stage">
  Lists deals in a specific stage.
</Accordion>

<Accordion title="Get details of an activity">
  Returns the details of a specific activity.
</Accordion>

<Accordion title="Get details of a call log">
  Returns details of a specific call log.
</Accordion>

<Accordion title="Get details of a template">
  Returns the details of a specific project template.
</Accordion>

<Accordion title="Get one comment">
  Returns the details of a comment.
</Accordion>

<Accordion title="Get details of an organization">
  Provides detailed information about an organization, including additional fields not shown when listing all organizations, and maps custom fields as long hashes to the 'key' value in organizationfields.
</Accordion>

<Accordion title="Get deals summary">
  Returns a summary of all the deals.
</Accordion>

<Accordion title="Get details of a board">
  Returns the details of a specific project board.
</Accordion>

<Accordion title="List mail messages associated with a deal">
  Lists mail messages associated with a deal.
</Accordion>

<Accordion title="List mail messages associated with a person">
  Lists mail messages associated with a person.
</Accordion>

<Accordion title="List permitted users">
  Lists the users permitted to access a deal.
</Accordion>

<Accordion title="List mail messages associated with an organization">
  Lists mail messages associated with an organization.
</Accordion>

<Accordion title="List followers of a user">
  Lists the followers of a specific user.
</Accordion>

<Accordion title="Get deals where a product is attached to">
  Returns data about deals that have a product attached to it.
</Accordion>

<Accordion title="List followers of a product">
  Lists the followers of a product.
</Accordion>

<Accordion title="List files attached to an organization">
  Lists files associated with an organization.
</Accordion>

<Accordion title="List participants of a deal">
  Lists the participants associated with a deal.

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

<Accordion title="List role assignments lists role assignments for a user">
  Lists role assignments for a user.
</Accordion>

<Accordion title="List settings of an authorized user">
  Lists the settings of an authorized user. example response contains a shortened list of settings.
</Accordion>

<Accordion title="List permitted users list users permitted to access a person">
  List users permitted to access a person.
</Accordion>

<Accordion title="List permitted users lists users permitted to access a product">
  Lists users permitted to access a product.
</Accordion>

<Accordion title="List persons of an organization">
  Lists persons associated with an organization.

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

<Accordion title="List role assignments">
  Returns all users assigned to a role.
</Accordion>

<Accordion title="List permission set assignments">
  Returns the list of assignments for a permission set.
</Accordion>

<Accordion title="List pipeline visibility for a role">
  Returns a list of visible or hidden pipeline ids by role. see the "visibility groups article" for details on pipeline visibility.
</Accordion>

<Accordion title="List updates about a person">
  Lists updates about a person.

  if a company uses the [campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing status` field.
</Accordion>

<Accordion title="List updates about a deal">
  Lists updates about a deal.
</Accordion>

<Accordion title="Merge two organizations">
  Merges an organization with another organization. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/merging-two-organizations](https://pipedrive.readme.io/docs/merging-two-organizations)" target=" blank" rel="noopener noreferrer">merging two organizations\</a>.
</Accordion>

<Accordion title="Merge two deals">
  Merges a deal with another deal. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/merging-two-deals](https://pipedrive.readme.io/docs/merging-two-deals)" target=" blank" rel="noopener noreferrer">merging two deals\</a>.
</Accordion>

<Accordion title="List user role settings">
  Lists the settings of user's assigned role.
</Accordion>

<Accordion title="List role settings">
  Returns the visibility settings of a specific role.
</Accordion>

<Accordion title="List updates about participants of a deal">
  This endpoint provides cursor-paginated updates on deal participants. for pagination details, see the pipedrive documentation.
</Accordion>

<Accordion title="List updates about an organization">
  Lists updates about an organization.
</Accordion>

<Accordion title="List user permissions">
  Lists aggregated permissions over all assigned permission sets for a user.
</Accordion>

<Accordion title="List products associated with a person">
  Lists products associated with a person.
</Accordion>

<Accordion title="Organization accessible user list">
  List users permitted to access an organization.
</Accordion>

<Accordion title="Merge two persons">
  Merges a person with another person. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/merging-two-persons](https://pipedrive.readme.io/docs/merging-two-persons)" target=" blank" rel="noopener noreferrer">merging two persons\</a>.
</Accordion>

<Accordion title="Perform a search from multiple item types">
  Performs a search from your choice of item types and fields.
</Accordion>

<Accordion title="List products attached to a deal">
  Lists products attached to a deal.
</Accordion>

<Accordion title="Perform a search using a specific field from an item type">
  Performs a search from the values of a specific field. results can either be the distinct values of the field (useful for searching autocomplete field values), or the ids of actual items (deals, leads, persons, organizations or products).
</Accordion>

<Accordion title="Returns project groups">
  Returns all active groups under a specific project.
</Accordion>

<Accordion title="Receives an incoming message">
  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).
</Accordion>

<Accordion title="Refreshing the tokens">
  Access tokens expire after the time specified in `expires in`. to continue accessing the api, use the `refresh token` to obtain a new access token.
</Accordion>

<Accordion title="Update an installment subscription">
  Updates an installment subscription.
</Accordion>

<Accordion title="Update stage details">
  Updates the properties of a stage.
</Accordion>

<Accordion title="Returns project activities">
  Returns activities linked to a specific project.
</Accordion>

<Accordion title="Returns project plan">
  Returns information about items in a project plan. items consists of tasks and activities and are linked to specific project phase and group.
</Accordion>

<Accordion title="Update a lead label">
  Updates one or more properties of a lead label. only properties included in the request will be updated.
</Accordion>

<Accordion title="Update an organization">
  Updates the properties of an organization.
</Accordion>

<Accordion title="Update a recurring subscription">
  Updates a recurring subscription.
</Accordion>

<Accordion title="Requesting authorization">
  Authorize a user by redirecting them to the pipedrive oauth authorization page and request their permissions to act on their behalf. this step is necessary to implement only when you allow app installation outside of the marketplace.
</Accordion>

<Accordion title="Update a note">
  Updates a note.
</Accordion>

<Accordion title="Returns project tasks">
  Returns tasks linked to a specific project.
</Accordion>

<Accordion title="Search deals">
  This api endpoint searches deals by title, notes, and custom fields, filters results by person or organization id, and is a specific use case of /v1/itemsearch with limited oauth scope.
</Accordion>

<Accordion title="Update task in project plan">
  Updates a task phase or group in a project.
</Accordion>

<Accordion title="Update a person">
  Modifies a person’s details in pipedrive. see the linked tutorial for guidance. if utilizing campaigns, the endpoint also handles `data.marketing status`.
</Accordion>

<Accordion title="Update a team">
  Updates an existing team and returns the updated object.
</Accordion>

<Accordion title="Update a task">
  Updates a task.
</Accordion>

<Accordion title="Search leads">
  Endpoint searches leads by title, notes, custom fields, with options to filter by person and organization ids, and is a more specific use of the /v1/itemsearch with limited oauth scope.
</Accordion>

<Accordion title="Update an activity type">
  Updates an activity type.
</Accordion>

<Accordion title="Update an organization field">
  Updates an organization field. for more information, see the tutorial for \<a href=" [https://pipedrive.readme.io/docs/updating-custom-field-value](https://pipedrive.readme.io/docs/updating-custom-field-value) " target=" blank" rel="noopener noreferrer">updating custom fields' values\</a>.
</Accordion>

<Accordion title="Search organizations">
  Searches all organizations by name, address, notes and/or custom fields. this endpoint is a wrapper of \<a href="[https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem"\&gt;/v1/itemsearch\&lt;/a](https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem"\&gt;/v1/itemsearch\&lt;/a)> with a narrower oauth scope.
</Accordion>

<Accordion title="Update an organization relationship">
  Updates and returns an organization relationship.
</Accordion>

<Accordion title="Search persons">
  This endpoint searches for individuals by various identifiers and is a specific use case of /v1/itemsearch with limited oauth scope, allowing results filtering by organization id.
</Accordion>

<Accordion title="Update the product attached to a deal">
  Updates the details of the product that has been attached to a deal.
</Accordion>

<Accordion title="Update a pipeline">
  Updates the properties of a pipeline.
</Accordion>

<Accordion title="Update a person field">
  Updates a person field. for more information, see the tutorial for \<a href=" [https://pipedrive.readme.io/docs/updating-custom-field-value](https://pipedrive.readme.io/docs/updating-custom-field-value) " target=" blank" rel="noopener noreferrer">updating custom fields' values\</a>.
</Accordion>

<Accordion title="Update existing goal">
  Updates an existing goal.
</Accordion>

<Accordion title="Search products">
  Searches all products by name, code and/or custom fields. this endpoint is a wrapper of \<a href="[https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem"\&gt;/v1/itemsearch\&lt;/a](https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem"\&gt;/v1/itemsearch\&lt;/a)> with a narrower oauth scope.
</Accordion>

<Accordion title="Update a comment related to a note">
  Updates a comment related to a note.
</Accordion>

<Accordion title="Update a product">
  Updates product data.
</Accordion>

<Accordion title="Update file details">
  Updates the properties of a file.
</Accordion>

<Accordion title="Pipedrive Unlink User From Video Call Integration">
  A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.
</Accordion>

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

<Accordion title="Update filter">
  Updates an existing filter.
</Accordion>

<Accordion title="Update activity in project plan">
  Updates an activity phase or group in a project.
</Accordion>

<Accordion title="Update an 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).
</Accordion>

<Accordion title="Update pipeline visibility for a role">
  Updates pipeline visibility settings for different roles. for details, see the pipedrive visibility groups article.
</Accordion>

<Accordion title="Update mail thread details">
  Updates the properties of a mail thread.
</Accordion>

<Accordion title="Update a deal field">
  Updates a deal field. for more information, see the tutorial for \<a href=" [https://pipedrive.readme.io/docs/updating-custom-field-value](https://pipedrive.readme.io/docs/updating-custom-field-value) " target=" blank" rel="noopener noreferrer">updating custom fields' values\</a>.
</Accordion>

<Accordion title="Update a project">
  Updates a project.
</Accordion>

<Accordion title="Update role details">
  Updates the parent role and/or the name of a specific role.
</Accordion>

<Accordion title="Update user details">
  Updates the properties of a user. currently, only `active flag` can be updated.
</Accordion>

<Accordion title="Update a lead">
  Updating lead properties modifies only specified fields; use `null` to unset. custom field data matches `deals`. unset fields are omitted. leads share deals' custom fields. for examples, refer to the tutorial.
</Accordion>

<Accordion title="Update a product field">
  Updates a product field. for more information, see the tutorial for \<a href=" [https://pipedrive.readme.io/docs/updating-custom-field-value](https://pipedrive.readme.io/docs/updating-custom-field-value) " target=" blank" rel="noopener noreferrer">updating custom fields' values\</a>.
</Accordion>