Pipedrive

Checks the status (not_started, running, completed, failed, rejected) of a lead-to-deal conversion job, returning the resulting deal ID once completed. Use the lead ID and conversion_id returned by convertLeadToDeal — this data is only available for a few days after conversion.

getLeadConversionStatus

Returns the calling user, pipelines with their stages, custom field keys for deals/persons/organizations/products/projects/activities, and the list of other company users in one call. Call this before filling in pipeline IDs, stage IDs, custom field keys, or user/account details instead of guessing or asking the user.

getAccountContext

Retrieves a list of activities (calls, meetings, tasks, emails, deadlines) with filtering by owner, deal, lead, person, organization, done status, and update time. Use for activity feeds, reporting, or finding activities tied to a specific record — narrow with deal_id (getDeal/searchDeals), lead_id (getLeads/searchLeads), person_id (getPerson/searchPersons), or org_id (getOrganization/searchOrganization). filter_id, when supplied, overrides those filters. Prefer this over looping getActivity by ID.

getActivities

Retrieves paginated, non-archived deals with filtering by owner, person, organization, pipeline, stage, status, and update time. Essential for analytics, reporting, dashboards, and bulk operations — filters combine for precise selection, and filter_id overrides the individual filters when supplied. Narrow by person_id or org_id using IDs from getPerson/searchPersons or getOrganization/searchOrganization. Prefer this (or searchDeals) over looping getDeal by ID.

getDeals

Returns non-archived leads sorted oldest to newest, filterable by owner, person, organization, filter, and update time (filter_id overrides the other filters when supplied). Leads inherit deals' custom-field structure. Narrow by person_id/organization_id using IDs from getPerson/searchPersons or getOrganization/searchOrganization. Prefer this or searchLeads for browsing/finding leads.

getLeads

List all mail messages inside a specific mail thread (i.e. the full conversation), given the thread's ID. Use this after getMailThreads/getMailThread to read an entire email conversation rather than a single message.

getMailThreadMessages

Returns notes, filterable by the deal, person, organization, project, or lead they're attached to (or by author, date range, and pinned state). Narrow with deal_id (getDeal/searchDeals), person_id (getPerson/searchPersons), org_id (getOrganization/searchOrganization), project_id (getProject/searchProjects), or lead_id (getLeads/searchLeads). Prefer this over looping getNote by ID.

getNotes

Retrieves a paginated list of organizations, filterable by owner, specific IDs, and update time (filter_id, when supplied, overrides those filters). Use for company/account lists, reporting, or bulk operations. Prefer this or searchOrganization over looping getOrganization by ID.

getOrganizations

Retrieves a paginated list of persons (contacts), filterable by organization, linked deal, owner, and update time. Use for contact lists, reporting, or finding all people linked to an organization/deal — narrow with org_id (from getOrganization/searchOrganization) or deal_id (from getDeal/searchDeals). Prefer this or searchPersons over looping getPerson by ID.

getPersons

Lists all variations (e.g. size/color options with their own prices) defined for a product. Use before updating a variation (updateProductVariation needs the variation ID returned here) or to present purchasable options for a product. Find the product ID first with getProducts or searchProducts.

getProductVariations

Retrieves a paginated list of products from the product catalog, filterable by owner, specific IDs, filter, and update time. Use for catalog browsing, inventory reporting, or before attaching products to a deal (addDealProduct needs a product ID from here or searchProducts). Prefer this or searchProducts over looping getProduct by ID.

getProducts

Lists all pipeline stages — name, pipeline, order, deal_probability, and rotten-deal settings — optionally narrowed to one pipeline via pipeline_id. Use to discover valid stage_id values before creating or updating deals with addDeal/updateDeal, or before fetching one stage's full detail with getStage.

getStages

Retrieves product line items attached across up to 100 deals in one call — quantities, prices, discounts, and totals per deal. Use for bulk revenue/commission analysis across a portfolio of deals; get the deal_ids from getDeals or searchDeals first. If you only need one deal's products, use getDealProducts instead.

getDealsProducts

Lists deals that have a given product attached, optionally filtered by deal status (open/won/lost), with pagination. Use to see where a product is being sold or to analyze its usage across the pipeline. Find the product ID first with getProducts or searchProducts; use getDeal for full details of one deal returned here rather than looping over all of them.

getProductDeals

Fetches comprehensive details of one deal by ID — all properties, custom fields, associated person/organization, and metadata. Use once you have a specific deal ID (e.g. from getDeals or searchDeals) for detail views or before updating it; don't call this in a loop over many IDs — use getDeals (with filters) or searchDeals instead.

getDeal

Fetches full details of one organization by ID. Use once you have a specific organization ID (e.g. from getOrganizations or searchOrganization); don't call this in a loop over many IDs — use getOrganizations or searchOrganization instead.

getOrganization

Fetches full details of one person by ID — contact info, linked organization, and (if contact sync is enabled) fields like birthday and job title. Use once you have a specific person ID (e.g. from getPersons or searchPersons); don't loop this to fetch many contacts — use getPersons or searchPersons instead.

getPerson

Retrieves full details of a single activity by ID — type, subject, due date/time, duration, participants, and linked deal/lead/person/organization. Use once you have a specific activity ID (e.g. from getActivities); don't call this in a loop to fetch many activities — use getActivities with filters instead.

getActivity

Retrieves a product's image as a public URL (valid for 7 days). Find the product ID first with getProducts or searchProducts.

getProductImage

List mail threads in a given mailbox folder (inbox, drafts, sent, or archive), ordered by most recent message, with pagination. Use this to browse or page through the user's mailbox. Each thread returned is a summary; fetch an individual thread with getMailThread or its messages with getMailThreadMessages for full detail.

