Pipedrive | Composio Docs

Overview

SLUG

PIPEDRIVE

Description

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

Authentication Details

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

stringDefaults to contacts:full leads:full mail:full activities:full products:full projects:full

bearer_token

string

subdomain

stringRequired

Bearer Token

token

stringRequired

subdomain

stringRequired

Tools

Add an activity

SLUG: PIPEDRIVE_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).

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a deal

SLUG: PIPEDRIVE_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.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a lead

SLUG: PIPEDRIVE_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.

Action Parameters

expected_close_date

string

label_ids

array

organization_id

integer

owner_id

integer

person_id

integer

title

stringRequired

value__amount

integer

value__currency

string

was_seen

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a note

SLUG: PIPEDRIVE_ADD_A_NOTE

Adds a new note.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a person

SLUG: PIPEDRIVE_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.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a product

SLUG: PIPEDRIVE_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" target=" blank" rel="noopener noreferrer">adding a product</a>.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get all leads

SLUG: PIPEDRIVE_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.

Action Parameters

archived_status

string

filter_id

integer

limit

integer

organization_id

integer

owner_id

integer

person_id

integer

sort

string

start

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get all products

SLUG: PIPEDRIVE_GET_ALL_PRODUCTS

Returns data about all products.

Action Parameters

filter_id

integer

first_char

string

get_summary

boolean

ids

array

limit

integer

start

integer

user_id

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get one lead

SLUG: PIPEDRIVE_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.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update a deal

SLUG: PIPEDRIVE_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" target=" blank" rel="noopener noreferrer">updating a deal</a>.

Action Parameters

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update a person

SLUG: PIPEDRIVE_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`.

Action Parameters

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add an installment subscription

SLUG: PIPEDRIVE_ADD_AN_INSTALLMENT_SUBSCRIPTION

Adds a new installment subscription.

Action Parameters

currency

stringRequired

deal_id

integerRequired

payments

arrayRequired

update_deal_value

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add an organization

SLUG: PIPEDRIVE_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.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a call log

SLUG: PIPEDRIVE_ADD_A_CALL_LOG

Adds a new call log.

Action Parameters

activity_id

integer

deal_id

integer

duration

string

end_time

stringRequired

from_phone_number

string

lead_id

string

note

string

org_id

integer

outcome

stringRequired

person_id

integer

start_time

stringRequired

subject

string

to_phone_number

stringRequired

user_id

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a channel

SLUG: PIPEDRIVE_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.

Action Parameters

avatar_url

string

name

stringRequired

provider_channel_id

stringRequired

provider_type

stringDefaults to other

template_support

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a comment to a note

SLUG: PIPEDRIVE_ADD_A_COMMENT_TO_A_NOTE

Adds a new comment to a note.

Action Parameters

content

stringRequired

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a follower to an organization

SLUG: PIPEDRIVE_ADD_A_FOLLOWER_TO_AN_ORGANIZATION

Adds a follower to an organization.

Action Parameters

integerRequired

user_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a follower to a deal

SLUG: PIPEDRIVE_ADD_A_FOLLOWER_TO_A_DEAL

Adds a follower to a deal.

Action Parameters

integerRequired

user_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a follower to a person

SLUG: PIPEDRIVE_ADD_A_FOLLOWER_TO_A_PERSON

Adds a follower to a person.

Action Parameters

integerRequired

user_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add a follower to a product

SLUG: PIPEDRIVE_ADD_A_FOLLOWER_TO_A_PRODUCT

Adds a follower to a product.

Action Parameters

integerRequired

user_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired