Pipedrive: Get Deal Fields

Get all deal fields.

Tool ID: pipedrive_get_deal_fields

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_fields',
  {
    "include_fields": "ui_visibility",
    "limit": 123,
    "cursor": "cursor_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute pipedrive_get_deal_fields --input '{
  "include_fields": "ui_visibility",
  "limit": 123,
  "cursor": "cursor_123"
}' --json

Example response

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

{
  "data": {
    "success": true,
    "data": [
      {
        "field_name": "Example",
        "field_code": "example",
        "field_type": "int",
        "is_custom_field": true,
        "is_optional_response_field": true
      }
    ],
    "additional_data": {
      "next_cursor": "cursor_123"
    }
  }
}

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

Input reference

Returns metadata about all deal fields in the company.

Name	Type	Required	Default	Details
`payload.include_fields`	`"ui_visibility" \| "important_fields" \| "required_fields" \| "ui_visibility,important_fields" \| "ui_visibility,required_fields" \| "important_fields,required_fields" \| "ui_visibility,important_fields,required_fields"`	No	—	Optional comma separated string array of additional data namespaces to include in response Allowed: `ui_visibility`, `important_fields`, `required_fields`, `ui_visibility,important_fields`, `ui_visibility,required_fields`, `important_fields,required_fields`, `ui_visibility,important_fields,required_fields`.
`payload.limit`	`integer`	No	—	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.
`payload.cursor`	`string`	No	—	For pagination, the marker (an opaque string value) representing the first item on the next page

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.success`	`boolean`	No	—	Whether the request was successful
`result.data.data`	`array`	No	—	—
`result.data.data[].field_name`	`string`	Yes	—	The display name/label of the field
`result.data.data[].field_code`	`string`	Yes	—	The unique identifier for the field (40-character hash for custom fields)
`result.data.data[].description`	`string`	No	—	The description of the field
`result.data.data[].field_type`	`"int" \| "double" \| "boolean" \| "varchar" \| "text" \| "phone" \| "varchar_options" \| "varchar_auto" \| "date" \| "daterange" \| "time" \| "timerange" \| "enum" \| "set" \| "address" \| "monetary" \| "deal" \| "deals" \| "lead" \| "org" \| "people" \| "project" \| "stage" \| "user" \| "activity" \| "json" \| "picture" \| "status" \| "visible_to" \| "price_list" \| "billing_frequency" \| "projects_board" \| "projects_phase"`	Yes	—	The type of the field Allowed: `int`, `double`, `boolean`, `varchar`, `text`, `phone`, `varchar_options`, `varchar_auto`, `date`, `daterange`, `time`, `timerange`, `enum`, `set`, `address`, `monetary`, `deal`, `deals`, `lead`, `org`, `people`, `project`, `stage`, `user`, `activity`, `json`, `picture`, `status`, `visible_to`, `price_list`, `billing_frequency`, `projects_board`, `projects_phase`.
`result.data.data[].options`	`array \| null`	No	—	Array of available options for enum/set fields, null for other field types
`result.data.data[].options[].id`	`record`	No	—	The option ID (integer for custom fields, string for built-in fields)
`result.data.data[].options[].label`	`string`	No	—	The option display label
`result.data.data[].options[].color`	`string \| null`	No	—	Optional color code for the option
`result.data.data[].options[].update_time`	`string \| null`	No	—	When the option was last updated Format: `date-time`.
`result.data.data[].options[].add_time`	`string \| null`	No	—	When the option was created Format: `date-time`.
`result.data.data[].subfields`	`array \| null`	No	—	Array of subfields for complex field types (address, monetary), null for simple field types
`result.data.data[].subfields[].field_code`	`string`	No	—	The subfield identifier
`result.data.data[].subfields[].field_name`	`string`	No	—	The subfield display name
`result.data.data[].subfields[].field_type`	`string`	No	—	The subfield type
`result.data.data[].is_custom_field`	`boolean`	Yes	—	Whether this is a user-created custom field
`result.data.data[].is_optional_response_field`	`boolean`	Yes	—	Whether this field is not returned by default in entity responses
`result.data.data[].ui_visibility`	`object`	No	—	UI visibility settings (only included when requested via include_fields parameter)
`result.data.data[].ui_visibility.add_visible_flag`	`boolean`	No	—	Whether the field is shown in the add modal
`result.data.data[].ui_visibility.details_visible_flag`	`boolean`	No	—	Whether the field is shown in the details view
`result.data.data[].ui_visibility.projects_detail_visible_flag`	`boolean`	No	—	Whether the field is shown in project details view
`result.data.data[].ui_visibility.show_in_pipelines`	`object`	No	—	Pipeline visibility configuration
`result.data.data[].ui_visibility.show_in_pipelines.show_in_all`	`boolean`	No	—	Whether the field is shown in all pipelines
`result.data.data[].ui_visibility.show_in_pipelines.pipeline_ids`	`array`	No	—	Specific pipeline IDs where the field is shown (if show_in_all is false)
`result.data.data[].important_fields`	`object`	No	—	Important fields configuration
`result.data.data[].important_fields.enabled`	`boolean`	No	—	Whether the field is marked as important
`result.data.data[].important_fields.stage_ids`	`array`	No	—	Array of stage IDs where the field is important
`result.data.data[].required_fields`	`object`	No	—	Required fields configuration
`result.data.data[].required_fields.enabled`	`boolean`	No	—	Whether the field is required
`result.data.data[].required_fields.stage_ids`	`array`	No	—	Array of stage IDs where the field is required
`result.data.data[].required_fields.statuses`	`record`	No	—	Pipeline-specific status requirements, mapping pipeline ID to array of statuses
`result.data.additional_data`	`object`	No	—	—
`result.data.additional_data.next_cursor`	`string \| null`	No	—	Base64url-encoded cursor for fetching the next page of results, null if no more pages
`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 Fields

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