getMailThreads

Fetches full details of one lead by ID — title, value, expected close date, linked person/organization, and custom fields (leads share deals' custom-field structure; unset fields are omitted from the response). Use once you have a specific lead ID (e.g. from getLeads or searchLeads); don't call this in a loop over many IDs — use getLeads or searchLeads instead.

getLead

Fetch a single mail message by its ID, including sender/recipients, subject, timestamps, and (optionally) the full body. Use this when you already have one specific mail message ID — e.g. from a thread's message list or from a deal/person/organization's mail messages — and need its full content. Do not call this in a loop to fetch many messages one by one; for browsing a mailbox or a contact's email history, use getMailThreads, getMailThreadMessages, or the entity-scoped mail message tools instead, which return multiple messages in a single call.

getMailMessage

Fetch a single mail thread by its ID, including its metadata (folder, read/archived/shared flags, and any linked deal or lead). Use this when you already have one specific thread ID — e.g. from getMailThreads — and need its details before deciding to update it (updateMailThreadDetails) or read its messages (getMailThreadMessages). Do not call this in a loop over many thread IDs just to browse a mailbox; use getMailThreads for that instead.

getMailThread

Returns details of one note by ID. Use once you have a specific note ID (e.g. from getNotes); don't call this in a loop over many IDs — use getNotes with filters instead.

getNote

Fetches full details of one product by ID. Use once you have a specific product ID (e.g. from getProducts or searchProducts); don't call this in a loop over many IDs — use getProducts or searchProducts instead.

getProduct

Fetches details of one pipeline stage by ID — name, pipeline, order, deal_probability (used for weighted pipeline values), and rotten-deal settings (is_deal_rot_enabled/days_to_rotten). Use once you have a specific stage ID (e.g. from getStages); don't call this in a loop over many IDs — use getStages instead.

getStage

Lists files attached to a product, with pagination and sorting. Find the product ID first with getProducts or searchProducts.

getProductFiles

List mail messages associated with a specific deal, with pagination and an option to include full message bodies. Use this to review the email communication history tied to a deal — e.g. before following up or summarizing deal activity — without having to search the mailbox manually. Find the deal ID first with getDeal or searchDeals.

getDealMailMessages

List mail messages associated with a specific person, with pagination and an option to include full message bodies. Use this to review the email communication history with an individual contact — e.g. before reaching out, to summarize past correspondence. Find the person ID first with getPerson or searchPersons.

getPersonMailMessages

List mail messages associated with a specific organization, with pagination and an option to include full message bodies. Use this to review email communication history tied to an organization — useful for understanding overall relationship context across all contacts and deals at that company. Find the organization ID first with getOrganization or searchOrganization.

getOrganizationMailMessages

Lists products associated with a person (via their deals), with pagination. Use to see what a specific contact has purchased or been quoted across their deals. Find the person ID first with getPersons or searchPersons.

getPersonProducts

Lists the products attached to one deal — quantities, prices, discounts, and order. Use for deal value breakdowns or before modifying a deal's product line (addDealProduct/updateDealProduct need the product_attachment_id returned here). Find the deal ID first via getDeals or searchDeals.

getDealProducts

Full-text search across deal titles, notes, and custom fields, with exact-match and field-specific options. The primary way to find a deal (and its ID) by name/content rather than browsing getDeals; can be filtered by person_id or organization_id (from getPerson/searchPersons or getOrganization/searchOrganization) or by status (open/won/lost). IMPORTANT: Provide search terms as plain text, without URL encoding. The tool handles encoding internally.

searchDeals

Full-text search for leads by title, notes, or custom fields, with exact-match options. Found leads can be filtered by person_id or organization_id (from getPerson/searchPersons or getOrganization/searchOrganization). The primary way to find a specific lead and its ID — needed e.g. before calling convertLeadToDeal.

searchLeads

Full-text search for organizations by name, address, notes, or custom fields, with exact-match and field-specific options. The primary way to find a specific organization (and its ID) by name/content rather than browsing getOrganizations — use the result to link deals, persons, or leads to it, or as input to getOrganizationMailMessages.

searchOrganization

Full-text search for persons by name, email, phone, notes, or custom fields, with exact-match and field-specific options. The primary way to find a specific person (and their ID) by identifying details rather than browsing getPersons; can be filtered by organization_id (from getOrganization/searchOrganization). IMPORTANT: Provide search terms as plain text, without URL encoding. The tool handles encoding internally.

searchPersons

Full-text search for products by name, code, or custom fields, with exact-match and field-specific options. The primary way to find a specific product (and its ID) rather than browsing getProducts — use the result as input to addDealProduct, getProductVariations, getProductDeals, or getProductFiles.

searchProducts

Full-text search for projects by title, description, notes, or custom fields, with exact-match options; results can be filtered by person_id or organization_id (from getPerson/searchPersons or getOrganization/searchOrganization). The primary way to find a specific project and its ID rather than browsing getProjects.

searchProjects

Modifies a deal's properties via partial update (PATCH) — only supplied fields change. Set status to won or lost to close a deal, or update value/stage_id/pipeline_id to progress it through the pipeline. Find the deal ID first with getDeals or searchDeals; look up new person_id/org_id with getPerson/searchPersons or getOrganization/searchOrganization.

updateDeal

Updates a lead's properties via partial update — only supplied fields change; send null to clear value, person_id, or organization_id (a lead must stay linked to a person and/or organization, so don't null both). Find the lead ID first with getLeads or searchLeads; look up a new person_id/organization_id with getPerson/searchPersons or getOrganization/searchOrganization.

updateLead