Pipedrive: Get Deal

Get details of a deal.

Tool ID: pipedrive_get_deal

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pipedrive_get_deal',
  {
    "id": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute pipedrive_get_deal --input '{
  "id": 123
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "success": true,
    "data": {
      "id": 123,
      "title": "VP of Engineering",
      "owner_id": 123
    }
  }
}

Use deepline tools get pipedrive_get_deal --json for the latest machine-readable contract.

Input reference

Returns the details of a specific deal.

Name	Type	Required	Default	Details
`payload.id`	`integer`	Yes	—	The ID of the deal
`payload.include_fields`	`"next_activity_id" \| "last_activity_id" \| "first_won_time" \| "products_count" \| "files_count" \| "notes_count" \| "followers_count" \| "email_messages_count" \| "activities_count" \| "done_activities_count" \| "undone_activities_count" \| "participants_count" \| "last_incoming_mail_time" \| "last_outgoing_mail_time" \| "smart_bcc_email" \| "source_lead_id"`	No	—	Optional comma separated string array of additional fields to include Allowed: `next_activity_id`, `last_activity_id`, `first_won_time`, `products_count`, `files_count`, `notes_count`, `followers_count`, `email_messages_count`, `activities_count`, `done_activities_count`, `undone_activities_count`, `participants_count`, `last_incoming_mail_time`, `last_outgoing_mail_time`, `smart_bcc_email`, `source_lead_id`.
`payload.custom_fields`	`string`	No	—	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.
`payload.include_option_labels`	`boolean`	No	—	When provided with a ‘true’ value, single option and multiple option custom fields values contain objects in the form of ’{ id: number, label: string }’ instead of plain id
`payload.include_labels`	`boolean`	No	—	When provided with ‘true’ value, response will include an array of label objects in the form of ’{ id: number, label: string }‘

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.success`	`boolean`	No	—	If the response is successful or not
`result.data.data`	`object`	No	—	—
`result.data.data.id`	`integer`	No	—	The ID of the deal
`result.data.data.title`	`string`	No	—	The title of the deal
`result.data.data.owner_id`	`integer`	No	—	The ID of the user who owns the deal
`result.data.data.person_id`	`integer`	No	—	The ID of the person linked to the deal
`result.data.data.org_id`	`integer`	No	—	The ID of the organization linked to the deal
`result.data.data.pipeline_id`	`integer`	No	—	The ID of the pipeline associated with the deal
`result.data.data.stage_id`	`integer`	No	—	The ID of the deal stage
`result.data.data.value`	`number`	No	—	The value of the deal
`result.data.data.currency`	`string`	No	—	The currency associated with the deal
`result.data.data.add_time`	`string`	No	—	The creation date and time of the deal
`result.data.data.update_time`	`string`	No	—	The last updated date and time of the deal
`result.data.data.stage_change_time`	`string`	No	—	The last updated date and time of the deal stage
`result.data.data.is_deleted`	`boolean`	No	—	Whether the deal is deleted or not
`result.data.data.is_archived`	`boolean`	No	—	Whether the deal is archived or not
`result.data.data.status`	`string`	No	—	The status of the deal
`result.data.data.probability`	`number \| null`	No	—	The success probability percentage of the deal
`result.data.data.lost_reason`	`string \| null`	No	—	The reason for losing the deal
`result.data.data.visible_to`	`integer`	No	—	The visibility of the deal
`result.data.data.close_time`	`string \| null`	No	—	The date and time of closing the deal
`result.data.data.won_time`	`string`	No	—	The date and time of changing the deal status as won
`result.data.data.lost_time`	`string`	No	—	The date and time of changing the deal status as lost
`result.data.data.expected_close_date`	`string`	No	—	The expected close date of the deal Format: `date`.
`result.data.data.label_ids`	`array`	No	—	The IDs of labels assigned to the deal
`result.data.data.origin`	`string`	No	—	The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed.
`result.data.data.origin_id`	`string \| null`	No	—	The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal.
`result.data.data.channel`	`integer \| null`	No	—	The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your Company settings .
`result.data.data.channel_id`	`string \| null`	No	—	The optional ID to further distinguish the Marketing channel.
`result.data.data.source_lead_id`	`string \| null`	No	—	The ID of the lead if the deal was converted from a lead. Only included when requested via include_fields parameter. Format: `uuid`.
`result.data.data.arr`	`number \| null`	No	—	Only available in Growth and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal
`result.data.data.mrr`	`number \| null`	No	—	Only available in Growth and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal
`result.data.data.acv`	`number \| null`	No	—	Only available in Growth and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal
`result.data.data.custom_fields`	`record`	No	—	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.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

Pipedrive: Get Deal

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation