pipedrive
Module pipedrive
API
Definitions
ballerinax/pipedrive Ballerina library
Overview
Pipedrive is a sales CRM and pipeline management platform that helps sales teams track leads, deals, contacts, activities and products through customizable sales pipelines.
The Pipedrive connector offers APIs to connect and interact with the Pipedrive API v2 endpoints.
Key features
- Manage deals, persons and organizations, including their followers and custom fields
- Track activities and tasks, and keep them linked to deals, contacts and projects
- Configure pipelines and stages, and monitor deal progress through them
- Manage products, product variations, images and discounts attached to deals
- Search across deals, persons, organizations, leads, products and projects
Setup guide
To use the Pipedrive connector, you need a Pipedrive account and an API token.
-
If you do not have a Pipedrive account, sign up at pipedrive.com.
-
Log in to your Pipedrive account and open your personal preferences from the account menu in the top right corner.
-
Open the API tab and copy your personal API token.
Note: Applications that act on behalf of other Pipedrive users can authenticate with OAuth 2.0 instead. Register an app in the Pipedrive Developer Hub and use the refresh token grant configuration of the connector.
Quickstart
To use the pipedrive connector in your Ballerina application, update the .bal file as follows:
-
Import the
pipedrivemodule.import ballerinax/pipedrive; -
Create a
Config.tomlfile with your API token.apiToken = "<Your Pipedrive API token>" -
Create a client with the API token and invoke an operation.
configurable string apiToken = ?; public function main() returns error? { pipedrive:Client pipedrive = check new ({auth: {xApiToken: apiToken}}); pipedrive:GetPipelinesResponse _ = check pipedrive->getPipelines(); } -
Use
bal runto compile and run the Ballerina program.
Examples
The Pipedrive connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Lead to deal onboarding - Create an organization and contact person, open a deal for them and schedule the first follow-up activity.
- Pipeline deal summary - Summarise the open deals of every sales pipeline by stage, paging through all deals.
Clients
pipedrive: Client
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.pipedrive.com/api/v2" - URL of the target service
getActivities
function getActivities(map<string|string[]> headers, *GetActivitiesQueries queries) returns GetActivitiesResponse|errorGet all activities
Parameters
- queries *GetActivitiesQueries - Queries to be sent with the request
Return Type
- GetActivitiesResponse|error - Get all activities
addActivity
function addActivity(AddActivityRequest payload, map<string|string[]> headers) returns UpsertActivityResponse|errorAdd a new activity
Parameters
- payload AddActivityRequest - Request payload to add a new activity
Return Type
- UpsertActivityResponse|error - Add activity
getActivity
function getActivity(int id, map<string|string[]> headers, *GetActivityQueries queries) returns UpsertActivityResponse|errorGet details of an activity
Parameters
- id int - The ID of the activity
- queries *GetActivityQueries - Queries to be sent with the request
Return Type
- UpsertActivityResponse|error - Get activity
deleteActivity
Delete an activity
Parameters
- id int - The ID of the activity
Return Type
- DeleteActivityResponse|error - Delete activity
updateActivity
function updateActivity(int id, AddActivityRequest payload, map<string|string[]> headers) returns UpsertActivityResponse|errorUpdate an activity
Parameters
- id int - The ID of the activity
- payload AddActivityRequest - Request payload to update an activity
Return Type
- UpsertActivityResponse|error - Edit activity
getActivityFields
function getActivityFields(map<string|string[]> headers, *GetActivityFieldsQueries queries) returns GetActivityFieldsResponse|errorGet all activity fields
Parameters
- queries *GetActivityFieldsQueries - Queries to be sent with the request
Return Type
- GetActivityFieldsResponse|error - Get all activity fields
getActivityField
function getActivityField(string fieldCode, map<string|string[]> headers, *GetActivityFieldQueries queries) returns GetActivityFieldResponse|errorGet one activity field
Parameters
- fieldCode string - The unique code identifying the field
- queries *GetActivityFieldQueries - Queries to be sent with the request
Return Type
- GetActivityFieldResponse|error - Get one activity field
getDeals
function getDeals(map<string|string[]> headers, *GetDealsQueries queries) returns GetDealsResponse|errorGet all deals
Parameters
- queries *GetDealsQueries - Queries to be sent with the request
Return Type
- GetDealsResponse|error - Get all not archived deals
addDeal
function addDeal(AddDealRequest payload, map<string|string[]> headers) returns UpsertDealResponse|errorAdd a new deal
Parameters
- payload AddDealRequest - Request payload to add a new deal
Return Type
- UpsertDealResponse|error - Add deal
getArchivedDeals
function getArchivedDeals(map<string|string[]> headers, *GetArchivedDealsQueries queries) returns GetDealsResponse|errorGet all archived deals
Parameters
- queries *GetArchivedDealsQueries - Queries to be sent with the request
Return Type
- GetDealsResponse|error - Get all archived deals
getDeal
function getDeal(int id, map<string|string[]> headers, *GetDealQueries queries) returns UpsertDealResponse|errorGet details of a deal
Return Type
- UpsertDealResponse|error - Get deal
deleteDeal
Delete a deal
Parameters
- id int - The ID of the deal
Return Type
- DeleteDealResponse|error - Delete deal
updateDeal
function updateDeal(int id, UpdateDealRequest payload, map<string|string[]> headers) returns UpsertDealResponse|errorUpdate a deal
Return Type
- UpsertDealResponse|error - Edit deal
getDealFollowers
function getDealFollowers(int id, map<string|string[]> headers, *GetDealFollowersQueries queries) returns GetFollowersResponse|errorList followers of a deal
Parameters
- id int - The ID of the deal
- queries *GetDealFollowersQueries - Queries to be sent with the request
Return Type
- GetFollowersResponse|error - List entity followers
addDealFollower
function addDealFollower(int id, AddFollowerRequest payload, map<string|string[]> headers) returns AddFollowerResponse|errorAdd a follower to a deal
Parameters
- id int - The ID of the deal
- payload AddFollowerRequest - Request payload to add a follower to a deal
Return Type
- AddFollowerResponse|error - Add a follower
getDealFollowersChangelog
function getDealFollowersChangelog(int id, map<string|string[]> headers, *GetDealFollowersChangelogQueries queries) returns GetFollowerChangelogsResponse|errorList followers changelog of a deal
Parameters
- id int - The ID of the deal
- queries *GetDealFollowersChangelogQueries - Queries to be sent with the request
Return Type
- GetFollowerChangelogsResponse|error - List entity followers
deleteDealFollower
function deleteDealFollower(int id, int followerId, map<string|string[]> headers) returns DeleteFollowerResponse|errorDelete a follower from a deal
Return Type
- DeleteFollowerResponse|error - Remove a follower
getDealsProducts
function getDealsProducts(map<string|string[]> headers, *GetDealsProductsQueries queries) returns GetDealsProductsResponse|errorGet deal products of several deals
Parameters
- queries *GetDealsProductsQueries - Queries to be sent with the request
Return Type
- GetDealsProductsResponse|error - List of products attached to deals
searchDeals
function searchDeals(map<string|string[]> headers, *SearchDealsQueries queries) returns GetDealSearchResponse|errorSearch deals
Parameters
- queries *SearchDealsQueries - Queries to be sent with the request
Return Type
- GetDealSearchResponse|error - Search results for deals
getDealProducts
function getDealProducts(int id, map<string|string[]> headers, *GetDealProductsQueries queries) returns GetDealsProductsResponse|errorList products attached to a deal
Parameters
- id int - The ID of the deal
- queries *GetDealProductsQueries - Queries to be sent with the request
Return Type
- GetDealsProductsResponse|error - List of products attached to deals
addDealProduct
function addDealProduct(int id, AddDealProductRequest payload, map<string|string[]> headers) returns AddDealProductResponse|errorAdd a product to a deal
Parameters
- id int - The ID of the deal
- payload AddDealProductRequest - Request payload to add a product to a deal
Return Type
- AddDealProductResponse|error - Add a product to the deal
deleteManyDealProducts
function deleteManyDealProducts(int id, map<string|string[]> headers, *DeleteManyDealProductsQueries queries) returns DeleteManyDealProductResponse|errorDelete many products from a deal
Parameters
- id int - The ID of the deal
- queries *DeleteManyDealProductsQueries - Queries to be sent with the request
Return Type
- DeleteManyDealProductResponse|error - Delete many products from a deal
deleteDealProduct
function deleteDealProduct(int id, int productAttachmentId, map<string|string[]> headers) returns DeleteDealProductResponse|errorDelete an attached product from a deal
Return Type
- DeleteDealProductResponse|error - Delete an attached product from a deal
updateDealProduct
function updateDealProduct(int id, int productAttachmentId, UpdateDealProductRequest payload, map<string|string[]> headers) returns AddDealProductResponse|errorUpdate the product attached to a deal
Parameters
- id int - The ID of the deal
- productAttachmentId int - The ID of the deal-product (the ID of the product attached to the deal)
- payload UpdateDealProductRequest - Request payload to update the product attached to a deal
Return Type
- AddDealProductResponse|error - Add a product to the deal
addManyDealProducts
function addManyDealProducts(int id, CreateManyDealProductRequest payload, map<string|string[]> headers) returns AddManyDealProductResponse|errorAdd multiple products to a deal
Parameters
- id int - The ID of the deal
- payload CreateManyDealProductRequest - Request payload to add multiple products to a deal
Return Type
- AddManyDealProductResponse|error - Add many products to a deal
getAdditionalDiscounts
function getAdditionalDiscounts(int id, map<string|string[]> headers) returns GetAdditionalDiscountsResponse|errorList discounts added to a deal
Parameters
- id int - The ID of the deal
Return Type
- GetAdditionalDiscountsResponse|error - List of discounts added to deal
addAdditionalDiscount
function addAdditionalDiscount(int id, AddAdditionalDiscountRequest payload, map<string|string[]> headers) returns AddAdditionalDiscountResponse|errorAdd a discount to a deal
Parameters
- id int - The ID of the deal
- payload AddAdditionalDiscountRequest - Request payload to add a discount to a deal
Return Type
- AddAdditionalDiscountResponse|error - Discount added to deal
deleteAdditionalDiscount
function deleteAdditionalDiscount(int id, string discountId, map<string|string[]> headers) returns DeleteAdditionalDiscountResponse|errorDelete a discount from a deal
Return Type
- DeleteAdditionalDiscountResponse|error - The ID of the deleted discount
updateAdditionalDiscount
function updateAdditionalDiscount(int id, string discountId, UpdateAdditionalDiscountRequest payload, map<string|string[]> headers) returns UpdateAdditionalDiscountResponse|errorUpdate a discount added to a deal
Parameters
- id int - The ID of the deal
- discountId string - The ID of the discount
- payload UpdateAdditionalDiscountRequest - Request payload to update a discount added to a deal
Return Type
- UpdateAdditionalDiscountResponse|error - Edited discount
getInstallments
function getInstallments(map<string|string[]> headers, *GetInstallmentsQueries queries) returns GetInstallmentsResponse|errorList installments added to a list of deals
Parameters
- queries *GetInstallmentsQueries - Queries to be sent with the request
Return Type
- GetInstallmentsResponse|error - List installments added to a deal
addInstallment
function addInstallment(int id, AddInstallmentRequest payload, map<string|string[]> headers) returns AddAInstallmentResponse|errorAdd an installment to a deal
Parameters
- id int - The ID of the deal
- payload AddInstallmentRequest - Request payload to add an installment to a deal
Return Type
- AddAInstallmentResponse|error - Installment added to deal
deleteInstallment
function deleteInstallment(int id, int installmentId, map<string|string[]> headers) returns DeleteInstallmentResponse|errorDelete an installment from a deal
Return Type
- DeleteInstallmentResponse|error - The ID of the deleted installment
updateInstallment
function updateInstallment(int id, int installmentId, UpdateInstallmentRequest payload, map<string|string[]> headers) returns UpdateInstallmentResponse|errorUpdate an installment added to a deal
Parameters
- id int - The ID of the deal
- installmentId int - The ID of the installment
- payload UpdateInstallmentRequest - Request payload to update an installment added to a deal
Return Type
- UpdateInstallmentResponse|error - Edited installment
convertDealToLead
function convertDealToLead(int id, map<string|string[]> headers) returns AddConvertDealToLeadResponse|errorConvert a deal to a lead
Parameters
- id int - The ID of the deal to convert
Return Type
- AddConvertDealToLeadResponse|error - Successful response containing payload in the
datafield
getDealFields
function getDealFields(map<string|string[]> headers, *GetDealFieldsQueries queries) returns GetDealFieldsResponse|errorGet all deal fields
Parameters
- queries *GetDealFieldsQueries - Queries to be sent with the request
Return Type
- GetDealFieldsResponse|error - Get all deal fields
addDealField
function addDealField(AddDealFieldRequest payload, map<string|string[]> headers) returns DealFieldResponse|errorCreate one deal field
Parameters
- payload AddDealFieldRequest - Request payload to create one deal field
Return Type
- DealFieldResponse|error - Create one deal field
getDealField
function getDealField(string fieldCode, map<string|string[]> headers, *GetDealFieldQueries queries) returns DealFieldResponse|errorGet one deal field
Parameters
- fieldCode string - The unique code identifying the field
- queries *GetDealFieldQueries - Queries to be sent with the request
Return Type
- DealFieldResponse|error - Get one deal field
deleteDealField
function deleteDealField(string fieldCode, map<string|string[]> headers) returns DeleteDealFieldResponse|errorDelete one deal field
Parameters
- fieldCode string - The unique code identifying the field
Return Type
- DeleteDealFieldResponse|error - Delete one deal field
updateDealField
function updateDealField(string fieldCode, UpdateDealFieldRequest payload, map<string|string[]> headers) returns DealFieldResponse|errorUpdate one deal field
Parameters
- fieldCode string - The unique code identifying the field
- payload UpdateDealFieldRequest - Request payload to update one deal field
Return Type
- DealFieldResponse|error - Get one deal field
addDealFieldOptions
function addDealFieldOptions(string fieldCode, AddFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorAdd deal field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload AddFieldOptionsRequest[] - Request payload to add deal field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
deleteDealFieldOptions
function deleteDealFieldOptions(string fieldCode, DeleteFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorDelete deal field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload DeleteFieldOptionsRequest[] - Request payload to delete deal field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
updateDealFieldOptions
function updateDealFieldOptions(string fieldCode, UpdateFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorUpdate deal field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload UpdateFieldOptionsRequest[] - Request payload to update deal field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
getDealConversionStatus
function getDealConversionStatus(int id, string conversionId, map<string|string[]> headers) returns ConversionStatusResponse|errorGet Deal conversion status
Return Type
- ConversionStatusResponse|error - Successful response containing payload in the
datafield
getPersons
function getPersons(map<string|string[]> headers, *GetPersonsQueries queries) returns GetPersonsResponse|errorGet all persons
Parameters
- queries *GetPersonsQueries - Queries to be sent with the request
Return Type
- GetPersonsResponse|error - Get all persons
addPerson
function addPerson(AddPersonRequest payload, map<string|string[]> headers) returns UpsertPersonResponse|errorAdd a new person
Parameters
- payload AddPersonRequest - Request payload to add a new person
Return Type
- UpsertPersonResponse|error - Add person
getPerson
function getPerson(int id, map<string|string[]> headers, *GetPersonQueries queries) returns UpsertPersonResponse|errorGet details of a person
Parameters
- id int - The ID of the person
- queries *GetPersonQueries - Queries to be sent with the request
Return Type
- UpsertPersonResponse|error - Get person
deletePerson
Delete a person
Parameters
- id int - The ID of the person
Return Type
- DeletePersonResponse|error - Delete person
updatePerson
function updatePerson(int id, UpdatePersonRequest payload, map<string|string[]> headers) returns UpsertPersonResponse|errorUpdate a person
Parameters
- id int - The ID of the person
- payload UpdatePersonRequest - Request payload to update a person
Return Type
- UpsertPersonResponse|error - Edit person
getPersonFollowers
function getPersonFollowers(int id, map<string|string[]> headers, *GetPersonFollowersQueries queries) returns GetFollowersResponse|errorList followers of a person
Parameters
- id int - The ID of the person
- queries *GetPersonFollowersQueries - Queries to be sent with the request
Return Type
- GetFollowersResponse|error - List entity followers
addPersonFollower
function addPersonFollower(int id, AddFollowerRequest payload, map<string|string[]> headers) returns AddFollowerResponse|errorAdd a follower to a person
Parameters
- id int - The ID of the person
- payload AddFollowerRequest - Request payload to add a follower to a person
Return Type
- AddFollowerResponse|error - Add a follower
getPersonFollowersChangelog
function getPersonFollowersChangelog(int id, map<string|string[]> headers, *GetPersonFollowersChangelogQueries queries) returns GetFollowerChangelogsResponse|errorList followers changelog of a person
Parameters
- id int - The ID of the person
- queries *GetPersonFollowersChangelogQueries - Queries to be sent with the request
Return Type
- GetFollowerChangelogsResponse|error - List entity followers
deletePersonFollower
function deletePersonFollower(int id, int followerId, map<string|string[]> headers) returns DeleteFollowerResponse|errorDelete a follower from a person
Return Type
- DeleteFollowerResponse|error - Remove a follower
getPersonPicture
function getPersonPicture(int id, map<string|string[]> headers) returns GetPersonPictureResponse|errorGet picture of a person
Parameters
- id int - The ID of the person
Return Type
- GetPersonPictureResponse|error - Get person picture
getPersonFields
function getPersonFields(map<string|string[]> headers, *GetPersonFieldsQueries queries) returns GetPersonFieldsResponse|errorGet all person fields
Parameters
- queries *GetPersonFieldsQueries - Queries to be sent with the request
Return Type
- GetPersonFieldsResponse|error - Get all person fields
addPersonField
function addPersonField(AddPersonFieldRequest payload, map<string|string[]> headers) returns PersonFieldResponse|errorCreate one person field
Parameters
- payload AddPersonFieldRequest - Request payload to create one person field
Return Type
- PersonFieldResponse|error - Create one person field
getPersonField
function getPersonField(string fieldCode, map<string|string[]> headers, *GetPersonFieldQueries queries) returns PersonFieldResponse|errorGet one person field
Parameters
- fieldCode string - The unique code identifying the field
- queries *GetPersonFieldQueries - Queries to be sent with the request
Return Type
- PersonFieldResponse|error - Get one person field
deletePersonField
function deletePersonField(string fieldCode, map<string|string[]> headers) returns DeleteFieldResponse|errorDelete one person field
Parameters
- fieldCode string - The unique code identifying the field
Return Type
- DeleteFieldResponse|error - Delete one person field
updatePersonField
function updatePersonField(string fieldCode, UpdatePersonFieldRequest payload, map<string|string[]> headers) returns PersonFieldResponse|errorUpdate one person field
Parameters
- fieldCode string - The unique code identifying the field
- payload UpdatePersonFieldRequest - Request payload to update one person field
Return Type
- PersonFieldResponse|error - Get one person field
addPersonFieldOptions
function addPersonFieldOptions(string fieldCode, AddFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorAdd person field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload AddFieldOptionsRequest[] - Request payload to add person field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
deletePersonFieldOptions
function deletePersonFieldOptions(string fieldCode, DeleteFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorDelete person field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload DeleteFieldOptionsRequest[] - Request payload to delete person field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
updatePersonFieldOptions
function updatePersonFieldOptions(string fieldCode, UpdateFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorUpdate person field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload UpdateFieldOptionsRequest[] - Request payload to update person field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
getOrganizations
function getOrganizations(map<string|string[]> headers, *GetOrganizationsQueries queries) returns GetOrganizationsResponse|errorGet all organizations
Parameters
- queries *GetOrganizationsQueries - Queries to be sent with the request
Return Type
- GetOrganizationsResponse|error - Get all organizations
addOrganization
function addOrganization(AddOrganizationRequest payload, map<string|string[]> headers) returns UpsertOrganizationResponse|errorAdd a new organization
Parameters
- payload AddOrganizationRequest - Request payload to add a new organization
Return Type
- UpsertOrganizationResponse|error - Add organization
getOrganization
function getOrganization(int id, map<string|string[]> headers, *GetOrganizationQueries queries) returns UpsertOrganizationResponse|errorGet details of a organization
Parameters
- id int - The ID of the organization
- queries *GetOrganizationQueries - Queries to be sent with the request
Return Type
- UpsertOrganizationResponse|error - Get organization
deleteOrganization
function deleteOrganization(int id, map<string|string[]> headers) returns DeleteOrganizationResponse|errorDelete a organization
Parameters
- id int - The ID of the organization
Return Type
- DeleteOrganizationResponse|error - Delete organization
updateOrganization
function updateOrganization(int id, UpdateOrganizationRequest payload, map<string|string[]> headers) returns UpsertOrganizationResponse|errorUpdate a organization
Parameters
- id int - The ID of the organization
- payload UpdateOrganizationRequest - Request payload to update a organization
Return Type
- UpsertOrganizationResponse|error - Edit organization
getOrganizationFollowers
function getOrganizationFollowers(int id, map<string|string[]> headers, *GetOrganizationFollowersQueries queries) returns GetFollowersResponse|errorList followers of an organization
Parameters
- id int - The ID of the organization
- queries *GetOrganizationFollowersQueries - Queries to be sent with the request
Return Type
- GetFollowersResponse|error - List entity followers
addOrganizationFollower
function addOrganizationFollower(int id, AddFollowerRequest payload, map<string|string[]> headers) returns AddFollowerResponse|errorAdd a follower to an organization
Parameters
- id int - The ID of the organization
- payload AddFollowerRequest - Request payload to add a follower to an organization
Return Type
- AddFollowerResponse|error - Add a follower
getOrganizationFollowersChangelog
function getOrganizationFollowersChangelog(int id, map<string|string[]> headers, *GetOrganizationFollowersChangelogQueries queries) returns GetFollowerChangelogsResponse|errorList followers changelog of an organization
Parameters
- id int - The ID of the organization
- queries *GetOrganizationFollowersChangelogQueries - Queries to be sent with the request
Return Type
- GetFollowerChangelogsResponse|error - List entity followers
deleteOrganizationFollower
function deleteOrganizationFollower(int id, int followerId, map<string|string[]> headers) returns DeleteFollowerResponse|errorDelete a follower from an organization
Return Type
- DeleteFollowerResponse|error - Remove a follower
getOrganizationFields
function getOrganizationFields(map<string|string[]> headers, *GetOrganizationFieldsQueries queries) returns GetOrganizationFieldsResponse|errorGet all organization fields
Parameters
- queries *GetOrganizationFieldsQueries - Queries to be sent with the request
Return Type
- GetOrganizationFieldsResponse|error - Get all organization fields
addOrganizationField
function addOrganizationField(AddOrganizationFieldRequest payload, map<string|string[]> headers) returns OrganizationFieldResponse|errorCreate one organization field
Parameters
- payload AddOrganizationFieldRequest - Request payload to create one organization field
Return Type
- OrganizationFieldResponse|error - Create one organization field
getOrganizationField
function getOrganizationField(string fieldCode, map<string|string[]> headers, *GetOrganizationFieldQueries queries) returns OrganizationFieldResponse|errorGet one organization field
Parameters
- fieldCode string - The unique code identifying the field
- queries *GetOrganizationFieldQueries - Queries to be sent with the request
Return Type
- OrganizationFieldResponse|error - Get one organization field
deleteOrganizationField
function deleteOrganizationField(string fieldCode, map<string|string[]> headers) returns DeleteFieldResponse|errorDelete one organization field
Parameters
- fieldCode string - The unique code identifying the field
Return Type
- DeleteFieldResponse|error - Delete one organization field
updateOrganizationField
function updateOrganizationField(string fieldCode, UpdateOrganizationFieldRequest payload, map<string|string[]> headers) returns OrganizationFieldResponse|errorUpdate one organization field
Parameters
- fieldCode string - The unique code identifying the field
- payload UpdateOrganizationFieldRequest - Request payload to update one organization field
Return Type
- OrganizationFieldResponse|error - Get one organization field
addOrganizationFieldOptions
function addOrganizationFieldOptions(string fieldCode, AddFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorAdd organization field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload AddFieldOptionsRequest[] - Request payload to add organization field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
deleteOrganizationFieldOptions
function deleteOrganizationFieldOptions(string fieldCode, DeleteFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorDelete organization field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload DeleteFieldOptionsRequest[] - Request payload to delete organization field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
updateOrganizationFieldOptions
function updateOrganizationFieldOptions(string fieldCode, UpdateFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorUpdate organization field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload UpdateFieldOptionsRequest[] - Request payload to update organization field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
getProducts
function getProducts(map<string|string[]> headers, *GetProductsQueries queries) returns GetProductsResponse|errorGet all products
Parameters
- queries *GetProductsQueries - Queries to be sent with the request
Return Type
- GetProductsResponse|error - List of products
addProduct
function addProduct(AddProductRequest payload, map<string|string[]> headers) returns GetProductResponse|errorAdd a product
Parameters
- payload AddProductRequest - Request payload to add a product
Return Type
- GetProductResponse|error - Add product data
getProductFollowers
function getProductFollowers(int id, map<string|string[]> headers, *GetProductFollowersQueries queries) returns GetFollowersResponse|errorList followers of a product
Parameters
- id int - The ID of the product
- queries *GetProductFollowersQueries - Queries to be sent with the request
Return Type
- GetFollowersResponse|error - List entity followers
addProductFollower
function addProductFollower(int id, AddFollowerRequest payload, map<string|string[]> headers) returns AddFollowerResponse|errorAdd a follower to a product
Parameters
- id int - The ID of the product
- payload AddFollowerRequest - Request payload to add a follower to a product
Return Type
- AddFollowerResponse|error - Add a follower
getProductFollowersChangelog
function getProductFollowersChangelog(int id, map<string|string[]> headers, *GetProductFollowersChangelogQueries queries) returns GetFollowerChangelogsResponse|errorList followers changelog of a product
Parameters
- id int - The ID of the product
- queries *GetProductFollowersChangelogQueries - Queries to be sent with the request
Return Type
- GetFollowerChangelogsResponse|error - List entity followers
deleteProductFollower
function deleteProductFollower(int id, int followerId, map<string|string[]> headers) returns DeleteFollowerResponse|errorDelete a follower from a product
Return Type
- DeleteFollowerResponse|error - Remove a follower
searchProducts
function searchProducts(map<string|string[]> headers, *SearchProductsQueries queries) returns GetProductSearchResponse|errorSearch products
Parameters
- queries *SearchProductsQueries - Queries to be sent with the request
Return Type
- GetProductSearchResponse|error - Search results for products
getProduct
Get one product
Parameters
- id int - The ID of the product
Return Type
- GetProductResponse|error - Get product information by id
deleteProduct
Delete a product
Parameters
- id int - The ID of the product
Return Type
- DeleteProductResponse|error - Deletes a product
updateProduct
function updateProduct(int id, UpdateProductRequest payload, map<string|string[]> headers) returns UpdateProductResponse|errorUpdate a product
Parameters
- id int - The ID of the product
- payload UpdateProductRequest - Request payload to update a product
Return Type
- UpdateProductResponse|error - Updates product data
duplicateProduct
Duplicate a product
Parameters
- id int - The ID of the product
Return Type
- GetProductResponse|error - Duplicate product data
getProductVariations
function getProductVariations(int id, map<string|string[]> headers, *GetProductVariationsQueries queries) returns GetProductVariationsResponse|errorGet all product variations
Parameters
- id int - The ID of the product
- queries *GetProductVariationsQueries - Queries to be sent with the request
Return Type
- GetProductVariationsResponse|error - List of product variations
addProductVariation
function addProductVariation(int id, AddProductVariationRequest payload, map<string|string[]> headers) returns GetProductVariationResponse|errorAdd a product variation
Parameters
- id int - The ID of the product
- payload AddProductVariationRequest - Request payload to add a product variation
Return Type
- GetProductVariationResponse|error - Add a product variation
deleteProductVariation
function deleteProductVariation(int id, int productVariationId, map<string|string[]> headers) returns DeleteProductVariationResponse|errorDelete a product variation
Return Type
- DeleteProductVariationResponse|error - Delete a product variation
updateProductVariation
function updateProductVariation(int id, int productVariationId, UpdateProductVariationRequest payload, map<string|string[]> headers) returns GetProductVariationResponse|errorUpdate a product variation
Parameters
- id int - The ID of the product
- productVariationId int - The ID of the product variation
- payload UpdateProductVariationRequest - Request payload to update a product variation
Return Type
- GetProductVariationResponse|error - Update product variation data
getProductImage
function getProductImage(int id, map<string|string[]> headers) returns GetProductImageResponse|errorGet image of a product
Parameters
- id int - The ID of the product
Return Type
- GetProductImageResponse|error - Retrieves the image of a product. The public URL has a limited lifetime of 7 days
updateProductImage
function updateProductImage(int id, UpdateProductImageRequest payload, map<string|string[]> headers) returns UpdateProductImageResponse|errorUpdate an image for a product
Parameters
- id int - The ID of the product
- payload UpdateProductImageRequest - Request payload to update an image for a product
Return Type
- UpdateProductImageResponse|error - Edited product image
uploadProductImage
function uploadProductImage(int id, UploadProductImageRequest payload, map<string|string[]> headers) returns AddProductImageResponse|errorUpload an image for a product
Parameters
- id int - The ID of the product
- payload UploadProductImageRequest - Request payload to upload an image for a product
Return Type
- AddProductImageResponse|error - Image added to product
deleteProductImage
function deleteProductImage(int id, map<string|string[]> headers) returns DeleteProductImageResponse|errorDelete an image of a product
Parameters
- id int - The ID of the product
Return Type
- DeleteProductImageResponse|error - The ID of the deleted product image
getProductFields
function getProductFields(map<string|string[]> headers, *GetProductFieldsQueries queries) returns GetProductFieldsResponse|errorGet all product fields
Parameters
- queries *GetProductFieldsQueries - Queries to be sent with the request
Return Type
- GetProductFieldsResponse|error - Get all product fields
addProductField
function addProductField(AddProductFieldRequest payload, map<string|string[]> headers) returns ProductFieldResponse|errorCreate one product field
Parameters
- payload AddProductFieldRequest - Request payload to create one product field
Return Type
- ProductFieldResponse|error - Create one product field
getProductField
function getProductField(string fieldCode, map<string|string[]> headers, *GetProductFieldQueries queries) returns ProductFieldResponse|errorGet one product field
Parameters
- fieldCode string - The unique code identifying the field
- queries *GetProductFieldQueries - Queries to be sent with the request
Return Type
- ProductFieldResponse|error - Get one product field
deleteProductField
function deleteProductField(string fieldCode, map<string|string[]> headers) returns DeleteFieldResponse|errorDelete one product field
Parameters
- fieldCode string - The unique code identifying the field
Return Type
- DeleteFieldResponse|error - Delete one product field
updateProductField
function updateProductField(string fieldCode, UpdateProductFieldRequest payload, map<string|string[]> headers) returns ProductFieldResponse|errorUpdate one product field
Parameters
- fieldCode string - The unique code identifying the field
- payload UpdateProductFieldRequest - Request payload to update one product field
Return Type
- ProductFieldResponse|error - Get one product field
addProductFieldOptions
function addProductFieldOptions(string fieldCode, AddFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorAdd product field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload AddFieldOptionsRequest[] - Request payload to add product field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
deleteProductFieldOptions
function deleteProductFieldOptions(string fieldCode, DeleteFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorDelete product field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload DeleteFieldOptionsRequest[] - Request payload to delete product field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
updateProductFieldOptions
function updateProductFieldOptions(string fieldCode, UpdateFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorUpdate product field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload UpdateFieldOptionsRequest[] - Request payload to update product field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
searchLeads
function searchLeads(map<string|string[]> headers, *SearchLeadsQueries queries) returns GetLeadSearchResponse|errorSearch leads
Parameters
- queries *SearchLeadsQueries - Queries to be sent with the request
Return Type
- GetLeadSearchResponse|error - Search results for leads
convertLeadToDeal
function convertLeadToDeal(string id, ConvertLeadToDealRequest payload, map<string|string[]> headers) returns AddConvertLeadToDealResponse|errorConvert a lead to a deal
Parameters
- id string - The ID of the lead to convert
- payload ConvertLeadToDealRequest - Request payload to convert a lead to a deal
Return Type
- AddConvertLeadToDealResponse|error - Successful response containing payload in the
datafield
getLeadConversionStatus
function getLeadConversionStatus(string id, string conversionId, map<string|string[]> headers) returns ConversionStatusResponse|errorGet Lead conversion status
Return Type
- ConversionStatusResponse|error - Successful response containing payload in the
datafield
searchOrganization
function searchOrganization(map<string|string[]> headers, *SearchOrganizationQueries queries) returns GetOrganizationSearchResponse|errorSearch organizations
Parameters
- queries *SearchOrganizationQueries - Queries to be sent with the request
Return Type
- GetOrganizationSearchResponse|error - Search results for organizations
searchPersons
function searchPersons(map<string|string[]> headers, *SearchPersonsQueries queries) returns GetPersonSearchResponse|errorSearch persons
Parameters
- queries *SearchPersonsQueries - Queries to be sent with the request
Return Type
- GetPersonSearchResponse|error - Search results for persons
searchItem
function searchItem(map<string|string[]> headers, *SearchItemQueries queries) returns GetItemSearchResponse|errorPerform a search from multiple item types
Parameters
- queries *SearchItemQueries - Queries to be sent with the request
Return Type
- GetItemSearchResponse|error - Search results across the requested item types
searchItemByField
function searchItemByField(map<string|string[]> headers, *SearchItemByFieldQueries queries) returns GetItemSearchFieldResponse|errorPerform a search using a specific field from an item type
Parameters
- queries *SearchItemByFieldQueries - Queries to be sent with the request
Return Type
- GetItemSearchFieldResponse|error - Search results for the specified item field
getStages
function getStages(map<string|string[]> headers, *GetStagesQueries queries) returns GetStagesResponse|errorGet all stages
Parameters
- queries *GetStagesQueries - Queries to be sent with the request
Return Type
- GetStagesResponse|error - Get all stages
addStage
function addStage(AddStageRequest payload, map<string|string[]> headers) returns UpsertStageResponse|errorAdd a new stage
Parameters
- payload AddStageRequest - Request payload to add a new stage
Return Type
- UpsertStageResponse|error - Add a new stage
getStage
Get one stage
Parameters
- id int - The ID of the stage
Return Type
- UpsertStageResponse|error - Get one stages
deleteStage
Delete a stage
Parameters
- id int - The ID of the stage
Return Type
- DeleteStageResponse|error - Delete stage
updateStage
function updateStage(int id, UpdateStageRequest payload, map<string|string[]> headers) returns UpsertStageResponse|errorUpdate stage details
Parameters
- id int - The ID of the stage
- payload UpdateStageRequest - Request payload to update stage details
Return Type
- UpsertStageResponse|error - Update an existing stage
getPipelines
function getPipelines(map<string|string[]> headers, *GetPipelinesQueries queries) returns GetPipelinesResponse|errorGet all pipelines
Parameters
- queries *GetPipelinesQueries - Queries to be sent with the request
Return Type
- GetPipelinesResponse|error - Get all pipelines
addPipeline
function addPipeline(AddPipelineRequest payload, map<string|string[]> headers) returns UpsertPipelineResponse|errorAdd a new pipeline
Parameters
- payload AddPipelineRequest - Request payload to add a new pipeline
Return Type
- UpsertPipelineResponse|error - Add pipeline
getPipeline
Get one pipeline
Parameters
- id int - The ID of the pipeline
Return Type
- UpsertPipelineResponse|error - Get pipeline
deletePipeline
Delete a pipeline
Parameters
- id int - The ID of the pipeline
Return Type
- DeletePipelineResponse|error - Delete pipeline
updatePipeline
function updatePipeline(int id, UpdatePipelineRequest payload, map<string|string[]> headers) returns UpsertPipelineResponse|errorUpdate a pipeline
Parameters
- id int - The ID of the pipeline
- payload UpdatePipelineRequest - Request payload to update a pipeline
Return Type
- UpsertPipelineResponse|error - Edit pipeline
getProjectFields
function getProjectFields(map<string|string[]> headers, *GetProjectFieldsQueries queries) returns GetProjectFieldsResponse|errorGet all project fields
Parameters
- queries *GetProjectFieldsQueries - Queries to be sent with the request
Return Type
- GetProjectFieldsResponse|error - Get all project fields
addProjectField
function addProjectField(AddProjectFieldRequest payload, map<string|string[]> headers) returns ProjectFieldResponse|errorCreate one project field
Parameters
- payload AddProjectFieldRequest - Request payload to create one project field
Return Type
- ProjectFieldResponse|error - Create one project field
getProjectField
function getProjectField(string fieldCode, map<string|string[]> headers) returns ProjectFieldResponse|errorGet one project field
Parameters
- fieldCode string - The unique code identifying the field
Return Type
- ProjectFieldResponse|error - Get one project field
deleteProjectField
function deleteProjectField(string fieldCode, map<string|string[]> headers) returns DeleteProjectFieldResponse|errorDelete one project field
Parameters
- fieldCode string - The unique code identifying the field
Return Type
- DeleteProjectFieldResponse|error - Delete one project field
updateProjectField
function updateProjectField(string fieldCode, UpdateProjectFieldRequest payload, map<string|string[]> headers) returns ProjectFieldResponse|errorUpdate one project field
Parameters
- fieldCode string - The unique code identifying the field
- payload UpdateProjectFieldRequest - Request payload to update one project field
Return Type
- ProjectFieldResponse|error - Get one project field
addProjectFieldOptions
function addProjectFieldOptions(string fieldCode, AddFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorAdd project field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload AddFieldOptionsRequest[] - Request payload to add project field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
deleteProjectFieldOptions
function deleteProjectFieldOptions(string fieldCode, DeleteFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorDelete project field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload DeleteFieldOptionsRequest[] - Request payload to delete project field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
updateProjectFieldOptions
function updateProjectFieldOptions(string fieldCode, UpdateFieldOptionsRequest[] payload, map<string|string[]> headers) returns FieldOptionsResponse|errorUpdate project field options in bulk
Parameters
- fieldCode string - The unique code identifying the field
- payload UpdateFieldOptionsRequest[] - Request payload to update project field options in bulk
Return Type
- FieldOptionsResponse|error - Field options operation result
getProjects
function getProjects(map<string|string[]> headers, *GetProjectsQueries queries) returns GetProjectsResponse|errorGet all projects
Parameters
- queries *GetProjectsQueries - Queries to be sent with the request
Return Type
- GetProjectsResponse|error - Get all projects
addProject
function addProject(AddProjectRequest payload, map<string|string[]> headers) returns UpsertProjectResponse|errorAdd a project
Parameters
- payload AddProjectRequest - Request payload to add a project
Return Type
- UpsertProjectResponse|error - Add project
getArchivedProjects
function getArchivedProjects(map<string|string[]> headers, *GetArchivedProjectsQueries queries) returns GetProjectsResponse|errorGet all archived projects
Parameters
- queries *GetArchivedProjectsQueries - Queries to be sent with the request
Return Type
- GetProjectsResponse|error - Get all projects
getProject
Get details of a project
Parameters
- id int - The ID of the project
Return Type
- UpsertProjectResponse|error - Get project
deleteProject
Delete a project
Parameters
- id int - The ID of the project
Return Type
- DeleteProjectResponse|error - Delete project
updateProject
function updateProject(int id, UpdateProjectRequest payload, map<string|string[]> headers) returns UpsertProjectResponse|errorUpdate a project
Parameters
- id int - The ID of the project
- payload UpdateProjectRequest - Request payload to update a project
Return Type
- UpsertProjectResponse|error - Update project
getProjectTemplates
function getProjectTemplates(map<string|string[]> headers, *GetProjectTemplatesQueries queries) returns GetProjectTemplatesResponse|errorGet all project templates
Parameters
- queries *GetProjectTemplatesQueries - Queries to be sent with the request
Return Type
- GetProjectTemplatesResponse|error - A list of project templates
getProjectTemplate
function getProjectTemplate(int id, map<string|string[]> headers) returns GetProjectTemplateResponse|errorGet details of a template
Parameters
- id int - The ID of the project template
Return Type
- GetProjectTemplateResponse|error - Get a project template
searchProjects
function searchProjects(map<string|string[]> headers, *SearchProjectsQueries queries) returns GetProjectSearchResponse|errorSearch projects
Parameters
- queries *SearchProjectsQueries - Queries to be sent with the request
Return Type
- GetProjectSearchResponse|error - Search results for projects
archiveProject
Archive a project
Parameters
- id int - The ID of the project
Return Type
- UpsertProjectResponse|error - Update project
getProjectUsers
function getProjectUsers(int id, map<string|string[]> headers) returns GetProjectPermittedUsersResponse|errorList permitted users
Parameters
- id int - The ID of the project
Return Type
- GetProjectPermittedUsersResponse|error - The retrieved project users
getProjectChangelog
function getProjectChangelog(int id, map<string|string[]> headers, *GetProjectChangelogQueries queries) returns GetProjectChangelogResponse|errorList updates about project field values
Parameters
- id int - The ID of the project
- queries *GetProjectChangelogQueries - Queries to be sent with the request
Return Type
- GetProjectChangelogResponse|error - Get changelog of a project
getTasks
function getTasks(map<string|string[]> headers, *GetTasksQueries queries) returns GetTasksResponse|errorGet all tasks
Parameters
- queries *GetTasksQueries - Queries to be sent with the request
Return Type
- GetTasksResponse|error - A list of tasks
addTask
function addTask(AddTaskRequest payload, map<string|string[]> headers) returns AddTaskResponse|errorAdd a task
Parameters
- payload AddTaskRequest - Request payload to add a task
Return Type
- AddTaskResponse|error - Created task
getTask
Get details of a task
Parameters
- id int - The ID of the task
Return Type
- GetTaskResponse|error - Get a task
deleteTask
Delete a task
Parameters
- id int - The ID of the task
Return Type
- DeleteTaskResponse|error - Deleted task
updateTask
function updateTask(int id, UpdateTaskRequest payload, map<string|string[]> headers) returns UpdateTaskResponse|errorUpdate a task
Return Type
- UpdateTaskResponse|error - Updated task
getProjectBoards
function getProjectBoards(map<string|string[]> headers) returns GetProjectBoardsResponse|errorGet all project boards
Return Type
- GetProjectBoardsResponse|error - Get all project boards
addProjectBoard
function addProjectBoard(AddProjectBoardRequest payload, map<string|string[]> headers) returns UpsertProjectBoardResponse|errorAdd a project board
Parameters
- payload AddProjectBoardRequest - Request payload to add a project board
Return Type
- UpsertProjectBoardResponse|error - Add a project board
getProjectBoard
function getProjectBoard(int id, map<string|string[]> headers) returns UpsertProjectBoardResponse|errorGet details of a project board
Parameters
- id int - The ID of the project board
Return Type
- UpsertProjectBoardResponse|error - Get a project board
deleteProjectBoard
function deleteProjectBoard(int id, map<string|string[]> headers) returns DeleteProjectBoardResponse|errorDelete a project board
Parameters
- id int - The ID of the project board
Return Type
- DeleteProjectBoardResponse|error - Delete a project board
updateProjectBoard
function updateProjectBoard(int id, UpdateProjectBoardRequest payload, map<string|string[]> headers) returns UpsertProjectBoardResponse|errorUpdate a project board
Parameters
- id int - The ID of the project board
- payload UpdateProjectBoardRequest - Request payload to update a project board
Return Type
- UpsertProjectBoardResponse|error - Update a project board
getProjectPhases
function getProjectPhases(map<string|string[]> headers, *GetProjectPhasesQueries queries) returns GetProjectPhasesResponse|errorGet project phases
Parameters
- queries *GetProjectPhasesQueries - Queries to be sent with the request
Return Type
- GetProjectPhasesResponse|error - Get all project phases for a board
addProjectPhase
function addProjectPhase(AddProjectPhaseRequest payload, map<string|string[]> headers) returns UpsertProjectPhaseResponse|errorAdd a project phase
Parameters
- payload AddProjectPhaseRequest - Request payload to add a project phase
Return Type
- UpsertProjectPhaseResponse|error - Add a project phase
getProjectPhase
function getProjectPhase(int id, map<string|string[]> headers) returns UpsertProjectPhaseResponse|errorGet details of a project phase
Parameters
- id int - The ID of the project phase
Return Type
- UpsertProjectPhaseResponse|error - Get a project phase
deleteProjectPhase
function deleteProjectPhase(int id, map<string|string[]> headers) returns DeleteProjectPhaseResponse|errorDelete a project phase
Parameters
- id int - The ID of the project phase
Return Type
- DeleteProjectPhaseResponse|error - Delete a project phase
updateProjectPhase
function updateProjectPhase(int id, UpdateProjectPhaseRequest payload, map<string|string[]> headers) returns UpsertProjectPhaseResponse|errorUpdate a project phase
Parameters
- id int - The ID of the project phase
- payload UpdateProjectPhaseRequest - Request payload to update a project phase
Return Type
- UpsertProjectPhaseResponse|error - Update a project phase
getUserFollowers
function getUserFollowers(int id, map<string|string[]> headers, *GetUserFollowersQueries queries) returns GetFollowersResponse|errorList followers of a user
Parameters
- id int - The ID of the user
- queries *GetUserFollowersQueries - Queries to be sent with the request
Return Type
- GetFollowersResponse|error - List entity followers
Records
pipedrive: ActivityItemLocation
Location of the activity
Fields
- country? string? - Country of the activity
- route? string? - Route (e.g. street) of the activity
- locality? string? - Locality (e.g. city) of the activity
- sublocality? string? - Sublocality (e.g. neighborhood) of the activity
- streetNumber? string? - Street number of the activity
- adminAreaLevel1? string? - Admin area level 1 (e.g. state) of the activity
- adminAreaLevel2? string? - Admin area level 2 (e.g. county) of the activity
- postalCode? string? - Postal code of the activity
- value? string - The full address of the activity
- subpremise? string? - Subpremise (e.g. apartment/suite number) of the activity
pipedrive: AddActivityAttendees
Fields
- userId? int - The ID of the user if the attendee is a user
- name? string - The name of the attendee
- isOrganizer? boolean - Whether the attendee is the organizer or not
- email? string - The email address of the attendee
- status? string - The status of the attendee
- personId? int - The ID of the person if the attendee has a person record
pipedrive: AddActivityLocation
Location of the activity
Fields
- country? string - Country of the activity
- route? string - Route (e.g. street) of the activity
- locality? string - Locality (e.g. city) of the activity
- sublocality? string - Sublocality (e.g. neighborhood) of the activity
- streetNumber? string - Street number of the activity
- adminAreaLevel1? string - Admin area level 1 (e.g. state) of the activity
- adminAreaLevel2? string - Admin area level 2 (e.g. county) of the activity
- postalCode? string - Postal code of the activity
- value? string - The full address of the activity
- subpremise? string - Subpremise (e.g. apartment/suite number) of the activity
pipedrive: AddActivityParticipants
Fields
- personId? int - The ID of the person
- primary? boolean - Whether the person is the primary participant or not
pipedrive: AddActivityRequest
Fields
- dueTime? string - The due time of the activity
- note? string - The note of the activity
- publicDescription? string - The public description of the activity
- subject? string - The subject of the activity
- ownerId? int - The ID of the user who owns the activity
- attendees? AddActivityAttendees[] - The attendees of the activity
- dueDate? string - The due date of the activity
- 'type? string - The type of the activity
- priority? int - The priority of the activity. Mappable to a specific string using activityFields API
- done? boolean - Whether the activity is marked as done or not
- duration? string - The duration of the activity
- projectId? int - The ID of the project linked to the activity
- orgId? int - The ID of the organization linked to the activity
- busy? boolean - Whether the activity marks the assignee as busy or not in their calendar
- location? AddActivityLocation - Location of the activity
- dealId? int - The ID of the deal linked to the activity
- leadId? string - The ID of the lead linked to the activity
- outcome? int? - The ID of the Outcome for the activity. The available Outcome values depend on the activity type and can be retrieved using the Activity Fields API. Set to
nullto clear the Outcome
- participants? AddActivityParticipants[] - The participants of the activity. Use this to set the activity's person — a primary participant (
primary: true) setsperson_idon the activity
pipedrive: AddAdditionalDiscountRequest
Fields
- description string - The name of the discount.
- amount decimal - The discount amount. Must be a positive number (excluding 0).
- 'type "percentage"|"amount" - Determines whether the discount is applied as a percentage or a fixed amount.
pipedrive: AddAdditionalDiscountResponse
Fields
- success? boolean - If the response is successful or not
pipedrive: AddAInstallmentResponse
Fields
- data? GetInstallmentsResponseData -
- success? boolean - If the response is successful or not
pipedrive: AddConvertDealToLeadResponse
Fields
- additionalData? record {}? -
- data? AddConvertDealToLeadResponseData - An object containing conversion job id that performs the conversion
- success? boolean -
pipedrive: AddConvertDealToLeadResponseData
An object containing conversion job id that performs the conversion
Fields
- conversionId string - The ID of the conversion job that can be used to retrieve conversion status and details. The ID has UUID format
pipedrive: AddConvertLeadToDealResponse
Fields
- additionalData? record {}? -
- data? AddConvertDealToLeadResponseData - An object containing conversion job id that performs the conversion
- success? boolean -
pipedrive: AddDealFieldImportantFields
Configuration for highlighting the field at specific stages
Fields
- enabled boolean(default false) - Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those stages. Default is false.
- stage_ids int[](default []) - Array of deal stage IDs where this field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false. The stages must be in pipelines where this field is visible (show_in_pipelines).
pipedrive: AddDealFieldOptions
Fields
- label string - The option label
pipedrive: AddDealFieldRequest
Fields
- requiredFields? AddDealFieldRequiredFields -
- options? AddDealFieldOptions[] - Field options (required for enum and set field types)
- importantFields? AddDealFieldImportantFields -
- description? string? - Field description
- fieldType "varchar"|"text"|"double"|"phone"|"date"|"daterange"|"time"|"timerange"|"set"|"enum"|"varchar_auto"|"address"|"monetary"|"org"|"people"|"user" - The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>
varchar</td><td>Text (up to 255 characters)</td><tr><td>varchar_auto</td><td>Autocomplete text (up to 255 characters)</td><tr><td>text</td><td>Long text (up to 65k characters)</td><tr><td>double</td><td>Numeric value</td><tr><td>monetary</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>date</td><td>Date (format YYYY-MM-DD)</td><tr><td>set</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>enum</td><td>Options field with a single possible chosen option</td><tr><td>user</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>org</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>people</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>phone</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>time</td><td>Time field (format HH:MM:SS)</td><tr><td>timerange</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>daterange</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>address</td><td>Address field</dd></table>
- uiVisibility? AddDealFieldUiVisibility -
- fieldName string - Field name
pipedrive: AddDealFieldRequiredFields
Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI
Fields
- enabled boolean(default false) - Whether the field is required. When false, the field is optional. When true with empty stage_ids, the field is required everywhere. When true with specific stage_ids, the field is required only at those stages. Default is false.
- stage_ids int[](default []) - Array of deal stage IDs where this field is required. Must reference valid, active deal stages. Empty array when enabled is false. The stages must be in pipelines where this field is visible (show_in_pipelines).
- statuses record { ("won"|"lost")[]... }(default {}) - Pipeline-specific status requirements for when deals are won or lost. Keys are pipeline IDs (as strings), values are arrays of status strings ('won', 'lost'). Example -
{"1":["won","lost"],"2":["won"]}means the field is required when marking deals as won or lost in pipeline 1, and only when won in pipeline 2. Must reference valid, active pipelines.
pipedrive: AddDealFieldUiVisibility
UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI
Fields
- add_visible_flag boolean(default false) - Whether the field is shown in the add deal modal. Default is false. Cannot be set to false for required system fields (title, pipeline, stage_id, probability).
- details_visible_flag boolean(default true) - Whether the field is shown in the deal details view. Default is true.
- projects_detail_visible_flag boolean(default false) - Whether the field is shown in the project details view when the deal is linked to a project. Default is false.
- show_in_pipelines? AddDealFieldUiVisibilityShowInPipelines - Controls which pipelines display this field. Default is show_in_all=true. Note that fields marked as important or required must be visible in the pipelines where they are configured
pipedrive: AddDealFieldUiVisibilityShowInPipelines
Controls which pipelines display this field. Default is show_in_all=true. Note that fields marked as important or required must be visible in the pipelines where they are configured
Fields
- showInAll boolean(default true) - When true, the field is visible in all pipelines. When false, visibility is controlled by pipeline_ids. Default is true
- pipelineIds? int[] - Array of pipeline IDs where the field should be visible. Only used when show_in_all is false. Must reference valid, active pipelines
pipedrive: AddDealProductRequest
Fields
- Fields Included from *DealProductRequestBody
- Fields Included from *AddDealProductRequestPart1
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly"
- anydata...
- Fields Included from *AddDealProductRequestPart2
- billingFrequencyCycles int|()
- anydata...
- Fields Included from *AddDealProductRequestPart3
- billingStartDate string|()
- anydata...
pipedrive: AddDealProductRequest1
Fields
- Fields Included from *AddDealProductRequest1Part4
- Fields Included from *AddDealProductRequest1Part3
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly"
- anydata...
- Fields Included from *AddDealProductRequest1Part2
- billingFrequencyCycles int|()
- anydata...
- Fields Included from *AddDealProductRequest1Part1
- billingStartDate string|()
- anydata...
pipedrive: AddDealProductRequest1Part1
Fields
- billingStartDate? string? - Only available in Growth and above plans The billing start date. Must be between 10 years in the past and 10 years in the future
pipedrive: AddDealProductRequest1Part2
Fields
- billingFrequencyCycles? int? - Only available in Growth and above plans
The number of times the billing frequency repeats for a product in a deal
When
billing_frequencyis set toone-time, this field must benullWhenbilling_frequencyis set toweekly, this field cannot benullFor all the other values ofbilling_frequency,nullrepresents a product billed indefinitely Must be a positive integer less or equal to 208
pipedrive: AddDealProductRequest1Part3
Fields
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" (default "one-time") - Only available in Growth and above plans
How often a customer is billed for access to a service or product
To set
billing_frequencydifferent thanone-time, the deal must not have installments associated A deal can have up to 20 products attached withbilling_frequencydifferent thanone-time
pipedrive: AddDealProductRequest1Part4
Fields
- isEnabled boolean(default true) - Whether this product is enabled for the deal Not possible to disable the product if the deal has installments associated and the product is the last one enabled Not possible to enable the product if the deal has installments associated and the product is recurring
- quantity decimal - The quantity of the product
- comments? string - The comments of the product
- itemPrice decimal - The price value of the product
- productId int - The ID of the product
- discount decimal(default 0) - The value of the discount. The
discount_typefield can be used to specify whether the value is an amount or a percentage
- tax decimal(default 0) - The product tax
- productVariationId? int? - The ID of the product variation
- discountType "percentage"|"amount" (default "percentage") - The value of the discount. The
discount_typefield can be used to specify whether the value is an amount or a percentage
- taxMethod? "exclusive"|"inclusive"|"none" - The tax option to be applied to the products. When using
inclusive, the tax percentage will already be included in the price. When usingexclusive, the tax will not be included in the price. When usingnone, no tax will be added. Use thetaxfield for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal
pipedrive: AddDealProductRequestPart1
Fields
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" (default "one-time") - Only available in Growth and above plans
How often a customer is billed for access to a service or product
To set
billing_frequencydifferent thanone-time, the deal must not have installments associated A deal can have up to 20 products attached withbilling_frequencydifferent thanone-time
pipedrive: AddDealProductRequestPart2
Fields
- billingFrequencyCycles? int? - Only available in Growth and above plans
The number of times the billing frequency repeats for a product in a deal
When
billing_frequencyis set toone-time, this field must benullWhenbilling_frequencyis set toweekly, this field cannot benullFor all the other values ofbilling_frequency,nullrepresents a product billed indefinitely Must be a positive integer less or equal to 208
pipedrive: AddDealProductRequestPart3
Fields
- billingStartDate? string? - Only available in Growth and above plans The billing start date. Must be between 10 years in the past and 10 years in the future
pipedrive: AddDealProductResponse
Fields
- data? record { id int, sum decimal, tax decimal, deal_id int, name string, product_id int, product_variation_id int?, order_nr int?, add_time string, update_time string, comments string, currency string, discount decimal, discount_type "percentage"|"amount" , quantity decimal, item_price decimal, tax_method "exclusive"|"inclusive"|"none" , is_enabled boolean, billing_frequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" , billing_frequency_cycles int?, billing_start_date string? } -
- success? boolean - If the response is successful or not
pipedrive: AddDealRequest
Fields
- expectedCloseDate? string - The expected close date of the deal
- ownerId? int - The ID of the user who owns the deal
- stageId? int - The ID of the deal stage
- probability? decimal - The success probability percentage of the deal
- labelIds? int[] - The IDs of labels assigned to the deal
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- archiveTime? string? - The optional date and time of archiving the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. If omitted and
is_archivedis true, it will be set to the current date and time
- closeTime? string - The date and time of closing the deal. Can only be set if deal status is won or lost
- title string - The title of the deal
- lostReason? string - The reason for losing the deal. Can only be set if deal status is lost
- isDeleted? boolean - Whether the deal is deleted or not
- wonTime? string - The date and time of changing the deal status as won. Can only be set if deal status is won
- isArchived? boolean - Whether the deal is archived or not
- visibleTo? int - The visibility of the deal
- orgId? int? - The ID of the organization linked to the deal
- pipelineId? int - The ID of the pipeline associated with the deal
- lostTime? string - The date and time of changing the deal status as lost. Can only be set if deal status is lost
- currency? string - The currency associated with the deal
- value? decimal - The value of the deal
- personId? int? - The ID of the person linked to the deal
- status? string - The status of the deal
pipedrive: AddFieldOptionsRequest
Fields
- label string - The display label for the new option
pipedrive: AddFollowerRequest
Fields
- userId int - The ID of the user to add as a follower
pipedrive: AddFollowerResponse
Fields
- Fields Included from *AddFollowerResponseBase
- success boolean
- anydata...
- Fields Included from *AddFollowerResponseContent
- data GetFollowersResponseData
- anydata...
pipedrive: AddFollowerResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: AddFollowerResponseContent
Fields
- data? GetFollowersResponseData -
pipedrive: AddInstallmentRequest
Fields
- description string - The name of the installment.
- amount decimal - The installment amount. Must be a positive number (excluding 0).
- billing_date string - The date on which the installment will be charged. Must be in the format YYYY-MM-DD.
pipedrive: AddManyDealProductResponse
Fields
- data? AddManyDealProductResponseData[] - Array of created deal products
- success? boolean - If the response is successful or not
pipedrive: AddManyDealProductResponseData
Fields
- Fields Included from *AddManyDealProductResponseDataPart1
- comments string
- quantity decimal
- itemPrice decimal
- orderNr int|()
- discount decimal
- sum decimal
- tax decimal
- productVariationId int|()
- discountType "percentage"|"amount"
- taxMethod "exclusive"|"inclusive"|"none"
- isEnabled boolean
- updateTime string
- productId int
- name string
- currency string
- id int
- dealId int
- addTime string
- anydata...
- Fields Included from *AddManyDealProductResponseDataPart2
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly"
- anydata...
- Fields Included from *AddManyDealProductResponseDataPart3
- billingFrequencyCycles int|()
- anydata...
- Fields Included from *AddManyDealProductResponseDataPart4
- billingStartDate string|()
- anydata...
pipedrive: AddManyDealProductResponseDataPart1
Fields
- comments? string - The comments of the product
- quantity? decimal - The quantity of the product
- itemPrice? decimal - The price value of the product
- orderNr? int? - The order number of the product within the deal
- discount decimal(default 0) - The value of the discount. The
discount_typefield can be used to specify whether the value is an amount or a percentage
- sum? decimal - The sum of all the products attached to the deal
- tax? decimal - The product tax
- productVariationId? int? - The ID of the product variation
- discountType "percentage"|"amount" (default "percentage") - The type of the discount's value
- taxMethod? "exclusive"|"inclusive"|"none" - The tax option to be applied to the products. When using
inclusive, the tax percentage will already be included in the price. When usingexclusive, the tax will not be included in the price. When usingnone, no tax will be added. Use thetaxfield for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal
- isEnabled boolean(default true) - Whether this product is enabled for the deal
- updateTime? string - The date and time when the deal product was last updated
- productId? int - The ID of the product
- name? string - The product name
- currency? string - The currency associated with the deal product
- id? int - The ID of the deal-product (the ID of the product attached to the deal)
- dealId? int - The ID of the deal
- addTime? string - The date and time when the product was added to the deal
pipedrive: AddManyDealProductResponseDataPart2
Fields
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" (default "one-time") - Only available in Growth and above plans
How often a customer is billed for access to a service or product
To set
billing_frequencydifferent thanone-time, the deal must not have installments associated A deal can have up to 20 products attached withbilling_frequencydifferent thanone-time
pipedrive: AddManyDealProductResponseDataPart3
Fields
- billingFrequencyCycles? int? - Only available in Growth and above plans
The number of times the billing frequency repeats for a product in a deal
When
billing_frequencyis set toone-time, this field must benullWhenbilling_frequencyis set toweekly, this field cannot benullFor all the other values ofbilling_frequency,nullrepresents a product billed indefinitely Must be a positive integer less or equal to 208
pipedrive: AddManyDealProductResponseDataPart4
Fields
- billingStartDate? string? - Only available in Growth and above plans The billing start date. Must be between 10 years in the past and 10 years in the future
pipedrive: AddOrganizationFieldImportantFields
Configuration for highlighting the field at specific stages
Fields
- enabled boolean(default false) - Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false.
- stage_ids int[](default []) - Array of deal stage IDs where this organization field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false.
pipedrive: AddOrganizationFieldRequest
Fields
- requiredFields? AddOrganizationFieldRequiredFields -
- options? AddDealFieldOptions[] - Field options (required for enum and set field types)
- importantFields? AddOrganizationFieldImportantFields -
- fieldType "varchar"|"text"|"double"|"phone"|"date"|"daterange"|"time"|"timerange"|"set"|"enum"|"varchar_auto"|"address"|"monetary"|"org"|"people"|"user" - The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>
varchar</td><td>Text (up to 255 characters)</td><tr><td>varchar_auto</td><td>Autocomplete text (up to 255 characters)</td><tr><td>text</td><td>Long text (up to 65k characters)</td><tr><td>double</td><td>Numeric value</td><tr><td>monetary</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>date</td><td>Date (format YYYY-MM-DD)</td><tr><td>set</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>enum</td><td>Options field with a single possible chosen option</td><tr><td>user</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>org</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>people</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>phone</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>time</td><td>Time field (format HH:MM:SS)</td><tr><td>timerange</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>daterange</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>address</td><td>Address field</dd></table>
- uiVisibility? AddOrganizationFieldUiVisibility -
- fieldName string - Field name
pipedrive: AddOrganizationFieldRequiredFields
Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI
Fields
- enabled boolean(default false) - Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating organizations. Default is false.
pipedrive: AddOrganizationFieldUiVisibility
UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI
Fields
- add_visible_flag boolean(default false) - Whether the field is shown in the add organization modal. Default is false. Cannot be set to false for the 'name' system field.
- details_visible_flag boolean(default true) - Whether the field is shown in the organization details view. Default is true.
- show_in_add_deal_dialog? AddOrganizationFieldUiVisibilityShowInAddDealDialog - Configuration for showing this organization field when adding a new deal. Only available for custom fields or specific eligible system fields. Default is show=false, order=null
- show_in_add_person_dialog? AddOrganizationFieldUiVisibilityShowInAddPersonDialog - Configuration for showing this organization field when adding a new person. Only available for custom fields or specific eligible system fields. Default is show=false, order=null
pipedrive: AddOrganizationFieldUiVisibilityShowInAddDealDialog
Configuration for showing this organization field when adding a new deal. Only available for custom fields or specific eligible system fields. Default is show=false, order=null
Fields
- show boolean(default false) - Whether the field is shown in the add deal dialog. Default is false
- 'order? int? - Display order in the add deal dialog. This value is auto-calculated and managed by the system. When show is set to false, order is automatically set to null. When show changes from false to true, order is automatically assigned the next available position
pipedrive: AddOrganizationFieldUiVisibilityShowInAddPersonDialog
Configuration for showing this organization field when adding a new person. Only available for custom fields or specific eligible system fields. Default is show=false, order=null
Fields
- show boolean(default false) - Whether the field is shown in the add person dialog. Default is false
- 'order? int? - Display order in the add person dialog. This value is auto-calculated and managed by the system. When show is set to false, order is automatically set to null. When show changes from false to true, order is automatically assigned the next available position
pipedrive: AddOrganizationRequest
Fields
- employeeCount? int? - The number of employees in the organization
- website? string? - The website of the organization
- address? OrganizationItemAddress? - The address of the organization
- visibleTo? int - The visibility of the organization
- ownerId? int - The ID of the user who owns the organization
- labelIds? int[] - The IDs of labels assigned to the organization
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- name string - The name of the organization
- industry? int? - The industry the organization belongs to
- linkedin? string? - The LinkedIn profile URL of the organization
- addTime? string - The creation date and time of the organization
- annualRevenue? int? - The annual revenue of the organization
pipedrive: AddPersonFieldImportantFields
Configuration for highlighting the field at specific stages
Fields
- enabled boolean(default false) - Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false.
- stage_ids int[](default []) - Array of deal stage IDs where this person field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false.
pipedrive: AddPersonFieldRequest
Fields
- requiredFields? AddPersonFieldRequiredFields -
- options? AddDealFieldOptions[] - Field options (required for enum and set field types)
- importantFields? AddPersonFieldImportantFields -
- fieldType "varchar"|"text"|"double"|"phone"|"date"|"daterange"|"time"|"timerange"|"set"|"enum"|"varchar_auto"|"address"|"monetary"|"org"|"people"|"user" - The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>
varchar</td><td>Text (up to 255 characters)</td><tr><td>varchar_auto</td><td>Autocomplete text (up to 255 characters)</td><tr><td>text</td><td>Long text (up to 65k characters)</td><tr><td>double</td><td>Numeric value</td><tr><td>monetary</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>date</td><td>Date (format YYYY-MM-DD)</td><tr><td>set</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>enum</td><td>Options field with a single possible chosen option</td><tr><td>user</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>org</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>people</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>phone</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>time</td><td>Time field (format HH:MM:SS)</td><tr><td>timerange</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>daterange</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>address</td><td>Address field</dd></table>
- uiVisibility? AddPersonFieldUiVisibility -
- fieldName string - Field name
pipedrive: AddPersonFieldRequiredFields
Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI
Fields
- enabled boolean(default false) - Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating persons. Default is false.
pipedrive: AddPersonFieldUiVisibility
UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI
Fields
- add_visible_flag boolean(default false) - Whether the field is shown in the add person modal. Default is false. Cannot be set to false for required system fields ('name', 'org_id').
- details_visible_flag boolean(default true) - Whether the field is shown in the person details view. Default is true.
- show_in_add_deal_dialog? AddPersonFieldUiVisibilityShowInAddDealDialog - Configuration for showing this person field when adding a new deal. Only available for custom fields or specific eligible system fields. Default is show=false, order=null
pipedrive: AddPersonFieldUiVisibilityShowInAddDealDialog
Configuration for showing this person field when adding a new deal. Only available for custom fields or specific eligible system fields. Default is show=false, order=null
Fields
- show boolean(default false) - Whether the field is shown in the add deal dialog. Default is false
- 'order? int? - Display order in the add deal dialog. This value is auto-calculated and managed by the system. When show is set to false, order is automatically set to null. When show changes from false to true, order is automatically assigned the next available position
pipedrive: AddPersonRequest
Fields
- postalAddress? PersonItemAddress? -
- birthday? string - The birthday of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403
- notes? string - Contact sync notes of the person, maximum 10 000 characters. Only accepted when contact sync is enabled for the company; otherwise the request returns 403
- im? PersonItemIm[] - The instant messaging accounts of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403
- ownerId? int - The ID of the user who owns the person
- labelIds? int[] - The IDs of labels assigned to the person
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- phones? PersonItemPhone[] - The phones of the person
- emails? PersonItemEmail[] - The emails of the person
- marketingStatus? "no_consent"|"unsubscribed"|"subscribed"|"archived" - If the person does not have a valid email address, then the marketing status is not set and
no_consentis returned for themarketing_statusvalue when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed once to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>no_consent</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>unsubscribed</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>subscribed</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>archived</td><td>The customers withsubscribedstatus can be moved toarchivedto save consent, but they are not paid for</td></tr></table>
- visibleTo? int - The visibility of the person
- orgId? int - The ID of the organization linked to the person
- name string - The name of the person
- addTime? string - The creation date and time of the person
- jobTitle? string - The job title of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403
pipedrive: AddPipelineRequest
Fields
- name string - The name of the pipeline
- isDealProbabilityEnabled boolean(default false) - Whether deal probability is disabled or enabled for this pipeline
pipedrive: AddProductFieldRequest
Fields
- options? AddDealFieldOptions[] - Field options (required for enum and set field types)
- fieldType "varchar"|"text"|"double"|"phone"|"date"|"daterange"|"time"|"timerange"|"set"|"enum"|"varchar_auto"|"address"|"monetary"|"org"|"people"|"user" - The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>
varchar</td><td>Text (up to 255 characters)</td><tr><td>varchar_auto</td><td>Autocomplete text (up to 255 characters)</td><tr><td>text</td><td>Long text (up to 65k characters)</td><tr><td>double</td><td>Numeric value</td><tr><td>monetary</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>date</td><td>Date (format YYYY-MM-DD)</td><tr><td>set</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>enum</td><td>Options field with a single possible chosen option</td><tr><td>user</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>org</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>people</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>phone</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>time</td><td>Time field (format HH:MM:SS)</td><tr><td>timerange</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>daterange</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>address</td><td>Address field</dd></table>
- uiVisibility? AddProductFieldUiVisibility -
- fieldName string - Field name
pipedrive: AddProductFieldUiVisibility
UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. Note that products have a simpler visibility model than other entity types
Fields
- add_visible_flag boolean(default false) - Whether the field is shown in the add product modal. Default is false. Cannot be set to false for the 'name' system field.
- details_visible_flag boolean(default true) - Whether the field is shown in the product details view. Default is true.
pipedrive: AddProductImageResponse
Fields
- data? UpdateProductImageResponseData -
- success? boolean - If the response is successful or not
pipedrive: AddProductRequest
Fields
- Fields Included from *AddProductRequestPart1
- name string
- anydata...
- Fields Included from *ProductRequest
- Fields Included from *AddProductRequestPart2
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly"
- anydata...
- Fields Included from *AddProductRequestPart3
- billingFrequencyCycles int|()
- anydata...
pipedrive: AddProductRequestPart1
Fields
- name string - The name of the product. Cannot be an empty string
pipedrive: AddProductRequestPart2
Fields
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" (default "one-time") - Only available in Growth and above plans How often a customer is billed for access to a service or product
pipedrive: AddProductRequestPart3
Fields
- billingFrequencyCycles? int? - Only available in Growth and above plans
The number of times the billing frequency repeats for a product in a deal
When
billing_frequencyis set toone-time, this field must benullWhenbilling_frequencyis set toweekly, this field cannot benullFor all the other values ofbilling_frequency,nullrepresents a product billed indefinitely Must be a positive integer less or equal to 208
pipedrive: AddProductVariationRequest
Fields
- name string - The name of the product variation. The maximum length is 255 characters
- prices? record {}[] - Array of objects, each containing: currency (string), price (number), cost (number, optional), direct_cost (number, optional), notes (string, optional). When prices is omitted altogether, a default price of 0, a default cost of 0, a default direct_cost of 0 and the user's default currency will be assigned
pipedrive: AddProjectBoardRequest
Fields
- orderNr? int - The order of the board. Must be between 1 and the total number of boards + 1
- name string - The name of the project board
pipedrive: AddProjectFieldImportantFields
Configuration for highlighting the field at specific stages
Fields
- enabled boolean(default false) - Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false.
- stage_ids int[](default []) - Array of deal stage IDs where this project field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false.
pipedrive: AddProjectFieldRequest
Fields
- requiredFields? AddProjectFieldRequiredFields -
- options? AddDealFieldOptions[] - Field options (required for enum and set field types)
- importantFields? AddProjectFieldImportantFields -
- fieldType "varchar"|"text"|"double"|"phone"|"date"|"daterange"|"time"|"timerange"|"set"|"enum"|"varchar_auto"|"address"|"monetary"|"org"|"people"|"user" - The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>
varchar</td><td>Text (up to 255 characters)</td><tr><td>varchar_auto</td><td>Autocomplete text (up to 255 characters)</td><tr><td>text</td><td>Long text (up to 65k characters)</td><tr><td>double</td><td>Numeric value</td><tr><td>monetary</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>date</td><td>Date (format YYYY-MM-DD)</td><tr><td>set</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>enum</td><td>Options field with a single possible chosen option</td><tr><td>user</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>org</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>people</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>phone</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>time</td><td>Time field (format HH:MM:SS)</td><tr><td>timerange</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>daterange</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>address</td><td>Address field</dd></table>
- uiVisibility? AddProjectFieldUiVisibility -
- fieldName string - Field name
pipedrive: AddProjectFieldRequiredFields
Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI
Fields
- enabled boolean(default false) - Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating projects. Default is false.
pipedrive: AddProjectFieldUiVisibility
UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI
Fields
- add_visible_flag boolean(default false) - Whether the field is shown in the add project modal. Default is false.
- details_visible_flag boolean(default true) - Whether the field is shown in the project details view. Default is true.
pipedrive: AddProjectPhaseRequest
Fields
- boardId int - The ID of the project board to add the phase to
- orderNr? int - The order of the phase within its board. Must be between 1 and the total number of phases on the board + 1
- name string - The name of the project phase
pipedrive: AddProjectRequest
Fields
- endDate? string - The end date of the project. Format: YYYY-MM-DD
- ownerId? int - The ID of the user who owns the project
- labelIds? int[] - An array of IDs of the labels this project has
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- description? string - The description of the project
- orgIds? int[] - An array of IDs of the organizations this project is associated with
- phaseId? int - The ID of the phase this project is associated with
- dealIds? int[] - An array of IDs of the deals this project is associated with
- title string - The title of the project
- boardId? int - The ID of the board this project is associated with
- personIds? int[] - An array of IDs of the persons this project is associated with
- templateId? int - The ID of the template the project will be based on. Only used when creating a new project
- healthStatus? int - The health status of the project
- status? string - The status of the project
- startDate? string - The start date of the project. Format: YYYY-MM-DD
pipedrive: AddStageRequest
Fields
- isDealRotEnabled? boolean - Whether deals in this stage can become rotten
- name string - The name of the stage
- pipelineId int - The ID of the pipeline to add stage to
- dealProbability? int - The success probability percentage of the deal. Used/shown when deal weighted values are used
- daysToRotten? int? - The number of days the deals not updated in this stage would become rotten. Applies only if the
is_deal_rot_enabledis set
pipedrive: AddTaskRequest
Fields
- parentTaskId? int? - The ID of the parent task. Cannot be the ID of a task that is already a subtask
- milestone? 0|1 - Whether the task is a milestone or not.
0= Not a milestone,1= Milestone
- projectId int - The ID of the project this task is associated with
- dueDate? string? - The due date of the task. Format: YYYY-MM-DD
- description? string? - The description of the task
- title string - The title of the task
- priority? int? - The priority of the task
- done? 0|1 - Whether the task is done or not.
0= Not done,1= Done
- startDate? string? - The start date of the task. Format: YYYY-MM-DD
- assigneeId? int? - The ID of the user assigned to the task. When set, the
assignee_idsfield will be overwritten with this value
- assigneeIds? int[] - The IDs of users assigned to the task. When set, the
assignee_idfield will be set to the first value in this array, ornullif empty
pipedrive: AddTaskResponse
Fields
- additionalData? record {}? -
- data? GetTasksResponseData -
- success? boolean - If the response is successful or not
pipedrive: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiToken string - API token supplied in the x-api-token request header
pipedrive: BaseProduct
Fields
- code? string - The product code
- ownerId? int - The ID of the Pipedrive user who owns the product
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- description? string - The description of the product
- tax decimal(default 0) - The tax percentage
- isLinkable boolean(default true) - Whether this product can be added to a deal or not
- unit? string - The unit in which this product is sold
- updateTime? string - The date and time when the product was last updated
- isDeleted boolean(default false) - Whether this product will be marked as deleted or not
- visibleTo? 1|3|5|7 - Visibility of the product
- name? string - The name of the product
- id? int - The ID of the product
- category? string? - The category of the product
- addTime? string - The date and time when the product was added
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" (default "one-time") - Only available in Growth and above plans How often a customer is billed for access to a service or product
- billingFrequencyCycles? int? - Only available in Growth and above plans
The number of times the billing frequency repeats for a product in a deal
When
billing_frequencyis set toone-time, this field must benullWhenbilling_frequencyis set toweekly, this field cannot benullFor all the other values ofbilling_frequency,nullrepresents a product billed indefinitely Must be a positive integer less or equal to 208
pipedrive: BaseResponse
Fields
- success? boolean - If the response is successful or not
pipedrive: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig|CredentialsConfig|ApiKeysConfig - Provides Auth configurations needed when communicating with a remote HTTP endpoint.
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
pipedrive: ConversionStatusResponse
Fields
- additionalData? record {}? -
- data ConversionStatusResponseData - An object containing conversion status. After successful conversion the converted entity ID is also present
- success boolean -
pipedrive: ConversionStatusResponseData
An object containing conversion status. After successful conversion the converted entity ID is also present
Fields
- conversionId string - The ID of the conversion job. The ID can be used to retrieve conversion status and details. The ID has UUID format
- dealId? int - The ID of the new deal
- leadId? string - The ID of the new lead
- status "not_started"|"running"|"completed"|"failed"|"rejected" - Status of the conversion job
pipedrive: ConvertLeadToDealRequest
Fields
- stageId? int - The ID of a stage the created deal will be added to. Please note that a pipeline will be assigned automatically based on the
stage_id. If omitted, the deal will be placed in the first stage of the default pipeline
- pipelineId? int - The ID of a pipeline the created deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that
pipeline_idandstage_idshould not be used together aspipeline_idwill be ignored
pipedrive: CreateManyDealProductRequest
Fields
- data AddDealProductRequest1[] - Array of products to attach to the deal. Each product object may have the following properties
pipedrive: DealFieldResponse
Fields
- data? GetDealFieldsResponseData -
- success? boolean - Whether the request was successful
pipedrive: DealProductRequestBody
Fields
- isEnabled boolean(default true) - Whether this product is enabled for the deal Not possible to disable the product if the deal has installments associated and the product is the last one enabled Not possible to enable the product if the deal has installments associated and the product is recurring
- quantity decimal - The quantity of the product
- comments? string - The comments of the product
- itemPrice decimal - The price value of the product
- productId int - The ID of the product
- discount decimal(default 0) - The value of the discount. The
discount_typefield can be used to specify whether the value is an amount or a percentage
- tax decimal(default 0) - The product tax
- productVariationId? int? - The ID of the product variation
- discountType "percentage"|"amount" (default "percentage") - The value of the discount. The
discount_typefield can be used to specify whether the value is an amount or a percentage
- taxMethod? "exclusive"|"inclusive"|"none" - The tax option to be applied to the products. When using
inclusive, the tax percentage will already be included in the price. When usingexclusive, the tax will not be included in the price. When usingnone, no tax will be added. Use thetaxfield for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal
pipedrive: DeleteActivityResponse
Fields
- data? DeleteActivityResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteActivityResponseData
Fields
- id? int - Deleted activity ID
pipedrive: DeleteAdditionalDiscountResponse
Fields
- success? boolean - If the response is successful or not
pipedrive: DeleteAdditionalDiscountResponseData
Fields
- id? int - The ID of the discount that was deleted from the deal
pipedrive: DeleteDealFieldResponse
Fields
- data? DeleteDealFieldResponseData -
- success? boolean - Whether the request was successful
pipedrive: DeleteDealFieldResponseData
Fields
- isOptionalResponseField boolean - Whether this field is not returned by default in entity responses
- subfields? record {}[]? - Array of subfields for complex field types (address, monetary), null for simple field types
- fieldCode string - The unique identifier for the field (40-character hash for custom fields)
- options? record {}[]? - Array of available options for enum/set fields, null for other field types
- description? string - The description of the field
- isCustomField boolean - Whether this is a user-created custom field
- fieldType string - The type of the field
- fieldName string - The display name/label of the field
pipedrive: DeleteDealProductResponse
Fields
- data? DeleteDealProductResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteDealProductResponseData
Fields
- id? int - The ID of an attached product that was deleted from the deal
pipedrive: DeleteDealResponse
Fields
- data? DeleteDealResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteDealResponseData
Fields
- id? int - Deleted deal ID
pipedrive: DeleteFieldOptionsRequest
Fields
- id int - The unique identifier of the option to delete
pipedrive: DeleteFieldResponse
Fields
- data? DeleteFieldResponseData -
- success? boolean - Whether the request was successful
pipedrive: DeleteFieldResponseData
Fields
- isOptionalResponseField boolean - Whether this field is not returned by default in entity responses
- subfields? record {}[]? - Array of subfields for complex field types (address, monetary), null for simple field types
- fieldCode string - The unique identifier for the field (40-character hash for custom fields)
- options? record {}[]? - Array of available options for enum/set fields, null for other field types
- isCustomField boolean - Whether this is a user-created custom field
- fieldType string - The type of the field
- fieldName string - The display name/label of the field
pipedrive: DeleteFollowerResponse
Fields
- data? DeleteFollowerResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteFollowerResponseData
Fields
- userId? int - Deleted follower user ID
pipedrive: DeleteInstallmentResponse
Fields
- data? DeleteInstallmentResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteInstallmentResponseData
Fields
- id? int - The ID of the installment that was deleted from the deal
pipedrive: DeleteManyDealProductResponse
Fields
- additionalData? DeleteManyDealProductResponseAdditionalData? -
- success? boolean - If the response is successful or not
pipedrive: DeleteManyDealProductResponseAdditionalData
Fields
- moreItemsInCollection? boolean - Whether there are more products to delete (when the deal has more than 100 products)
pipedrive: DeleteManyDealProductResponseData
Fields
- ids? int[] - Array of IDs of products that were deleted from the deal
pipedrive: DeleteManyDealProductsQueries
Represents the Queries record for the operation: deleteManyDealProducts
Fields
- ids? int[] - Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed
pipedrive: DeleteOrganizationResponse
Fields
- data? DeleteOrganizationResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteOrganizationResponseData
Fields
- id? int - Deleted organization ID
pipedrive: DeletePersonResponse
Fields
- data? DeletePersonResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeletePersonResponseData
Fields
- id? int - Deleted person ID
pipedrive: DeletePipelineResponse
Fields
- data? DeletePipelineResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeletePipelineResponseData
Fields
- id? int - Deleted Pipeline ID
pipedrive: DeleteProductImageResponse
Fields
- data? DeleteProductImageResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteProductImageResponseData
Fields
- id? int - The ID of the image that was deleted from the product
pipedrive: DeleteProductResponse
Fields
- data? DeleteProductResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteProductResponseData
Fields
- id? int - The ID of the removed product
pipedrive: DeleteProductVariationResponse
Fields
- success? boolean - If the response is successful or not
pipedrive: DeleteProductVariationResponseData
Fields
- id? int - The ID of a deleted product variant
pipedrive: DeleteProjectBoardResponse
Fields
- data? DeleteProjectBoardResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteProjectBoardResponseData
Fields
- id? int - The ID of the deleted project board
pipedrive: DeleteProjectFieldResponse
Fields
- data? DeleteProjectFieldResponseData -
- success? boolean - Whether the request was successful
pipedrive: DeleteProjectFieldResponseData
Fields
- isOptionalResponseField boolean - Whether this field is not returned by default in entity responses
- subfields? record {}[]? - Array of subfields for complex field types, null for simple field types
- fieldCode string - The unique identifier for the field (40-character hash for custom fields)
- options? record {}[]? - Array of available options for enum/set fields, null for other field types
- isCustomField boolean - Whether this is a user-created custom field
- fieldType string - The type of the field
- fieldName string - The display name/label of the field
pipedrive: DeleteProjectPhaseResponse
Fields
- data? DeleteProjectPhaseResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteProjectPhaseResponseData
Fields
- id? int - The ID of the deleted project phase
pipedrive: DeleteProjectResponse
Fields
- data? DeleteProjectResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteProjectResponseData
Fields
- id? int - The ID of the deleted project
pipedrive: DeleteStageResponse
Fields
- data? DeleteStageResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteStageResponseData
Fields
- id? int - Deleted stage ID
pipedrive: DeleteTaskResponse
Fields
- additionalData? record {}? -
- data? DeleteTaskResponseData -
- success? boolean - If the response is successful or not
pipedrive: DeleteTaskResponseData
Fields
- id? int - The ID of the deleted task
pipedrive: FieldOptionsResponse
Fields
- additionalData? record {}? -
- data? FieldOptionsResponseData[] -
- success? boolean -
pipedrive: FieldOptionsResponseData
Fields
- id int - The unique identifier of the option
- label string - The display label of the option
pipedrive: FollowerChangelogItem
Fields
- actorUserId? int - The ID of the user who did the change
- followerUserId? int - The ID of the user who was following the entity
- action? string - The type of change
- time? string - The time at which the change happened
pipedrive: GetActivitiesQueries
Represents the Queries record for the operation: getActivities
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- ownerId? int - If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored
- sortBy "id"|"update_time"|"add_time"|"due_date" (default "id") - The field to sort by. Supported fields:
id,update_time,add_time,due_date
- done? boolean - If supplied, only activities with specified 'done' flag value are returned
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- filterId? int - If supplied, only activities matching the specified filter are returned
- orgId? int - If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored
- updatedUntil? string - If set, only activities with an
update_timeearlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- updatedSince? string - If set, only activities with an
update_timelater than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- 'limit? int - 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
- ids? string[] - Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response
- includeFields? ("attendees")[] - Optional comma separated string array of additional fields to include
- dealId? int - If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored
- leadId? string - If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored
- personId? int - If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored
pipedrive: GetActivitiesResponse
Fields
- Fields Included from *BaseResponse
- success boolean
- anydata...
- Fields Included from *GetActivitiesResponseContent
- additionalData GetActivitiesResponseAdditionalData
- data GetActivitiesResponseData[]
- anydata...
pipedrive: GetActivitiesResponseAdditionalData
The additional data of the list
Fields
- nextCursor? string? - The first item on the next page. The value of the
next_cursorfield will benullif you have reached the end of the dataset and there’s no more pages to be returned
pipedrive: GetActivitiesResponseContent
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? GetActivitiesResponseData[] - Activities array
pipedrive: GetActivitiesResponseData
Fields
- dueTime? string? - The due time of the activity
- note? string - The note of the activity
- publicDescription? string - The public description of the activity
- subject? string - The subject of the activity
- ownerId? int - The ID of the user who owns the activity
- 'type? string - The type of the activity
- duration? string? - The duration of the activity
- updateTime? string - The last updated date and time of the activity
- isDeleted? boolean - Whether the activity is deleted or not
- projectId? int? - The ID of the project linked to the activity
- busy? boolean - Whether the activity marks the assignee as busy or not in their calendar
- id? int - The ID of the activity
- conferenceMeetingId? string - The ID of the conference meeting
- dealId? int? - The ID of the deal linked to the activity
- leadId? string? - The ID of the lead linked to the activity
- outcome? int? - The ID of the Outcome for the activity. The available Outcome values depend on the activity type and can be retrieved using the Activity Fields API
- personId? int? - The ID of the person linked to the activity
- participants? AddActivityParticipants[] - The participants of the activity
- creatorUserId? int - The ID of the user who created the activity
- attendees? AddActivityAttendees[] - The attendees of the activity
- dueDate? string - The due date of the activity
- priority? int - The priority of the activity. Mappable to a specific string using activityFields API
- done? boolean - Whether the activity is marked as done or not
- markedAsDoneTime? string? - The date and time when the activity was marked as done
- orgId? int? - The ID of the organization linked to the activity
- conferenceMeetingUrl? string - The URL of the conference meeting
- location? ActivityItemLocation? - Location of the activity
- conferenceMeetingClient? string - The client used for the conference meeting
- addTime? string - The creation date and time of the activity
pipedrive: GetActivityFieldQueries
Represents the Queries record for the operation: getActivityField
Fields
- includeFields? ("ui_visibility")[] - Optional comma separated string array of additional data namespaces to include in response
pipedrive: GetActivityFieldResponse
Fields
- data? GetActivityFieldsResponseData -
- success? boolean - Whether the request was successful
pipedrive: GetActivityFieldsQueries
Represents the Queries record for the operation: getActivityFields
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
- includeFields? ("ui_visibility")[] - Optional comma separated string array of additional data namespaces to include in response
pipedrive: GetActivityFieldsResponse
Fields
- additionalData? GetActivityFieldsResponseAdditionalData -
- data? GetActivityFieldsResponseData[] -
- success? boolean - Whether the request was successful
pipedrive: GetActivityFieldsResponseAdditionalData
Fields
- nextCursor? string? - Base64url-encoded cursor for fetching the next page of results, null if no more pages
pipedrive: GetActivityFieldsResponseData
Fields
- isOptionalResponseField boolean - Whether this field is not returned by default in entity responses
- subfields? GetActivityFieldsResponseSubfields[]? - Array of subfields for complex field types (address, monetary), null for simple field types
- fieldCode string - The unique identifier for the field (40-character hash for custom fields)
- options? GetActivityFieldsResponseOptions[]? - Array of available options for enum/set fields, null for other field types
- isCustomField boolean - Whether this is a user-created custom field
- fieldType "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"|"participants"|"attendees" - The type of the field
- uiVisibility? GetActivityFieldsResponseUiVisibility -
- fieldName string - The display name/label of the field
pipedrive: GetActivityFieldsResponseOptions
Fields
- updateTime? string? - When the option was last updated
- color? string? - Optional color code for the option
- label? string - The option display label
- addTime? string? - When the option was created
pipedrive: GetActivityFieldsResponseSubfields
Fields
- fieldCode? string - The subfield identifier
- fieldType? string - The subfield type
- fieldName? string - The subfield display name
pipedrive: GetActivityFieldsResponseUiVisibility
UI visibility settings (only included when requested via include_fields parameter)
Fields
- detailsVisibleFlag? boolean - Whether the field is shown in the details view (read-only)
- addVisibleFlag? boolean - Whether the field is shown in the add modal
pipedrive: GetActivityQueries
Represents the Queries record for the operation: getActivity
Fields
- includeFields? ("attendees")[] - Optional comma separated string array of additional fields to include
pipedrive: GetAdditionalDiscountsResponse
Fields
- data? GetAdditionalDiscountsResponseData[] - Array containing data for all discounts added to a deal
- success? boolean - If the response is successful or not
pipedrive: GetAdditionalDiscountsResponseData
Fields
- amount? decimal - The discount amount
- updatedAt? string - The date and time of when the discount was created in the ISO 8601 format
- updatedBy? int - The ID of the user that last updated the discount
- description? string - The name of the discount
- createdAt? string - The date and time of when the discount was created in the ISO 8601 format
- id? string - The ID of the additional discount
- 'type? "percentage"|"amount" - Determines whether the discount is applied as a percentage or a fixed amount
- dealId? int - The ID of the deal the discount was added to
- createdBy? int - The ID of the user that created the discount
pipedrive: GetArchivedDealsQueries
Represents the Queries record for the operation: getArchivedDeals
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- ownerId? int - If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored
- stageId? int - If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored
- customFields? string[] - 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.<br/>A maximum of 15 keys is allowed
- sortBy "id"|"update_time"|"add_time" (default "id") - The field to sort by. Supported fields:
id,update_time,add_time
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- filterId? int - If supplied, only deals matching the specified filter are returned
- orgId? int - If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored
- updatedUntil? string - If set, only deals with an
update_timeearlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- pipelineId? int - If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored
- updatedSince? string - If set, only deals with an
update_timelater than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- 'limit? int - 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
- ids? string[] - Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response
- includeFields? ("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")[] - Optional comma separated string array of additional fields to include
- personId? int - If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored
- status? ("open"|"won"|"lost"|"deleted")[] - Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored
pipedrive: GetArchivedProjectsQueries
Represents the Queries record for the operation: getArchivedProjects
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- filterId? int - If supplied, only projects matching the specified filter are returned
- 'limit? int - 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
- phaseId? int - If supplied, only projects in the specified phase are returned
- status? string - If supplied, includes only projects with the specified statuses. Possible values are
open,completed,canceledanddeleted. By defaultdeletedprojects are not returned
pipedrive: GetDealFieldQueries
Represents the Queries record for the operation: getDealField
Fields
- includeFields? ("ui_visibility"|"important_fields"|"required_fields")[] - Optional comma separated string array of additional data namespaces to include in response
pipedrive: GetDealFieldsQueries
Represents the Queries record for the operation: getDealFields
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
- includeFields? ("ui_visibility"|"important_fields"|"required_fields")[] - Optional comma separated string array of additional data namespaces to include in response
pipedrive: GetDealFieldsResponse
Fields
- additionalData? GetActivityFieldsResponseAdditionalData -
- data? GetDealFieldsResponseData[] -
- success? boolean - Whether the request was successful
pipedrive: GetDealFieldsResponseData
Fields
- isOptionalResponseField boolean - Whether this field is not returned by default in entity responses
- requiredFields? GetDealFieldsResponseRequiredFields -
- subfields? GetActivityFieldsResponseSubfields[]? - Array of subfields for complex field types (address, monetary), null for simple field types
- fieldCode string - The unique identifier for the field (40-character hash for custom fields)
- options? GetActivityFieldsResponseOptions[]? - Array of available options for enum/set fields, null for other field types
- importantFields? GetDealFieldsResponseImportantFields -
- description? string - The description of the field
- isCustomField boolean - Whether this is a user-created custom field
- fieldType "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" - The type of the field
- uiVisibility? GetDealFieldsResponseUiVisibility -
- fieldName string - The display name/label of the field
pipedrive: GetDealFieldsResponseImportantFields
Important fields configuration
Fields
- stageIds? int[] - Array of stage IDs where the field is important
- enabled? boolean - Whether the field is marked as important
pipedrive: GetDealFieldsResponseRequiredFields
Required fields configuration
Fields
- stageIds? int[] - Array of stage IDs where the field is required
- statuses? record { ("won"|"lost")[]... } - Pipeline-specific status requirements, mapping pipeline ID to array of statuses
- enabled? boolean - Whether the field is required
pipedrive: GetDealFieldsResponseUiVisibility
UI visibility settings (only included when requested via include_fields parameter)
Fields
- detailsVisibleFlag? boolean - Whether the field is shown in the details view
- projectsDetailVisibleFlag? boolean - Whether the field is shown in project details view
- addVisibleFlag? boolean - Whether the field is shown in the add modal
- showInPipelines? GetDealFieldsResponseUiVisibilityShowInPipelines -
pipedrive: GetDealFieldsResponseUiVisibilityShowInPipelines
Pipeline visibility configuration
Fields
- showInAll? boolean - Whether the field is shown in all pipelines
- pipelineIds? int[] - Specific pipeline IDs where the field is shown (if show_in_all is false)
pipedrive: GetDealFollowersChangelogQueries
Represents the Queries record for the operation: getDealFollowersChangelog
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetDealFollowersQueries
Represents the Queries record for the operation: getDealFollowers
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetDealProductsQueries
Represents the Queries record for the operation: getDealProducts
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- 'limit? int - 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
- sortBy "id"|"add_time"|"update_time"|"order_nr" (default "id") - The field to sort by. Supported fields:
id,add_time,update_time,order_nr
pipedrive: GetDealQueries
Represents the Queries record for the operation: getDeal
Fields
- includeLabels? boolean - When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
- customFields? string[] - 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.<br/>A maximum of 15 keys is allowed
- includeOptionLabels? boolean - 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
- includeFields? ("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")[] - Optional comma separated string array of additional fields to include
pipedrive: GetDealSearchResponse
Fields
- Fields Included from *GetDealSearchResponseBase
- success boolean
- anydata...
- Fields Included from *GetDealSearchResponseContent
- additionalData GetDealsProductsResponseAdditionalData
- data GetDealSearchResponseData
- anydata...
pipedrive: GetDealSearchResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetDealSearchResponseContent
Fields
- additionalData? GetDealsProductsResponseAdditionalData -
- data? GetDealSearchResponseData -
pipedrive: GetDealSearchResponseData
Fields
- items? GetDealSearchResponseDataItems[] - The array of deals
pipedrive: GetDealSearchResponseDataItem
Fields
- owner? GetDealSearchResponseDataItemOwner -
- notes? string[] - An array of notes
- customFields? string[] - Custom fields
- 'type? string - The type of the item
- title? string - The title of the deal
- stage? GetDealSearchResponseDataItemStage -
- isArchived? boolean - A flag indicating whether the deal is archived or not
- visibleTo? int - The visibility of the deal
- person? GetDealSearchResponseDataItemPerson? -
- organization? GetDealSearchResponseDataItemOrganization? -
- currency? string - The currency of the deal
- id? int - The ID of the deal
- value? decimal? - The value of the deal
- status? string - The status of the deal
pipedrive: GetDealSearchResponseDataItemOrganization
Fields
- name? string - The name of the organization the deal is associated with
- id? int - The ID of the organization the deal is associated with
pipedrive: GetDealSearchResponseDataItemOwner
Fields
- id? int - The ID of the owner of the deal
pipedrive: GetDealSearchResponseDataItemPerson
Fields
- name? string - The name of the person the deal is associated with
- id? int - The ID of the person the deal is associated with
pipedrive: GetDealSearchResponseDataItems
Fields
- item? GetDealSearchResponseDataItem -
- resultScore? decimal - Search result relevancy
pipedrive: GetDealSearchResponseDataItemStage
Fields
- name? string - The name of the stage of the deal
- id? int - The ID of the stage of the deal
pipedrive: GetDealsProductsQueries
Represents the Queries record for the operation: getDealsProducts
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- 'limit? int - 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
- dealIds int[] - An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided
- sortBy "id"|"deal_id"|"add_time"|"update_time"|"order_nr" (default "id") - The field to sort by. Supported fields:
id,deal_id,add_time,update_time,order_nr
pipedrive: GetDealsProductsResponse
Fields
- additionalData? GetDealsProductsResponseAdditionalData -
- data? GetDealsProductsResponseData[] - Array containing data for all products attached to deals
- success? boolean - If the response is successful or not
pipedrive: GetDealsProductsResponseAdditionalData
Pagination related data
Fields
- nextCursor? string? - The first item on the next page. The value of the
next_cursorfield will benullif you have reached the end of the dataset and there’s no more pages to be returned
pipedrive: GetDealsProductsResponseData
Fields
- Fields Included from *GetDealsProductsResponseDataPart1
- comments string
- quantity decimal
- itemPrice decimal
- orderNr int|()
- discount decimal
- sum decimal
- tax decimal
- productVariationId int|()
- discountType "percentage"|"amount"
- taxMethod "exclusive"|"inclusive"|"none"
- isEnabled boolean
- updateTime string
- productId int
- name string
- currency string
- id int
- dealId int
- addTime string
- anydata...
- Fields Included from *GetDealsProductsResponseDataPart2
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly"
- anydata...
- Fields Included from *GetDealsProductsResponseDataPart3
- billingFrequencyCycles int|()
- anydata...
- Fields Included from *GetDealsProductsResponseDataPart4
- billingStartDate string|()
- anydata...
pipedrive: GetDealsProductsResponseDataPart1
Fields
- comments? string - The comments of the product
- quantity? decimal - The quantity of the product
- itemPrice? decimal - The price value of the product
- orderNr? int? - The order number of the product within the deal
- discount decimal(default 0) - The value of the discount. The
discount_typefield can be used to specify whether the value is an amount or a percentage
- sum? decimal - The sum of all the products attached to the deal
- tax? decimal - The product tax
- productVariationId? int? - The ID of the product variation
- discountType "percentage"|"amount" (default "percentage") - The type of the discount's value
- taxMethod? "exclusive"|"inclusive"|"none" - The tax option to be applied to the products. When using
inclusive, the tax percentage will already be included in the price. When usingexclusive, the tax will not be included in the price. When usingnone, no tax will be added. Use thetaxfield for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal
- isEnabled boolean(default true) - Whether this product is enabled for the deal
- updateTime? string - The date and time when the deal product was last updated
- productId? int - The ID of the product
- name? string - The product name
- currency? string - The currency associated with the deal product
- id? int - The ID of the deal-product (the ID of the product attached to the deal)
- dealId? int - The ID of the deal
- addTime? string - The date and time when the product was added to the deal
pipedrive: GetDealsProductsResponseDataPart2
Fields
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" (default "one-time") - Only available in Growth and above plans
How often a customer is billed for access to a service or product
To set
billing_frequencydifferent thanone-time, the deal must not have installments associated A deal can have up to 20 products attached withbilling_frequencydifferent thanone-time
pipedrive: GetDealsProductsResponseDataPart3
Fields
- billingFrequencyCycles? int? - Only available in Growth and above plans
The number of times the billing frequency repeats for a product in a deal
When
billing_frequencyis set toone-time, this field must benullWhenbilling_frequencyis set toweekly, this field cannot benullFor all the other values ofbilling_frequency,nullrepresents a product billed indefinitely Must be a positive integer less or equal to 208
pipedrive: GetDealsProductsResponseDataPart4
Fields
- billingStartDate? string? - Only available in Growth and above plans The billing start date. Must be between 10 years in the past and 10 years in the future
pipedrive: GetDealsQueries
Represents the Queries record for the operation: getDeals
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- includeLabels? boolean - When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
- ownerId? int - If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored
- stageId? int - If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored
- customFields? string[] - 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.<br/>A maximum of 15 keys is allowed
- sortBy "id"|"update_time"|"add_time" (default "id") - The field to sort by. Supported fields:
id,update_time,add_time
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- filterId? int - If supplied, only deals matching the specified filter are returned
- orgId? int - If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored
- updatedUntil? string - If set, only deals with an
update_timeearlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- pipelineId? int - If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored
- updatedSince? string - If set, only deals with an
update_timelater than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- 'limit? int - 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
- ids? string[] - Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response
- includeOptionLabels? boolean - 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
- includeFields? ("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")[] - Optional comma separated string array of additional fields to include
- personId? int - If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored
- status? ("open"|"won"|"lost"|"deleted")[] - Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored
pipedrive: GetDealsResponse
Fields
- Fields Included from *GetDealsResponseBase
- success boolean
- anydata...
- Fields Included from *GetDealsResponseContent
- additionalData GetActivitiesResponseAdditionalData
- data GetDealsResponseData[]
- anydata...
pipedrive: GetDealsResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetDealsResponseContent
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? GetDealsResponseData[] - Deals array
pipedrive: GetDealsResponseData
Fields
- ownerId? int - The ID of the user who owns the deal
- origin? string - The way this Deal was created.
originfield is set by Pipedrive when Deal is created and cannot be changed
- channel? int? - The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href="https://app.pipedrive.com/settings/fields" target="_blank" rel="noopener noreferrer">Company settings</a>
- originId? string? - The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal
- sourceLeadId? string? - The ID of the lead if the deal was converted from a lead. Only included when requested via include_fields parameter
- title? string - The title of the deal
- updateTime? string? - The last updated date and time of the deal
- isDeleted? boolean - Whether the deal is deleted or not
- acv? decimal? - Only available in Growth and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal
- pipelineId? int - The ID of the pipeline associated with the deal
- lostTime? string? - The date and time of changing the deal status as lost
- currency? string - The currency associated with the deal
- id? int - The ID of the deal
- value? decimal - The value of the deal
- personId? int? - The ID of the person linked to the deal
- arr? decimal? - Only available in Growth and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal
- expectedCloseDate? string? - The expected close date of the deal
- stageId? int - The ID of the deal stage
- probability? decimal? - The success probability percentage of the deal
- labelIds? int[] - The IDs of labels assigned to the deal
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- closeTime? string? - The date and time of closing the deal
- mrr? decimal? - Only available in Growth and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal
- lostReason? string? - The reason for losing the deal
- wonTime? string? - The date and time of changing the deal status as won
- isArchived? boolean - Whether the deal is archived or not
- visibleTo? int - The visibility of the deal
- orgId? int? - The ID of the organization linked to the deal
- stageChangeTime? string? - The last updated date and time of the deal stage
- addTime? string - The creation date and time of the deal
- channelId? string? - The optional ID to further distinguish the Marketing channel
- status? string - The status of the deal
pipedrive: GetFollowerChangelogsResponse
Fields
- Fields Included from *GetFollowerChangelogsResponseBase
- success boolean
- anydata...
- Fields Included from *GetFollowerChangelogsResponseContent
- additionalData GetActivitiesResponseAdditionalData
- data FollowerChangelogItem[]
- anydata...
pipedrive: GetFollowerChangelogsResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetFollowerChangelogsResponseContent
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? FollowerChangelogItem[] - Follower changelogs array
pipedrive: GetFollowersResponse
Fields
- Fields Included from *GetFollowersResponseBase
- success boolean
- anydata...
- Fields Included from *GetFollowersResponseContent
- additionalData GetActivitiesResponseAdditionalData
- data GetFollowersResponseData[]
- anydata...
pipedrive: GetFollowersResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetFollowersResponseContent
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? GetFollowersResponseData[] - Followers array
pipedrive: GetFollowersResponseData
Fields
- userId? int - The ID of the user following the entity
- addTime? string - The add time of the following
pipedrive: GetInstallmentsQueries
Represents the Queries record for the operation: getInstallments
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- 'limit? int - 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
- dealIds int[] - An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided
- sortBy "id"|"billing_date"|"deal_id" (default "id") - The field to sort by. Supported fields:
id,billing_date,deal_id
pipedrive: GetInstallmentsResponse
Fields
- data? GetInstallmentsResponseData[] - Array containing data for all installments added to a deal
- success? boolean - If the response is successful or not
pipedrive: GetInstallmentsResponseData
Fields
- amount? decimal - The installment amount
- description? string - The name of installment
- id? int - The ID of the installment
- billingDate? string - The date on which the installment will be charged
- dealId? int - The ID of the deal the installment was added to
pipedrive: GetItemSearchFieldResponse
Fields
- Fields Included from *GetItemSearchFieldResponseBase
- success boolean
- anydata...
- Fields Included from *GetItemSearchFieldResponseContent
- additionalData GetDealsProductsResponseAdditionalData
- data ItemSearchItem[]
- anydata...
pipedrive: GetItemSearchFieldResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetItemSearchFieldResponseContent
Fields
- additionalData? GetDealsProductsResponseAdditionalData -
- data? ItemSearchItem[] - The array of found fields
pipedrive: GetItemSearchResponse
Fields
- Fields Included from *GetItemSearchResponseBase
- success boolean
- anydata...
- Fields Included from *GetItemSearchResponseData1
- additionalData GetDealsProductsResponseAdditionalData
- data GetItemSearchResponseData
- anydata...
pipedrive: GetItemSearchResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetItemSearchResponseData
Fields
- relatedItems? ItemSearchItem[] - The array of related items if
search_for_related_itemswas enabled
- items? ItemSearchItem[] - The array of found items
pipedrive: GetItemSearchResponseData1
Fields
- additionalData? GetDealsProductsResponseAdditionalData -
- data? GetItemSearchResponseData -
pipedrive: GetLeadSearchResponse
Fields
- Fields Included from *GetLeadSearchResponseBase
- success boolean
- anydata...
- Fields Included from *GetLeadSearchResponseData1
- additionalData GetDealsProductsResponseAdditionalData
- data GetLeadSearchResponseData
- anydata...
pipedrive: GetLeadSearchResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetLeadSearchResponseData
Fields
- items? LeadSearchItem[] - The array of leads
pipedrive: GetLeadSearchResponseData1
Fields
- additionalData? GetDealsProductsResponseAdditionalData -
- data? GetLeadSearchResponseData -
pipedrive: GetLeadSearchResponseDataItem
Fields
- owner? GetLeadSearchResponseDataItemOwner -
- notes? string[] - An array of notes
- customFields? string[] - Custom fields
- phones? string[] -
- 'type? string - The type of the item
- title? string - The title of the lead
- emails? string[] -
- isArchived? boolean - A flag indicating whether the lead is archived or not
- visibleTo? int - The visibility of the lead
- person? GetLeadSearchResponseDataItemPerson? -
- organization? GetLeadSearchResponseDataItemOrganization -
- currency? string - The currency of the lead
- id? string - The ID of the lead
- value? int - The value of the lead
pipedrive: GetLeadSearchResponseDataItemOrganization
Fields
- name? string - The name of the organization the lead is associated with
- id? int - The ID of the organization the lead is associated with
pipedrive: GetLeadSearchResponseDataItemOwner
Fields
- id? int - The ID of the owner of the lead
pipedrive: GetLeadSearchResponseDataItemPerson
Fields
- name? string - The name of the person the lead is associated with
- id? int - The ID of the person the lead is associated with
pipedrive: GetOrganizationFieldQueries
Represents the Queries record for the operation: getOrganizationField
Fields
- includeFields? ("ui_visibility"|"important_fields"|"required_fields")[] - Optional comma separated string array of additional data namespaces to include in response
pipedrive: GetOrganizationFieldsQueries
Represents the Queries record for the operation: getOrganizationFields
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
- includeFields? ("ui_visibility"|"important_fields"|"required_fields")[] - Optional comma separated string array of additional data namespaces to include in response
pipedrive: GetOrganizationFieldsResponse
Fields
- additionalData? GetActivityFieldsResponseAdditionalData -
- data? GetOrganizationFieldsResponseData[] -
- success? boolean - Whether the request was successful
pipedrive: GetOrganizationFieldsResponseData
Fields
- isOptionalResponseField boolean - Whether this field is not returned by default in entity responses
- requiredFields? GetPersonFieldsResponseRequiredFields -
- subfields? GetActivityFieldsResponseSubfields[]? - Array of subfields for complex field types (address, monetary), null for simple field types
- fieldCode string - The unique identifier for the field (40-character hash for custom fields)
- options? GetActivityFieldsResponseOptions[]? - Array of available options for enum/set fields, null for other field types
- importantFields? GetPersonFieldsResponseImportantFields -
- isCustomField boolean - Whether this is a user-created custom field
- fieldType "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" - The type of the field
- uiVisibility? GetOrganizationFieldsResponseUiVisibility -
- fieldName string - The display name/label of the field
pipedrive: GetOrganizationFieldsResponseUiVisibility
UI visibility settings (only included when requested via include_fields parameter)
Fields
- showInAddPersonDialog? GetOrganizationFieldsResponseUiVisibilityShowInAddPersonDialog -
- detailsVisibleFlag? boolean - Whether the field is shown in the details view
- addVisibleFlag? boolean - Whether the field is shown in the add modal
- orgDetailVisibleFlag? boolean - Whether the field is shown in the organization details view
- dealDetailVisibleFlag? boolean - Whether the field is shown in the deal details view
- showInAddDealDialog? GetPersonFieldsResponseUiVisibilityShowInAddDealDialog -
- personDetailVisibleFlag? boolean - Whether the field is shown in the person details view
pipedrive: GetOrganizationFieldsResponseUiVisibilityShowInAddPersonDialog
Configuration for showing the field in the add person dialog
Fields
- show? boolean - Whether the field is shown in the add person dialog
- 'order? int? - Display order in the add person dialog (null if not shown)
pipedrive: GetOrganizationFollowersChangelogQueries
Represents the Queries record for the operation: getOrganizationFollowersChangelog
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetOrganizationFollowersQueries
Represents the Queries record for the operation: getOrganizationFollowers
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetOrganizationQueries
Represents the Queries record for the operation: getOrganization
Fields
- includeLabels? boolean - When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
- customFields? string[] - 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.<br/>A maximum of 15 keys is allowed
- includeOptionLabels? boolean - 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
- includeFields? ("next_activity_id"|"last_activity_id"|"open_deals_count"|"related_open_deals_count"|"closed_deals_count"|"related_closed_deals_count"|"email_messages_count"|"people_count"|"activities_count"|"done_activities_count"|"undone_activities_count"|"files_count"|"notes_count"|"followers_count"|"won_deals_count"|"related_won_deals_count"|"lost_deals_count"|"related_lost_deals_count"|"smart_bcc_email")[] - Optional comma separated string array of additional fields to include
pipedrive: GetOrganizationSearchResponse
Fields
- Fields Included from *GetOrganizationSearchResponseBase
- success boolean
- anydata...
- Fields Included from *GetOrganizationSearchResponseContent
- additionalData GetDealsProductsResponseAdditionalData
- data GetOrganizationSearchResponseData
- anydata...
pipedrive: GetOrganizationSearchResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetOrganizationSearchResponseContent
Fields
- additionalData? GetDealsProductsResponseAdditionalData -
pipedrive: GetOrganizationSearchResponseData
Fields
- items? GetOrganizationSearchResponseDataItems[] - The array of found items
pipedrive: GetOrganizationSearchResponseDataItem
Fields
- owner? GetDealSearchResponseDataItemOwner -
- address? string? - The address of the organization
- notes? string[] - An array of notes
- visibleTo? int - The visibility of the organization
- customFields? string[] - Custom fields
- name? string - The name of the organization
- id? int - The ID of the organization
- 'type? string - The type of the item
pipedrive: GetOrganizationSearchResponseDataItems
Fields
- resultScore? decimal - Search result relevancy
pipedrive: GetOrganizationsQueries
Represents the Queries record for the operation: getOrganizations
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- includeLabels? boolean - When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
- ownerId? int - If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored
- customFields? string[] - 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.<br/>A maximum of 15 keys is allowed
- sortBy "id"|"update_time"|"add_time" (default "id") - The field to sort by. Supported fields:
id,update_time,add_time
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- filterId? int - If supplied, only organizations matching the specified filter are returned
- updatedUntil? string - If set, only organizations with an
update_timeearlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- updatedSince? string - If set, only organizations with an
update_timelater than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- 'limit? int - 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
- ids? string[] - Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response
- includeOptionLabels? boolean - 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
- includeFields? ("next_activity_id"|"last_activity_id"|"open_deals_count"|"related_open_deals_count"|"closed_deals_count"|"related_closed_deals_count"|"email_messages_count"|"people_count"|"activities_count"|"done_activities_count"|"undone_activities_count"|"files_count"|"notes_count"|"followers_count"|"won_deals_count"|"related_won_deals_count"|"lost_deals_count"|"related_lost_deals_count"|"smart_bcc_email")[] - Optional comma separated string array of additional fields to include
pipedrive: GetOrganizationsResponse
Fields
- Fields Included from *GetOrganizationsResponseBase
- success boolean
- anydata...
- Fields Included from *GetOrganizationsResponseContent
- additionalData GetActivitiesResponseAdditionalData
- data GetOrganizationsResponseData[]
- anydata...
pipedrive: GetOrganizationsResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetOrganizationsResponseContent
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? GetOrganizationsResponseData[] - Organizations array
pipedrive: GetOrganizationsResponseData
Fields
- employeeCount? int? - The number of employees in the organization
- website? string? - The website of the organization
- address? OrganizationItemAddress? - The address of the organization
- ownerId? int - The ID of the user who owns the organization
- labelIds? int[] - The IDs of labels assigned to the organization
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- industry? int? - The industry the organization belongs to
- linkedin? string? - The LinkedIn profile URL of the organization
- updateTime? string? - The last updated date and time of the organization
- isDeleted? boolean - Whether the organization is deleted or not
- visibleTo? int - The visibility of the organization
- name? string - The name of the organization
- id? int - The ID of the organization
- addTime? string - The creation date and time of the organization
- annualRevenue? int? - The annual revenue of the organization
pipedrive: GetPersonFieldQueries
Represents the Queries record for the operation: getPersonField
Fields
- includeFields? ("ui_visibility"|"important_fields"|"required_fields")[] - Optional comma separated string array of additional data namespaces to include in response
pipedrive: GetPersonFieldsQueries
Represents the Queries record for the operation: getPersonFields
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
- includeFields? ("ui_visibility"|"important_fields"|"required_fields")[] - Optional comma separated string array of additional data namespaces to include in response
pipedrive: GetPersonFieldsResponse
Fields
- additionalData? GetActivityFieldsResponseAdditionalData -
- data? GetPersonFieldsResponseData[] -
- success? boolean - Whether the request was successful
pipedrive: GetPersonFieldsResponseData
Fields
- isOptionalResponseField boolean - Whether this field is not returned by default in entity responses
- requiredFields? GetPersonFieldsResponseRequiredFields -
- subfields? GetActivityFieldsResponseSubfields[]? - Array of subfields for complex field types (address, monetary), null for simple field types
- fieldCode string - The unique identifier for the field (40-character hash for custom fields)
- options? GetActivityFieldsResponseOptions[]? - Array of available options for enum/set fields, null for other field types
- importantFields? GetPersonFieldsResponseImportantFields -
- isCustomField boolean - Whether this is a user-created custom field
- fieldType "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" - The type of the field
- uiVisibility? GetPersonFieldsResponseUiVisibility -
- fieldName string - The display name/label of the field
pipedrive: GetPersonFieldsResponseImportantFields
Important fields configuration
Fields
- stageIds? int[] - Array of deal stage IDs where the field is important
- enabled? boolean - Whether the field is marked as important
pipedrive: GetPersonFieldsResponseRequiredFields
Required fields configuration
Fields
- enabled? boolean - Whether the field is required
pipedrive: GetPersonFieldsResponseUiVisibility
UI visibility settings (only included when requested via include_fields parameter)
Fields
- detailsVisibleFlag? boolean - Whether the field is shown in the details view
- addVisibleFlag? boolean - Whether the field is shown in the add modal
- showInAddDealDialog? GetPersonFieldsResponseUiVisibilityShowInAddDealDialog -
pipedrive: GetPersonFieldsResponseUiVisibilityShowInAddDealDialog
Configuration for showing the field in the add deal dialog
Fields
- show? boolean - Whether the field is shown in the add deal dialog
- 'order? int? - Display order in the add deal dialog (null if not shown)
pipedrive: GetPersonFollowersChangelogQueries
Represents the Queries record for the operation: getPersonFollowersChangelog
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetPersonFollowersQueries
Represents the Queries record for the operation: getPersonFollowers
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetPersonPictureResponse
Fields
- data? GetPersonPictureResponseData -
- success? boolean - If the response is successful or not
pipedrive: GetPersonPictureResponseData
Fields
- addedByUserId? int - The ID of the user who added the picture
- itemId? int - The ID of the person this picture belongs to
- itemType? string - The type of item the picture is associated with
- activeFlag? boolean - Whether the picture is active or not
- id? int - The ID of the picture
- fileSize? int - The file size in bytes
- pictures? GetPersonPictureResponseDataPictures - Picture URLs indexed by size
pipedrive: GetPersonPictureResponseDataPictures
Picture URLs indexed by size
Fields
- param512? string - The URL of the 512x512 picture
- param128? string - The URL of the 128x128 picture
pipedrive: GetPersonQueries
Represents the Queries record for the operation: getPerson
Fields
- includeLabels? boolean - When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
- customFields? string[] - 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.<br/>A maximum of 15 keys is allowed
- includeOptionLabels? boolean - 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
- includeFields? ("next_activity_id"|"last_activity_id"|"open_deals_count"|"related_open_deals_count"|"closed_deals_count"|"related_closed_deals_count"|"participant_open_deals_count"|"participant_closed_deals_count"|"email_messages_count"|"activities_count"|"done_activities_count"|"undone_activities_count"|"files_count"|"notes_count"|"followers_count"|"won_deals_count"|"related_won_deals_count"|"lost_deals_count"|"related_lost_deals_count"|"last_incoming_mail_time"|"last_outgoing_mail_time"|"marketing_status"|"doi_status"|"smart_bcc_email")[] - Optional comma separated string array of additional fields to include.
marketing_statusanddoi_statuscan only be included if the company has marketing app enabled
pipedrive: GetPersonSearchResponse
Fields
- Fields Included from *GetPersonSearchResponseBase
- success boolean
- anydata...
- Fields Included from *GetPersonSearchResponseContent
- additionalData GetDealsProductsResponseAdditionalData
- data GetPersonSearchResponseData
- anydata...
pipedrive: GetPersonSearchResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetPersonSearchResponseContent
Fields
- additionalData? GetDealsProductsResponseAdditionalData -
- data? GetPersonSearchResponseData -
pipedrive: GetPersonSearchResponseData
Fields
- items? GetPersonSearchResponseDataItems[] - The array of found items
pipedrive: GetPersonSearchResponseDataItem
Fields
- emails? string[] - An array of email addresses
- owner? GetPersonSearchResponseDataItemOwner -
- notes? string[] - An array of notes
- visibleTo? int - The visibility of the person
- customFields? string[] - Custom fields
- organization? GetPersonSearchResponseDataItemOrganization -
- name? string - The name of the person
- phones? string[] - An array of phone numbers
- id? int - The ID of the person
- 'type? string - The type of the item
pipedrive: GetPersonSearchResponseDataItemOrganization
Fields
- name? string - The name of the organization the person is associated with
- id? int - The ID of the organization the person is associated with
pipedrive: GetPersonSearchResponseDataItemOwner
Fields
- id? int - The ID of the owner of the person
pipedrive: GetPersonSearchResponseDataItems
Fields
- item? GetPersonSearchResponseDataItem -
- resultScore? decimal - Search result relevancy
pipedrive: GetPersonsQueries
Represents the Queries record for the operation: getPersons
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- includeLabels? boolean - When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
- ownerId? int - If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored
- customFields? string[] - 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.<br/>A maximum of 15 keys is allowed
- sortBy "id"|"update_time"|"add_time" (default "id") - The field to sort by. Supported fields:
id,update_time,add_time
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- filterId? int - If supplied, only persons matching the specified filter are returned
- orgId? int - If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored
- updatedUntil? string - If set, only persons with an
update_timeearlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- updatedSince? string - If set, only persons with an
update_timelater than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- 'limit? int - 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
- ids? string[] - Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response
- includeOptionLabels? boolean - 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
- includeFields? ("next_activity_id"|"last_activity_id"|"open_deals_count"|"related_open_deals_count"|"closed_deals_count"|"related_closed_deals_count"|"participant_open_deals_count"|"participant_closed_deals_count"|"email_messages_count"|"activities_count"|"done_activities_count"|"undone_activities_count"|"files_count"|"notes_count"|"followers_count"|"won_deals_count"|"related_won_deals_count"|"lost_deals_count"|"related_lost_deals_count"|"last_incoming_mail_time"|"last_outgoing_mail_time"|"marketing_status"|"doi_status"|"smart_bcc_email")[] - Optional comma separated string array of additional fields to include.
marketing_statusanddoi_statuscan only be included if the company has marketing app enabled
- dealId? int - If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored
pipedrive: GetPersonsResponse
Fields
- Fields Included from *GetPersonsResponseBase
- success boolean
- anydata...
- Fields Included from *GetPersonsResponseContent
- additionalData GetActivitiesResponseAdditionalData
- data GetPersonsResponseData[]
- anydata...
pipedrive: GetPersonsResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetPersonsResponseContent
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? GetPersonsResponseData[] - Persons array
pipedrive: GetPersonsResponseData
Fields
- postalAddress? PersonItemAddress? -
- birthday? string - The birthday of the person, included if contact sync is enabled for the company
- notes? string - Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company
- im? PersonItemIm[] - The instant messaging accounts of the person, included if contact sync is enabled for the company
- ownerId? int - The ID of the user who owns the person
- labelIds? int[] - The IDs of labels assigned to the person
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- lastName? string - The last name of the person
- phones? PersonItemPhone[] - The phones of the person
- pictureId? int? - The ID of the picture associated with the person
- emails? PersonItemEmail[] - The emails of the person
- updateTime? string? - The last updated date and time of the person
- isDeleted? boolean - Whether the person is deleted or not
- visibleTo? int - The visibility of the person
- orgId? int - The ID of the organization linked to the person
- name? string - The name of the person
- id? int - The ID of the person
- firstName? string - The first name of the person
- addTime? string - The creation date and time of the person
- jobTitle? string - The job title of the person, included if contact sync is enabled for the company
pipedrive: GetPipelinesQueries
Represents the Queries record for the operation: getPipelines
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- 'limit? int - 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
- sortBy "id"|"update_time"|"add_time" (default "id") - The field to sort by. Supported fields:
id,update_time,add_time
pipedrive: GetPipelinesResponse
Fields
- Fields Included from *GetPipelinesResponseBase
- success boolean
- anydata...
- Fields Included from *GetPipelinesResponseContent
- additionalData GetActivitiesResponseAdditionalData
- data GetPipelinesResponseData[]
- anydata...
pipedrive: GetPipelinesResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetPipelinesResponseContent
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? GetPipelinesResponseData[] - Pipelines array
pipedrive: GetPipelinesResponseData
Fields
- updateTime? string - The pipeline update time
- isDeleted? boolean - Whether this pipeline is marked as deleted or not
- orderNr? int - Defines the order of pipelines. The pipeline with the lowest
order_nris considered the default
- name? string - The name of the pipeline
- isDealProbabilityEnabled? boolean - Whether deal probability is disabled or enabled for this pipeline
- id? int - The ID of the pipeline
- addTime? string - The pipeline creation time
pipedrive: GetProductFieldQueries
Represents the Queries record for the operation: getProductField
Fields
- includeFields? ("ui_visibility")[] - Optional comma separated string array of additional data namespaces to include in response
pipedrive: GetProductFieldsQueries
Represents the Queries record for the operation: getProductFields
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
- includeFields? ("ui_visibility")[] - Optional comma separated string array of additional data namespaces to include in response
pipedrive: GetProductFieldsResponse
Fields
- additionalData? GetActivityFieldsResponseAdditionalData -
- data? GetProductFieldsResponseData[] -
- success? boolean - Whether the request was successful
pipedrive: GetProductFieldsResponseData
Fields
- isOptionalResponseField boolean - Whether this field is not returned by default in entity responses
- subfields? GetActivityFieldsResponseSubfields[]? - Array of subfields for complex field types (address, monetary), null for simple field types
- fieldCode string - The unique identifier for the field (40-character hash for custom fields)
- options? GetActivityFieldsResponseOptions[]? - Array of available options for enum/set fields, null for other field types
- isCustomField boolean - Whether this is a user-created custom field
- fieldType "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" - The type of the field
- uiVisibility? GetActivityFieldsResponseUiVisibility -
- fieldName string - The display name/label of the field
pipedrive: GetProductFollowersChangelogQueries
Represents the Queries record for the operation: getProductFollowersChangelog
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetProductFollowersQueries
Represents the Queries record for the operation: getProductFollowers
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetProductImageResponse
Fields
- data? GetProductImageResponseData - The product image data and the respective public URL
- success? boolean - If the response is successful or not
pipedrive: GetProductImageResponseData
The product image data and the respective public URL
Fields
- publicUrl? string - The public URL of the product image
- companyId? string - The ID of the company
- mimeType? string - The MIME type of the product image
- productId? int - The ID of the product associated
- name? string - The name of the product image file
- id? int - The ID of the product image
- addTime? string - The date of image upload
pipedrive: GetProductResponse
Fields
- data? record { id int, name string, code string, unit string, tax decimal, is_deleted boolean, is_linkable boolean, visible_to 1|3|5|7 , owner_id int, add_time string, update_time string, description string, category string?, custom_fields record {}, billing_frequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" , billing_frequency_cycles int?, prices record { price decimal, cost decimal, product_id int?, currency string?, direct_cost decimal?, notes string }[] } -
- success? boolean - If the response is successful or not
pipedrive: GetProductSearchResponse
Fields
- Fields Included from *GetProductSearchResponseBase
- success boolean
- anydata...
- Fields Included from *GetProductSearchResponseContent
- additionalData GetDealsProductsResponseAdditionalData
- data GetProductSearchResponseData
- anydata...
pipedrive: GetProductSearchResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetProductSearchResponseContent
Fields
- additionalData? GetDealsProductsResponseAdditionalData -
- data? GetProductSearchResponseData -
pipedrive: GetProductSearchResponseData
Fields
- items? GetProductSearchResponseDataItems[] - The array of found items
pipedrive: GetProductSearchResponseDataItem
Fields
- code? string? - The code of the product
- visibleTo? int - The visibility of the product
- customFields? string[] - The custom fields
- name? string - The name of the product
- id? int - The ID of the product
- 'type? string - The type of the item
pipedrive: GetProductSearchResponseDataItemOwner
Fields
- id? int - The ID of the owner of the product
pipedrive: GetProductSearchResponseDataItems
Fields
- item? GetProductSearchResponseDataItem -
- resultScore? decimal - Search result relevancy
pipedrive: GetProductsQueries
Represents the Queries record for the operation: getProducts
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- filterId? int - The ID of the filter to use
- ownerId? int - If supplied, only products owned by the given user will be returned
- customFields? string[] - 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.<br/>A maximum of 15 keys is allowed
- 'limit? int - 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
- updatedSince? string - If set, only products with an
update_timelater than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z
- ids? string[] - Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response
- sortBy "id"|"name"|"add_time"|"update_time" (default "id") - The field to sort by. Supported fields:
id,name,add_time,update_time
pipedrive: GetProductsResponse
Fields
- additionalData? GetDealsProductsResponseAdditionalData -
- data? GetProductsResponseData[] - Array containing data for all products
- success? boolean - If the response is successful or not
pipedrive: GetProductsResponseData
Fields
- Fields Included from *BaseProduct
- code string
- ownerId int
- customFields record { anydata... }
- description string
- tax decimal
- isLinkable boolean
- unit string
- updateTime string
- isDeleted boolean
- visibleTo 1|3|5|7
- name string
- id int
- category string|()
- addTime string
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly"
- billingFrequencyCycles int|()
- anydata...
- Fields Included from *PricesArray
- prices ProductPrices[]
- anydata...
pipedrive: GetProductVariationResponse
Fields
- data? GetProductVariationsResponseData -
- success? boolean - If the response is successful or not
pipedrive: GetProductVariationsQueries
Represents the Queries record for the operation: getProductVariations
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetProductVariationsResponse
Fields
- additionalData? GetDealsProductsResponseAdditionalData -
- data? GetProductVariationsResponseData[] - Array containing data for all products
- success? boolean - If the response is successful or not
pipedrive: GetProductVariationsResponseData
Fields
- productId? int - The ID of the product
- name? string - The name of the product variation
- id? int - The ID of the product variation
- prices? record {}[] - Array of objects, each containing: product_variation_id (number), currency (string), price (number), cost (number), direct_cost (number) , notes (string)
pipedrive: GetProjectBoardsResponse
Fields
- additionalData? record {}? -
- data? GetProjectBoardsResponseData[] - The array of project boards
- success? boolean - If the response is successful or not
pipedrive: GetProjectBoardsResponseData
Fields
- updateTime? string - The update date and time of the board in ISO 8601 format
- orderNr? int - The order of the board
- name? string - The name of the project board
- id? int - The ID of the project board
- addTime? string - The creation date and time of the board in ISO 8601 format
pipedrive: GetProjectChangelogQueries
Represents the Queries record for the operation: getProjectChangelog
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetProjectChangelogResponse
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? GetProjectChangelogResponseData[] -
- success? boolean -
pipedrive: GetProjectChangelogResponseData
Fields
- actorUserId? int - The ID of the user who made the change
- changeSourceUserAgent? string? - The user agent from which the change was made
- changeSource? string? - The source of change, for example 'app', 'mobile', 'api', etc
- oldValues? record {} - A map of field keys to their previous values before the change
- time? string - The date and time of the change in ISO 8601 format
- newValues? record {} - A map of field keys to their new values after the change
pipedrive: GetProjectFieldsQueries
Represents the Queries record for the operation: getProjectFields
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetProjectFieldsResponse
Fields
- additionalData? GetActivityFieldsResponseAdditionalData -
- data? GetProjectFieldsResponseData[] -
- success? boolean - Whether the request was successful
pipedrive: GetProjectFieldsResponseData
Fields
- isOptionalResponseField boolean - Whether this field is not returned by default in entity responses
- requiredFields? GetPersonFieldsResponseRequiredFields -
- subfields? GetActivityFieldsResponseSubfields[]? - Array of subfields for complex field types (address, monetary), null for simple field types
- fieldCode string - The unique identifier for the field (40-character hash for custom fields)
- options? GetActivityFieldsResponseOptions[]? - Array of available options for enum/set fields, null for other field types
- importantFields? GetPersonFieldsResponseImportantFields -
- isCustomField boolean - Whether this is a user-created custom field
- fieldType "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"|"orgs" - The type of the field
- uiVisibility? GetProjectFieldsResponseUiVisibility -
- fieldName string - The display name/label of the field
pipedrive: GetProjectFieldsResponseUiVisibility
UI visibility settings (only included when requested via include_fields parameter)
Fields
- detailsVisibleFlag? boolean - Whether the field is shown in the details view
- addVisibleFlag? boolean - Whether the field is shown in the add modal
pipedrive: GetProjectPermittedUsersResponse
Fields
- data? int[] - The list of permitted user IDs
- success? boolean - If the response is successful or not
pipedrive: GetProjectPhasesQueries
Represents the Queries record for the operation: getProjectPhases
Fields
- boardId int - The ID of the board for which phases are requested
pipedrive: GetProjectPhasesResponse
Fields
- additionalData? record {}? -
- data? GetProjectPhasesResponseData[] - The array of project phases
- success? boolean - If the response is successful or not
pipedrive: GetProjectPhasesResponseData
Fields
- updateTime? string - The update date and time of the phase in ISO 8601 format
- boardId? int - The ID of the project board this phase belongs to
- orderNr? int - The order of the phase within its board
- name? string - The name of the project phase
- id? int - The ID of the project phase
- addTime? string - The creation date and time of the phase in ISO 8601 format
pipedrive: GetProjectSearchResponse
Fields
- Fields Included from *GetProjectSearchResponseBase
- success boolean
- anydata...
- Fields Included from *GetProjectSearchResponseContent
- additionalData GetActivitiesResponseAdditionalData
- data GetProjectSearchResponseData
- anydata...
pipedrive: GetProjectSearchResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetProjectSearchResponseContent
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? GetProjectSearchResponseData -
pipedrive: GetProjectSearchResponseData
Fields
- items? GetProjectSearchResponseDataItems[] - The array of found projects
pipedrive: GetProjectSearchResponseDataItem
Fields
- phase? GetProjectSearchResponseDataItemPhase? -
- endDate? string? - The end date of the project
- deal? GetProjectSearchResponseDataItemDeal? -
- notes? string[] - An array of notes
- customFields? string[] - Custom fields
- description? string? - The description of the project
- 'type? string - The type of the item
- title? string - The title of the project
- boardId? int? - The ID of the board the project belongs to
- person? GetProjectSearchResponseDataItemPerson? -
- organization? GetProjectSearchResponseDataItemOrganization? -
- dealCount? int - The number of deals associated with the project
- id? int - The ID of the project
- status? string? - The status of the project
pipedrive: GetProjectSearchResponseDataItemDeal
Fields
- id? int - The ID of the deal the project is associated with
- title? string? - The title of the deal the project is associated with
pipedrive: GetProjectSearchResponseDataItemOrganization
Fields
- address? string? - The address of the organization the project is associated with
- name? string? - The name of the organization the project is associated with
- id? int - The ID of the organization the project is associated with
pipedrive: GetProjectSearchResponseDataItemOwner
Fields
- id? int? - The ID of the owner of the project
pipedrive: GetProjectSearchResponseDataItemPerson
Fields
- name? string? - The name of the person the project is associated with
- id? int - The ID of the person the project is associated with
pipedrive: GetProjectSearchResponseDataItemPhase
Fields
- name? string - The name of the phase
- id? int - The ID of the phase
pipedrive: GetProjectSearchResponseDataItems
Fields
- item? GetProjectSearchResponseDataItem -
- resultScore? decimal - Search result relevancy
pipedrive: GetProjectsQueries
Represents the Queries record for the operation: getProjects
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- filterId? int - If supplied, only projects matching the specified filter are returned
- orgId? int - If supplied, only projects associated with the specified organization are returned
- 'limit? int - 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
- phaseId? int - If supplied, only projects in the specified phase are returned
- dealId? int - If supplied, only projects associated with the specified deal are returned
- status? string - If supplied, includes only projects with the specified statuses. Possible values are
open,completed,canceledanddeleted. By defaultdeletedprojects are not returned
- personId? int - If supplied, only projects associated with the specified person are returned
pipedrive: GetProjectsResponse
Fields
- Fields Included from *GetProjectsResponseBase
- success boolean
- anydata...
- Fields Included from *GetProjectsResponseContent
- additionalData GetActivitiesResponseAdditionalData
- data Project[]
- anydata...
pipedrive: GetProjectsResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: GetProjectsResponseContent
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? Project[] - Projects array
pipedrive: GetProjectTemplateResponse
Fields
- additionalData? record {}? -
- data? ProjectTemplate -
- success? boolean - If the response is successful or not
pipedrive: GetProjectTemplatesQueries
Represents the Queries record for the operation: getProjectTemplates
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: GetProjectTemplatesResponse
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? ProjectTemplate[] -
- success? boolean - If the response is successful or not
pipedrive: GetStagesQueries
Represents the Queries record for the operation: getStages
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- sortDirection "asc"|"desc" (default "asc") - The sorting direction. Supported values:
asc,desc
- pipelineId? int - The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched
- 'limit? int - 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
- sortBy "id"|"update_time"|"add_time"|"order_nr" (default "id") - The field to sort by. Supported fields:
id,update_time,add_time,order_nr
pipedrive: GetStagesResponse
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? StageItem[] - The array of stages
- success? boolean - If the response is successful or not
pipedrive: GetTaskResponse
Fields
- additionalData? record {}? -
- data? GetTasksResponseData -
- success? boolean - If the response is successful or not
pipedrive: GetTasksQueries
Represents the Queries record for the operation: getTasks
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- isDone? boolean - Whether the task is done or not. If omitted, both done and not done tasks are returned
- parentTaskId? string - If
nullis supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned
- isMilestone? boolean - Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned
- projectId? int - If supplied, only tasks belonging to this project are returned
- 'limit? int - 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
- assigneeId? int - If supplied, only tasks assigned to this user are returned
pipedrive: GetTasksResponse
Fields
- additionalData? GetActivitiesResponseAdditionalData -
- data? GetTasksResponseData[] -
- success? boolean - If the response is successful or not
pipedrive: GetTasksResponseData
Fields
- isDone? boolean - Whether the task is done or not
- parentTaskId? int? - The ID of the parent task. If
null, the task is a root-level task
- isMilestone? boolean - Whether the task is a milestone or not
- dueDate? string? - The due date of the task. Format: YYYY-MM-DD
- description? string? - The description of the task
- title? string - The title of the task
- priority? int? - The priority of the task
- updateTime? string - The update date and time of the task in ISO 8601 format
- markedAsDoneTime? string? - The date and time the task was marked as done in ISO 8601 format
- projectId? int - The ID of the project this task is associated with
- creatorId? int - The ID of the user who created the task
- id? int - The ID of the task
- addTime? string - The creation date and time of the task in ISO 8601 format
- startDate? string? - The start date of the task. Format: YYYY-MM-DD
- assigneeIds? int[] - The IDs of users assigned to the task
pipedrive: GetUserFollowersQueries
Represents the Queries record for the operation: getUserFollowers
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- 'limit? int - 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
pipedrive: ItemSearchItem
Fields
- item? record {} - Item
- resultScore? decimal - Search result relevancy
pipedrive: LeadSearchItem
Fields
- item? GetLeadSearchResponseDataItem -
- resultScore? decimal - Search result relevancy
pipedrive: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://oauth.pipedrive.com/oauth/token") - Refresh URL
pipedrive: OrganizationFieldResponse
Fields
- success? boolean - Whether the request was successful
pipedrive: OrganizationItemAddress
The address of the organization
Fields
- country? string? - Country of the organization
- route? string? - Route (e.g. street) of the organization
- locality? string? - Locality (e.g. city) of the organization
- sublocality? string? - Sublocality (e.g. neighborhood) of the organization
- streetNumber? string? - Street number of the organization
- adminAreaLevel1? string? - Admin area level 1 (e.g. state) of the organization
- adminAreaLevel2? string? - Admin area level 2 (e.g. county) of the organization
- postalCode? string? - Postal code of the organization
- value? string - The full address of the organization
- subpremise? string? - Subpremise (e.g. apartment/suite number) of the organization
pipedrive: PersonFieldResponse
Fields
- data? GetPersonFieldsResponseData -
- success? boolean - Whether the request was successful
pipedrive: PersonItemAddress
Postal address of the person, included if contact sync is enabled for the company
Fields
- country? string? - Country of the person
- route? string? - Route (e.g. street) of the person
- locality? string? - Locality (e.g. city) of the person
- sublocality? string? - Sublocality (e.g. neighborhood) of the person
- streetNumber? string? - Street number of the person
- adminAreaLevel1? string? - Admin area level 1 (e.g. state) of the person
- adminAreaLevel2? string? - Admin area level 2 (e.g. county) of the person
- postalCode? string? - Postal code of the person
- value? string - The full address of the person
- subpremise? string? - Subpremise (e.g. apartment/suite number) of the person
pipedrive: PersonItemEmail
Fields
- label? string - The email address classification label
- value? string - The email address of the person
- primary? boolean - Whether the email is primary or not
pipedrive: PersonItemIm
Fields
- label? string - The instant messaging account classification label
- value? string - The instant messaging account of the person
- primary? boolean - Whether the instant messaging account is primary or not
pipedrive: PersonItemPhone
Fields
- label? string - The phone number classification label
- value? string - The phone number of the person
- primary? boolean - Whether the phone number is primary or not
pipedrive: PricesArray
Fields
- prices? ProductPrices[] - The prices of the product in different currencies
pipedrive: ProductFieldResponse
Fields
- data? GetProductFieldsResponseData -
- success? boolean - Whether the request was successful
pipedrive: ProductPriceBase
Fields
- cost? decimal - The cost of the product
- price? decimal - The price of the product
pipedrive: ProductPriceBase1
Fields
- cost? decimal - The cost of the product
- price? decimal - The price of the product
pipedrive: ProductPriceBase2
Fields
- cost? decimal - The cost of the product
- price? decimal - The price of the product
pipedrive: ProductPrices
Fields
- Fields Included from *ProductPriceBase2
- Fields Included from *ProductPricesPart1
pipedrive: ProductPricesPart1
Fields
- notes? string - The notes about the price
- productId? int? - The ID of the product
- currency? string? - The currency of the price
- directCost? decimal? - The direct cost of the product
pipedrive: ProductRequest
Fields
- unit? string - The unit in which this product is sold
- code? string - The product code
- visibleTo? 1|3|5|7 - The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href="https://support.pipedrive.com/en/article/visibility-groups" target="_blank" rel="noopener noreferrer">here</a>.<h4>Light / Growth and Professional plans</h4><table><tr><th style="width: 40px">Value</th><th>Description</th></tr><tr><td>
1</td><td>Owner & followers</td><tr><td>3</td><td>Entire company</td></tr></table><h4>Premium / Ultimate plan</h4><table><tr><th style="width: 40px">Value</th><th>Description</th></tr><tr><td>1</td><td>Owner only</td><tr><td>3</td><td>Owner's visibility group</td></tr><tr><td>5</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>7</td><td>Entire company</td></tr></table>
- ownerId? int - The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- description? string - The product description
- tax decimal(default 0) - The tax percentage
- category? decimal - The category of the product
- prices? ProductRequestPart1[] - The prices of the product in different currencies. Note that there can only be one price per product per currency. When
pricesis omitted altogether, a default price of 0 and the user's default currency will be assigned
- isLinkable boolean(default true) - Whether this product can be added to a deal or not
pipedrive: ProductRequestPart1
Fields
- Fields Included from *ProductPriceBase
- Fields Included from *ProductRequestPart1Part1
pipedrive: ProductRequestPart1Part1
Fields
- notes? string - The notes about the price
- currency string - The currency of the price
- directCost? decimal - The direct cost of the product
pipedrive: Project
Fields
- endDate? string - The end date of the project. Format: YYYY-MM-DD
- ownerId? int - The ID of the user who owns the project
- labelIds? int[] - An array of IDs of the labels this project has
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- description? string - The description of the project
- orgIds? int[] - An array of IDs of the organizations this project is associated with
- phaseId? int - The ID of the phase this project is associated with
- dealIds? int[] - An array of IDs of the deals this project is associated with
- archiveTime? string? - The date and time the project was archived in ISO 8601 format. If not archived, this field is null
- title? string - The title of the project
- updateTime? string - The last updated date and time of the project in ISO 8601 format
- statusChangeTime? string - The date and time of the last status change of the project in ISO 8601 format
- boardId? int - The ID of the board this project is associated with
- personIds? int[] - An array of IDs of the persons this project is associated with
- id? int - The ID of the project
- healthStatus? int? - The health status of the project
- addTime? string - The creation date and time of the project in ISO 8601 format
- status? string - The status of the project
- startDate? string - The start date of the project. Format: YYYY-MM-DD
pipedrive: ProjectFieldResponse
Fields
- data? GetProjectFieldsResponseData -
- success? boolean - Whether the request was successful
pipedrive: ProjectTemplate
Fields
- projectsBoardId? int - The ID of the project board this template is associated with
- updateTime? string - The update date and time of the project template in ISO 8601 format
- ownerId? int - The ID of the owner of the project template
- description? string - The description of the project template
- id? int - The ID of the project template
- title? string - The title of the project template
- addTime? string - The creation date and time of the project template in ISO 8601 format
pipedrive: SearchDealsQueries
Represents the Queries record for the operation: searchDeals
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- exactMatch? boolean - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive
- organizationId? int - Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000
- 'limit? int - 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
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match). Please note that the search term has to be URL encoded
- includeFields? ("deal.cc_email")[] - Supports including optional fields in the results which are not provided by default
- fields? ("custom_fields"|"notes"|"title")[] - A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable:
address,varchar,text,varchar_auto,double,monetaryandphone. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>
- personId? int - Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000
- status? ("open"|"won"|"lost")[] - Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000
pipedrive: SearchItemByFieldQueries
Represents the Queries record for the operation: searchItemByField
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- entityType "deal"|"lead"|"person"|"organization"|"product"|"project" - The type of the field to perform the search from
- 'field string - The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable:
address,varchar,text,varchar_auto,double,monetaryandphone. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>
- 'match "exact"|"beginning"|"middle" (default "exact") - The type of match used against the term. The search <b>is</b> case sensitive.<br/><br/> E.g. in case of searching for a value
monkey, <ul> <li>withexactmatch, you will only find it if term ismonkey</li> <li>withbeginningmatch, you will only find it if the term matches the beginning or the whole string, e.g.monkandmonkey</li> <li>withmiddlematch, you will find the it if the term matches any substring of the value, e.g.onkandke</li> </ul>
- 'limit? int - 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
- term string - The search term to look for. Minimum 2 characters (or 1 if
matchisexact). Please note that the search term has to be URL encoded
pipedrive: SearchItemQueries
Represents the Queries record for the operation: searchItem
Fields
- searchForRelatedItems? boolean - When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- exactMatch? boolean - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive
- 'limit? int - For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match). Please note that the search term has to be URL encoded
- itemTypes? ("deal"|"person"|"organization"|"product"|"lead"|"file"|"mail_attachment"|"project")[] - A comma-separated string array. The type of items to perform the search from. Defaults to all
- includeFields? ("deal.cc_email"|"person.picture"|"product.price")[] - A comma-separated string array. Supports including optional fields in the results which are not provided by default
- fields? ("address"|"code"|"custom_fields"|"email"|"name"|"notes"|"phone"|"title"|"description")[] - A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>
custom_fields,notes,title</td></tr> <tr><td>Person</td><td>custom_fields,email,name,notes,phone</td></tr> <tr><td>Organization</td><td>address,custom_fields,name,notes</td></tr> <tr><td>Product</td><td>code,custom_fields,name</td></tr> <tr><td>Lead</td><td>custom_fields,notes,title</td></tr> <tr><td>File</td><td>name</td></tr> <tr><td>Mail attachment</td><td>name</td></tr> <tr><td>Project</td><td>custom_fields,notes,title,description</td></tr> </table> <br> Only the following custom field types are searchable:address,varchar,text,varchar_auto,double,monetaryandphone. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>
pipedrive: SearchLeadsQueries
Represents the Queries record for the operation: searchLeads
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- exactMatch? boolean - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive
- organizationId? int - Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000
- 'limit? int - 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
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match). Please note that the search term has to be URL encoded
- includeFields? ("lead.was_seen")[] - Supports including optional fields in the results which are not provided by default
- fields? ("custom_fields"|"notes"|"title")[] - A comma-separated string array. The fields to perform the search from. Defaults to all of them
- personId? int - Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000
pipedrive: SearchOrganizationQueries
Represents the Queries record for the operation: searchOrganization
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- exactMatch? boolean - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive
- 'limit? int - 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
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match). Please note that the search term has to be URL encoded
- fields? ("address"|"custom_fields"|"notes"|"name")[] - A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable:
address,varchar,text,varchar_auto,double,monetaryandphone. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>
pipedrive: SearchPersonsQueries
Represents the Queries record for the operation: searchPersons
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- exactMatch? boolean - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive
- organizationId? int - Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000
- 'limit? int - 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
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match). Please note that the search term has to be URL encoded
- includeFields? ("person.picture")[] - Supports including optional fields in the results which are not provided by default
- fields? ("custom_fields"|"email"|"notes"|"phone"|"name")[] - A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable:
address,varchar,text,varchar_auto,double,monetaryandphone. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>
pipedrive: SearchProductsQueries
Represents the Queries record for the operation: searchProducts
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- exactMatch? boolean - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive
- 'limit? int - 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
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match). Please note that the search term has to be URL encoded
- includeFields? ("product.price")[] - Supports including optional fields in the results which are not provided by default
- fields? ("code"|"custom_fields"|"name")[] - A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable:
address,varchar,text,varchar_auto,double,monetaryandphone. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>
pipedrive: SearchProjectsQueries
Represents the Queries record for the operation: searchProjects
Fields
- cursor? string - For pagination, the marker (an opaque string value) representing the first item on the next page
- exactMatch? boolean - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive
- organizationId? int - Will filter projects by the provided organization ID
- 'limit? int - 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
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match). Please note that the search term has to be URL encoded
- fields? ("custom_fields"|"notes"|"title"|"description")[] - A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable:
address,varchar,text,varchar_auto,double,monetaryandphone. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>
- personId? int - Will filter projects by the provided person ID
pipedrive: StageItem
Fields
- updateTime? string? - The stage update time
- isDeleted? boolean - Whether the stage is marked as deleted or not
- isDealRotEnabled? boolean - Whether deals in this stage can become rotten
- orderNr? int - Defines the order of the stage
- name? string - The name of the stage
- pipelineId? int - The ID of the pipeline to add the stage to
- dealProbability? int - The success probability percentage of the deal. Used/shown when the deal weighted values are used
- id? int - The ID of the stage
- addTime? string - The stage creation time
- daysToRotten? int? - The number of days the deals not updated in this stage would become rotten. Applies only if the
is_deal_rot_enabledis set
pipedrive: UpdateAdditionalDiscountRequest
Fields
- description? string - The name of the discount.
- amount? decimal - The discount amount. Must be a positive number (excluding 0).
- 'type? "percentage"|"amount" - Determines whether the discount is applied as a percentage or a fixed amount.
pipedrive: UpdateAdditionalDiscountResponse
Fields
- success? boolean - If the response is successful or not
pipedrive: UpdateDealFieldRequest
Fields
- requiredFields? AddDealFieldRequiredFields -
- importantFields? AddDealFieldImportantFields -
- description? string? - Field description
- uiVisibility? AddDealFieldUiVisibility -
- fieldName? string - Field name
pipedrive: UpdateDealProductRequest
Fields
- Fields Included from *UpdateDealProductRequestPart1
- Fields Included from *UpdateDealProductRequestPart2
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly"
- anydata...
- Fields Included from *UpdateDealProductRequestPart3
- billingFrequencyCycles int|()
- anydata...
- Fields Included from *UpdateDealProductRequestPart4
- billingStartDate string|()
- anydata...
pipedrive: UpdateDealProductRequestPart1
Fields
- isEnabled boolean(default true) - Whether this product is enabled for the deal Not possible to disable the product if the deal has installments associated and the product is the last one enabled Not possible to enable the product if the deal has installments associated and the product is recurring
- quantity? decimal - The quantity of the product
- comments? string - The comments of the product
- itemPrice? decimal - The price value of the product
- productId? int - The ID of the product
- discount decimal(default 0) - The value of the discount. The
discount_typefield can be used to specify whether the value is an amount or a percentage
- tax decimal(default 0) - The product tax
- productVariationId? int? - The ID of the product variation
- discountType "percentage"|"amount" (default "percentage") - The value of the discount. The
discount_typefield can be used to specify whether the value is an amount or a percentage
- taxMethod? "exclusive"|"inclusive"|"none" - The tax option to be applied to the products. When using
inclusive, the tax percentage will already be included in the price. When usingexclusive, the tax will not be included in the price. When usingnone, no tax will be added. Use thetaxfield for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal
pipedrive: UpdateDealProductRequestPart2
Fields
- billingFrequency? "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" - Only available in Growth and above plans
How often a customer is billed for access to a service or product
To set
billing_frequencydifferent thanone-time, the deal must not have installments associated A deal can have up to 20 products attached withbilling_frequencydifferent thanone-time
pipedrive: UpdateDealProductRequestPart3
Fields
- billingFrequencyCycles? int? - Only available in Growth and above plans
The number of times the billing frequency repeats for a product in a deal
When
billing_frequencyis set toone-time, this field must benullWhenbilling_frequencyis set toweekly, this field cannot benullFor all the other values ofbilling_frequency,nullrepresents a product billed indefinitely Must be a positive integer less or equal to 208
pipedrive: UpdateDealProductRequestPart4
Fields
- billingStartDate? string? - Only available in Growth and above plans The billing start date. Must be between 10 years in the past and 10 years in the future
pipedrive: UpdateDealRequest
Fields
- expectedCloseDate? string - The expected close date of the deal
- ownerId? int - The ID of the user who owns the deal
- stageId? int - The ID of the deal stage
- probability? decimal - The success probability percentage of the deal
- labelIds? int[] - The IDs of labels assigned to the deal
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- archiveTime? string? - The optional date and time of archiving the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. If omitted and
is_archivedis true, it will be set to the current date and time
- closeTime? string - The date and time of closing the deal. Can only be set if deal status is won or lost
- title? string - The title of the deal
- lostReason? string - The reason for losing the deal. Can only be set if deal status is lost
- isDeleted? boolean - Whether the deal is deleted or not
- wonTime? string - The date and time of changing the deal status as won. Can only be set if deal status is won
- isArchived? boolean - Whether the deal is archived or not
- visibleTo? int - The visibility of the deal
- orgId? int? - The ID of the organization linked to the deal
- pipelineId? int - The ID of the pipeline associated with the deal
- lostTime? string - The date and time of changing the deal status as lost. Can only be set if deal status is lost
- currency? string - The currency associated with the deal
- value? decimal - The value of the deal
- personId? int? - The ID of the person linked to the deal
- status? string - The status of the deal
pipedrive: UpdateFieldOptionsRequest
Fields
- id int - The unique identifier of the option to update
- label string - The new display label for the option
pipedrive: UpdateInstallmentRequest
Fields
- description? string - The name of the installment.
- amount? decimal - The installment amount. Must be a positive number (excluding 0).
- billing_date? string - The date on which the installment will be charged. Must be in the format YYYY-MM-DD.
pipedrive: UpdateInstallmentResponse
Fields
- data? GetInstallmentsResponseData -
- success? boolean - If the response is successful or not
pipedrive: UpdateOrganizationFieldRequest
Fields
- requiredFields? AddOrganizationFieldRequiredFields -
- importantFields? AddOrganizationFieldImportantFields -
- uiVisibility? AddOrganizationFieldUiVisibility -
- fieldName? string - Field name
pipedrive: UpdateOrganizationRequest
Fields
- employeeCount? int? - The number of employees in the organization
- website? string? - The website of the organization
- address? OrganizationItemAddress? - The address of the organization
- visibleTo? int - The visibility of the organization
- ownerId? int - The ID of the user who owns the organization
- labelIds? int[] - The IDs of labels assigned to the organization
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- name? string - The name of the organization
- industry? int? - The industry the organization belongs to
- linkedin? string? - The LinkedIn profile URL of the organization
- annualRevenue? int? - The annual revenue of the organization
pipedrive: UpdatePersonFieldRequest
Fields
- requiredFields? AddPersonFieldRequiredFields -
- importantFields? AddPersonFieldImportantFields -
- uiVisibility? AddPersonFieldUiVisibility -
- fieldName? string - Field name
pipedrive: UpdatePersonRequest
Fields
- postalAddress? PersonItemAddress? -
- birthday? string - The birthday of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403
- notes? string - Contact sync notes of the person, maximum 10 000 characters. Only accepted when contact sync is enabled for the company; otherwise the request returns 403
- im? PersonItemIm[] - The instant messaging accounts of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403
- ownerId? int - The ID of the user who owns the person
- labelIds? int[] - The IDs of labels assigned to the person
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- phones? PersonItemPhone[] - The phones of the person
- emails? PersonItemEmail[] - The emails of the person
- marketingStatus? "no_consent"|"unsubscribed"|"subscribed"|"archived" - If the person does not have a valid email address, then the marketing status is not set and
no_consentis returned for themarketing_statusvalue when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed once to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>no_consent</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>unsubscribed</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>subscribed</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>archived</td><td>The customers withsubscribedstatus can be moved toarchivedto save consent, but they are not paid for</td></tr></table>
- visibleTo? int - The visibility of the person
- orgId? int - The ID of the organization linked to the person
- name? string - The name of the person
- jobTitle? string - The job title of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403
pipedrive: UpdatePipelineRequest
Fields
- name? string - The name of the pipeline
- isDealProbabilityEnabled boolean(default false) - Whether deal probability is disabled or enabled for this pipeline
pipedrive: UpdateProductFieldRequest
Fields
- uiVisibility? AddProductFieldUiVisibility -
- fieldName? string - Field name
pipedrive: UpdateProductImageRequest
Fields
- data record { fileContent byte[], fileName string } - One image supplied in the multipart/form-data encoding
pipedrive: UpdateProductImageResponse
Fields
- data? UpdateProductImageResponseData -
- success? boolean - If the response is successful or not
pipedrive: UpdateProductImageResponseData
Fields
- companyId? string - The ID of the company
- productId? int - The ID of the product associated
- id? int - The ID of the product image
- addTime? string - The date of image upload
pipedrive: UpdateProductRequest
Fields
- Fields Included from *UpdateProductRequestPart1
- name string
- anydata...
- Fields Included from *UpdateProductRequestFields
- Fields Included from *UpdateProductRequestPart2
- billingFrequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly"
- anydata...
- Fields Included from *UpdateProductRequestPart3
- billingFrequencyCycles int|()
- anydata...
pipedrive: UpdateProductRequestFields
Fields
- unit? string - The unit in which this product is sold
- code? string - The product code
- visibleTo? 1|3|5|7 - The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href="https://support.pipedrive.com/en/article/visibility-groups" target="_blank" rel="noopener noreferrer">here</a>.<h4>Light / Growth and Professional plans</h4><table><tr><th style="width: 40px">Value</th><th>Description</th></tr><tr><td>
1</td><td>Owner & followers</td><tr><td>3</td><td>Entire company</td></tr></table><h4>Premium / Ultimate plan</h4><table><tr><th style="width: 40px">Value</th><th>Description</th></tr><tr><td>1</td><td>Owner only</td><tr><td>3</td><td>Owner's visibility group</td></tr><tr><td>5</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>7</td><td>Entire company</td></tr></table>
- ownerId? int - The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- description? string - The product description
- tax decimal(default 0) - The tax percentage
- category? decimal - The category of the product
- prices? UpdateProductRequestFieldsPart1[] - The prices of the product in different currencies. Note that there can only be one price per product per currency. When
pricesis omitted altogether, a default price of 0 and the user's default currency will be assigned
- isLinkable boolean(default true) - Whether this product can be added to a deal or not
pipedrive: UpdateProductRequestFieldsPart1
Fields
- Fields Included from *ProductPriceBase1
- Fields Included from *UpdateProductRequestFieldsPart1Part1
pipedrive: UpdateProductRequestFieldsPart1Part1
Fields
- notes? string - The notes about the price
- currency string - The currency of the price
- directCost? decimal - The direct cost of the product
pipedrive: UpdateProductRequestPart1
Fields
- name? string - The name of the product. Cannot be an empty string
pipedrive: UpdateProductRequestPart2
Fields
- billingFrequency? "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" - Only available in Growth and above plans How often a customer is billed for access to a service or product
pipedrive: UpdateProductRequestPart3
Fields
- billingFrequencyCycles? int? - Only available in Growth and above plans
The number of times the billing frequency repeats for a product in a deal
When
billing_frequencyis set toone-time, this field must benullWhenbilling_frequencyis set toweekly, this field cannot benullFor all the other values ofbilling_frequency,nullrepresents a product billed indefinitely Must be a positive integer less or equal to 208
pipedrive: UpdateProductResponse
Fields
- data? record { id int, name string, code string, unit string, tax decimal, is_deleted boolean, is_linkable boolean, visible_to 1|3|5|7 , owner_id int, add_time string, update_time string, description string, category string?, custom_fields record {}, billing_frequency "one-time"|"annually"|"semi-annually"|"quarterly"|"monthly"|"weekly" , billing_frequency_cycles int?, prices record { price decimal, cost decimal, product_id int?, currency string?, direct_cost decimal?, notes string }[] } -
- success? boolean - If the response is successful or not
pipedrive: UpdateProductVariationRequest
Fields
- name? string - The name of the product variation. The maximum length is 255 characters
- prices? record {}[] - Array of objects, each containing: currency (string), price (number), cost (number, optional), direct_cost (number, optional), notes (string, optional). When prices is omitted altogether, a default price of 0, a default cost of 0, a default direct_cost of 0 and the user's default currency will be assigned
pipedrive: UpdateProjectBoardRequest
Fields
- orderNr? int - The order of the board. Must be between 1 and the total number of boards + 1
- name? string - The name of the project board
pipedrive: UpdateProjectFieldRequest
Fields
- requiredFields? AddProjectFieldRequiredFields -
- importantFields? AddProjectFieldImportantFields -
- uiVisibility? AddProjectFieldUiVisibility -
- fieldName? string - Field name
pipedrive: UpdateProjectPhaseRequest
Fields
- boardId? int - The ID of the project board to add the phase to
- orderNr? int - The order of the phase within its board. Must be between 1 and the total number of phases on the board + 1
- name? string - The name of the project phase
pipedrive: UpdateProjectRequest
Fields
- endDate? string - The end date of the project. Format: YYYY-MM-DD
- ownerId? int - The ID of the user who owns the project
- labelIds? int[] - An array of IDs of the labels this project has
- customFields? record {} - 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 typeset), usenullto clear the selection — sending an empty array[]is not supported and will result in a validation error
- description? string - The description of the project
- orgIds? int[] - An array of IDs of the organizations this project is associated with
- phaseId? int - The ID of the phase this project is associated with
- dealIds? int[] - An array of IDs of the deals this project is associated with
- title? string - The title of the project
- boardId? int - The ID of the board this project is associated with
- personIds? int[] - An array of IDs of the persons this project is associated with
- templateId? int - The ID of the template the project will be based on. Only used when creating a new project
- healthStatus? int - The health status of the project
- status? string - The status of the project
- startDate? string - The start date of the project. Format: YYYY-MM-DD
pipedrive: UpdateStageRequest
Fields
- isDealRotEnabled? boolean - Whether deals in this stage can become rotten
- name? string - The name of the stage
- pipelineId? int - The ID of the pipeline to add stage to
- dealProbability? int - The success probability percentage of the deal. Used/shown when deal weighted values are used
- daysToRotten? int? - The number of days the deals not updated in this stage would become rotten. Applies only if the
is_deal_rot_enabledis set
pipedrive: UpdateTaskRequest
Fields
- parentTaskId? int? - The ID of the parent task. Cannot be the ID of a task that is already a subtask
- milestone? 0|1 - Whether the task is a milestone or not.
0= Not a milestone,1= Milestone
- projectId? int - The ID of the project this task is associated with
- dueDate? string? - The due date of the task. Format: YYYY-MM-DD
- description? string? - The description of the task
- title? string - The title of the task
- priority? int? - The priority of the task
- done? 0|1 - Whether the task is done or not.
0= Not done,1= Done
- startDate? string? - The start date of the task. Format: YYYY-MM-DD
- assigneeId? int? - The ID of the user assigned to the task. When set, the
assignee_idsfield will be overwritten with this value
- assigneeIds? int[] - The IDs of users assigned to the task. When set, the
assignee_idfield will be set to the first value in this array, ornullif empty
pipedrive: UpdateTaskResponse
Fields
- additionalData? record {}? -
- data? GetTasksResponseData -
- success? boolean - If the response is successful or not
pipedrive: UploadProductImageRequest
Fields
- data record { fileContent byte[], fileName string } - One image supplied in the multipart/form-data encoding
pipedrive: UpsertActivityResponse
Fields
- Fields Included from *UpsertActivityResponseBase
- success boolean
- anydata...
- Fields Included from *UpsertActivityResponseData
- data GetActivitiesResponseData
- anydata...
pipedrive: UpsertActivityResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: UpsertActivityResponseData
Fields
- data? GetActivitiesResponseData -
pipedrive: UpsertDealResponse
Fields
- Fields Included from *UpsertDealResponseBase
- success boolean
- anydata...
- Fields Included from *UpsertDealResponseData
- data GetDealsResponseData
- anydata...
pipedrive: UpsertDealResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: UpsertDealResponseData
Fields
- data? GetDealsResponseData -
pipedrive: UpsertOrganizationResponse
Fields
- Fields Included from *UpsertOrganizationResponseBase
- success boolean
- anydata...
- Fields Included from *UpsertOrganizationResponseData
- data GetOrganizationsResponseData
- anydata...
pipedrive: UpsertOrganizationResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: UpsertOrganizationResponseData
Fields
- data? GetOrganizationsResponseData -
pipedrive: UpsertPersonResponse
Fields
- Fields Included from *UpsertPersonResponseBase
- success boolean
- anydata...
- Fields Included from *UpsertPersonResponseData
- data GetPersonsResponseData
- anydata...
pipedrive: UpsertPersonResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: UpsertPersonResponseData
Fields
- data? GetPersonsResponseData -
pipedrive: UpsertPipelineResponse
Fields
- Fields Included from *UpsertPipelineResponseBase
- success boolean
- anydata...
- Fields Included from *UpsertPipelineResponseData1
- data UpsertPipelineResponseData
- anydata...
pipedrive: UpsertPipelineResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: UpsertPipelineResponseData
The pipeline object
Fields
- updateTime? string - The pipeline update time
- isDeleted? boolean - Whether this pipeline is marked as deleted or not
- orderNr? int - Defines the order of pipelines. The pipeline with the lowest
order_nris considered the default
- name? string - The name of the pipeline
- isDealProbabilityEnabled? boolean - Whether deal probability is disabled or enabled for this pipeline
- id? int - The ID of the pipeline
- addTime? string - The pipeline creation time
pipedrive: UpsertPipelineResponseData1
Fields
- data? UpsertPipelineResponseData - The pipeline object
pipedrive: UpsertProjectBoardResponse
Fields
- data? GetProjectBoardsResponseData -
- success? boolean - If the response is successful or not
pipedrive: UpsertProjectPhaseResponse
Fields
- data? GetProjectPhasesResponseData -
- success? boolean - If the response is successful or not
pipedrive: UpsertProjectResponse
Fields
- Fields Included from *UpsertProjectResponseBase
- success boolean
- anydata...
- Fields Included from *UpsertProjectResponseContent
- data Project
- anydata...
pipedrive: UpsertProjectResponseBase
Fields
- success? boolean - If the response is successful or not
pipedrive: UpsertProjectResponseContent
Fields
- data? Project -
pipedrive: UpsertStageResponse
Fields
- data? UpsertStageResponseStageItem - The stage object
- success? boolean - If the response is successful or not
pipedrive: UpsertStageResponseStageItem
The stage object
Fields
- updateTime? string? - The stage update time
- isDeleted? boolean - Whether the stage is marked as deleted or not
- isDealRotEnabled? boolean - Whether deals in this stage can become rotten
- orderNr? int - Defines the order of the stage
- name? string - The name of the stage
- pipelineId? int - The ID of the pipeline to add the stage to
- dealProbability? int - The success probability percentage of the deal. Used/shown when the deal weighted values are used
- id? int - The ID of the stage
- addTime? string - The stage creation time
- daysToRotten? int? - The number of days the deals not updated in this stage would become rotten. Applies only if the
is_deal_rot_enabledis set
Import
import ballerinax/pipedrive;Metadata
Released date: about 20 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 1831
Current verison: 1
Weekly downloads
Keywords
Vendor/Pipedrive
Area/CRM & Sales
Type/Connector
Contributors