pipedrive
Module pipedrive
API
Definitions
ballerinax/pipedrive Ballerina library
Overview
This is a generated connector for Pipedrive API v1 OpenAPI specification. Pipedrive is a sales CRM and pipeline management solution that enables businesses to plan their sales activities and monitor deals. Built using activity-based selling methodology, Pipedrive streamlines every action involved in converting a potential deal into a successful sale.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Pipedrive developer account
- Obtain tokens by following this guide
Quickstart
To use the Pipedrive connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/pipedrive
module into the Ballerina project.
import ballerinax/pipedrive;
Step 2: Create a new connector instance
Create a pipedrive:ApiKeysConfig
with the API key obtained, and initialize the connector with it.
pipedrive:ApiKeysConfig config = { apiToken: "<API_KEY>" } pipedrive:Client baseClient = check new Client(config);
Step 3: Invoke connector operation
-
Now you can use the operations available within the connector. Note that they are in the form of remote operations.
Following is an example on how to get all Activities assigned to a particular user using the connector.
Returns all Activities assigned to a particular User
public function main() { pipedrive:GetActivitiesResponse200|error response = baseClient->getActivities(); if (response is pipedrive:GetActivitiesResponse200) { log:printInfo(response.toString()); } else { log:printError(response.message()); } }
-
Use
bal run
command to compile and run the Ballerina program.
Clients
pipedrive: Client
This is a generated connector for Pipedrive API v1 OpenAPI specification. Pipedrive is a sales CRM and pipeline management solution that enables businesses to plan their sales activities and monitor deals. Built using activity-based selling methodology, Pipedrive streamlines every action involved in converting a potential deal into a successful sale.
Constructor
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a Pipedrive account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, ClientConfiguration clientConfig, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.pipedrive.com/v1" - URL of the target service
getActivities
function getActivities(int? userId, int? filterId, string? 'type, int? 'limit, int? 'start, string? startDate, string? endDate, decimal? done) returns GetActivitiesResponse200|error
Get all Activities assigned to a particular User
Parameters
- userId int? (default ()) - The ID of the User whose Activities will be fetched. If omitted, the User associated with the API token will be used. If 0, Activities for all company Users will be fetched based on the permission sets.
- filterId int? (default ()) - The ID of the Filter to use (will narrow down results if used together with
user_id
parameter)
- 'type string? (default ()) - Type of the Activity, can be one type or multiple types separated by a comma. This is in correlation with the
key_string
parameter of ActivityTypes.
- 'limit int? (default ()) - For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
- 'start int? (default ()) - For pagination, the position that represents the first result for the page
- startDate string? (default ()) - Use the Activity due date where you wish to begin fetching Activities from. Insert due date in YYYY-MM-DD format.
- endDate string? (default ()) - Use the Activity due date where you wish to stop fetching Activities from. Insert due date in YYYY-MM-DD format.
- done decimal? (default ()) - Whether the Activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
Return Type
- GetActivitiesResponse200|error - A list of Activities
addActivity
function addActivity(AddActivityRequest payload) returns AddActivityResponse200|error
Add an Activity
Parameters
- payload AddActivityRequest - AddActivity request
Return Type
- AddActivityResponse200|error - The Activity was successfully added
deleteActivities
function deleteActivities(string ids) returns DeleteActivitiesResponse200|error
Delete multiple Activities in bulk
Parameters
- ids string - Comma-separated IDs of Activities that will be deleted
Return Type
- DeleteActivitiesResponse200|error - The Activities were successfully deleted
getActivity
function getActivity(int id) returns GetActivityResponse200|error
Get details of an Activity
Parameters
- id int - The ID of the Activity
Return Type
- GetActivityResponse200|error - The request was successful
updateActivity
function updateActivity(int id, UpdateActivityRequest payload) returns UpdateActivityResponse200|error
Edit an Activity
Return Type
- UpdateActivityResponse200|error - The request was successful
deleteActivity
function deleteActivity(int id) returns DeleteActivityResponse200|error
Delete an Activity
Parameters
- id int - The ID of the Activity
Return Type
- DeleteActivityResponse200|error - The Activity was successfully deleted
getActivityFields
function getActivityFields() returns FieldsResponse200|error
Get all activity fields
Return Type
- FieldsResponse200|error - success
getActivityTypes
function getActivityTypes() returns GetActivityTypesResponse200|error
Get all ActivityTypes
Return Type
- GetActivityTypesResponse200|error - A list of ActivityTypes
addActivityType
function addActivityType(AddActivityTypeRequest payload) returns CreateUpdateDeleteActivityTypeResponse200|error
Add new ActivityType
Parameters
- payload AddActivityTypeRequest - AddActivityType request
Return Type
- CreateUpdateDeleteActivityTypeResponse200|error - The ActivityType was successfully created
deleteActivityTypes
function deleteActivityTypes(string ids) returns DeleteActivityTypesResponse200|error
Delete multiple ActivityTypes in bulk
Parameters
- ids string - Comma-separated ActivityType IDs
Return Type
- DeleteActivityTypesResponse200|error - The ActivityTypes were successfully deleted
updateActivityType
function updateActivityType(int id, UpdateActivityTypeRequest payload) returns CreateUpdateDeleteActivityTypeResponse200|error
Edit an ActivityType
Parameters
- id int - The ID of the ActivityType
- payload UpdateActivityTypeRequest - UpdateActivityType request
Return Type
- CreateUpdateDeleteActivityTypeResponse200|error - The ActivityType was successfully updated
deleteActivityType
function deleteActivityType(int id) returns CreateUpdateDeleteActivityTypeResponse200|error
Delete an ActivityType
Parameters
- id int - The ID of the ActivityType
Return Type
- CreateUpdateDeleteActivityTypeResponse200|error - The ActivityType was successfully deleted
getUserCallLogs
function getUserCallLogs(decimal? 'limit, decimal? 'start) returns GetUserCallLogsResponse200|error
Get all call logs assigned to a particular user
Parameters
- 'limit decimal? (default ()) - For pagination, the limit of entries to be returned
- 'start decimal? (default ()) - For pagination, the position that represents the first result for the page
Return Type
- GetUserCallLogsResponse200|error - A list of call logs.
addCallLog
function addCallLog(AddCallLogRequest payload) returns AddCallLogResponse200|error
Add a call log
Parameters
- payload AddCallLogRequest - AddCallLog request
Return Type
- AddCallLogResponse200|error - The call log was successfully created.
getCallLog
function getCallLog(string id) returns InlineResponse200|error
Get details of a call log
Parameters
- id string - The ID received when you create the call log
Return Type
- InlineResponse200|error - The requested call log object.
deleteCallLog
function deleteCallLog(string id) returns DeleteCallLogResponse200|error
Delete a call log
Parameters
- id string - The ID received when you create the call log
Return Type
- DeleteCallLogResponse200|error - The call log was successfully deleted.
getCurrencies
function getCurrencies(string? term) returns GetCurrenciesResponse200|error
Get all supported currencies
Parameters
- term string? (default ()) - Optional search term that is searched for from currency's name and/or code.
Return Type
- GetCurrenciesResponse200|error - The list of supported currencies
getDeals
function getDeals(int? userId, int? filterId, int? stageId, string status, int 'start, int? 'limit, string? sort, decimal? ownedByYou) returns GetDealsResponse200|error
Get all deals
Parameters
- userId int? (default ()) - If supplied, only deals matching the given user will be returned. However,
filter_id
andowned_by_you
takes precedence overuser_id
when supplied.
- filterId int? (default ()) - ID of the filter to use
- stageId int? (default ()) - If supplied, only deals within the given stage will be returned.
- status string (default "all_not_deleted") - Only fetch deals with specific status. If omitted, all not deleted deals are fetched.
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- sort string? (default ()) - Field names and sorting mode separated by a comma (
field_name_1 ASC
,field_name_2 DESC
). Only first-level field keys are supported (no nested keys).
- ownedByYou decimal? (default ()) - When supplied, only deals owned by you are returned. However,
filter_id
takes precedence overowned_by_you
when both are supplied.
Return Type
- GetDealsResponse200|error - Get all Deals
addDeal
function addDeal(AddDealRequest payload) returns DealResponse200|error
Add a deal
Parameters
- payload AddDealRequest - AddDeal request
Return Type
- DealResponse200|error - Add a Deal
deleteDeals
function deleteDeals(string ids) returns DeleteDealsResponse200|error
Delete multiple deals in bulk
Parameters
- ids string - Comma-separated IDs that will be deleted
Return Type
- DeleteDealsResponse200|error - Delete multiple deals in bulk
searchDeals
function searchDeals(string term, string? fields, boolean? exactMatch, int? personId, int? organizationId, string? status, string? includeFields, int 'start, int? 'limit) returns SearchDealsResponse200|error
Search deals
Parameters
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match
).
- fields string? (default ()) - A comma-separated string array. The fields to perform the search from. Defaults to all of them.
- exactMatch boolean? (default ()) - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
- personId int? (default ()) - Will filter Deals by the provided Person ID. The upper limit of found Deals associated with the Person is 2000.
- organizationId int? (default ()) - Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000.
- status string? (default ()) - 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.
- includeFields string? (default ()) - Supports including optional fields in the results which are not provided by default.
- 'start int (default 0) - Pagination start. Note that the pagination is based on main results and does not include related items when using
search_for_related_items
parameter.
- 'limit int? (default ()) - Items shown per page
Return Type
- SearchDealsResponse200|error - success
getDealsByName
function getDealsByName(string term, int? personId, int? orgId) returns GetDealsByNameResponse200|error
Find deals by name
Parameters
- term string - Search term to look for
- personId int? (default ()) - ID of the person the Deal is associated with.
- orgId int? (default ()) - ID of the organization the Deal is associated with.
Return Type
- GetDealsByNameResponse200|error - Get Deals by name
Deprecated
getDealsSummary
function getDealsSummary(string? status, int? filterId, int? userId, int? stageId) returns GetDealsSummaryResponse200|error
Get deals summary
Parameters
- status string? (default ()) - Only fetch deals with specific status. open = Open, won = Won, lost = Lost
- filterId int? (default ()) - <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
- userId int? (default ()) - Only deals matching the given user will be returned.
user_id
will not be considered if you usefilter_id
.
- stageId int? (default ()) - Only deals within the given stage will be returned.
Return Type
- GetDealsSummaryResponse200|error - Get the summary of the Deals
getDealsTimeline
function getDealsTimeline(string startDate, string interval, int amount, string fieldKey, int? userId, int? pipelineId, int? filterId, decimal? excludeDeals, string? totalsConvertCurrency) returns GetDealsTimelineResponse200|error
Get deals timeline
Parameters
- startDate string - Date where the first interval starts. Format: YYYY-MM-DD
- interval string - The type of interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>
day
</td><td>Day</td></tr><tr><td>week
</td><td>A full week (7 days) starting fromstart_date
</td></tr><tr><td>month
</td><td>A full month (depending on the number of days in given month) starting fromstart_date
</td></tr><tr><td>quarter
</td><td>A full quarter (3 months) starting fromstart_date
</td></tr></table>
- amount int - The number of given intervals, starting from
start_date
, to fetch. E.g. 3 (months).
- fieldKey string - The date field key which deals will be retrieved from
- userId int? (default ()) - If supplied, only deals matching the given user will be returned.
- pipelineId int? (default ()) - If supplied, only deals matching the given pipeline will be returned
- filterId int? (default ()) - If supplied, only deals matching the given filter will be returned
- excludeDeals decimal? (default ()) - Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
- totalsConvertCurrency string? (default ()) - 3-letter currency code of any of the supported currencies. When supplied,
totals_converted
is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter todefault_currency
in which case users default currency is used.
Return Type
- GetDealsTimelineResponse200|error - Get open and won Deals, grouped by the defined interval of time
getDeal
function getDeal(int id) returns GetDealResponse200|error
Get details of a deal
Parameters
- id int - ID of the deal
Return Type
- GetDealResponse200|error - Get a Deal by its ID
updateDeal
function updateDeal(int id, BasicDeal payload) returns DealResponse200|error
Update a deal
Return Type
- DealResponse200|error - Add a Deal
deleteDeal
function deleteDeal(int id) returns DeleteDealResponse200|error
Delete a deal
Parameters
- id int - ID of the deal
Return Type
- DeleteDealResponse200|error - Delete a Deal
getDealActivities
function getDealActivities(int id, int 'start, int? 'limit, decimal? done, string? exclude) returns GetDealActivitiesResponse200|error
List activities associated with a deal
Parameters
- id int - ID of the deal
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- done decimal? (default ()) - Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
- exclude string? (default ()) - A comma-separated string of activity IDs to exclude from result
Return Type
- GetDealActivitiesResponse200|error - success
duplicateDeal
function duplicateDeal(int id) returns DuplicateDealResponse200|error
Duplicate deal
Parameters
- id int - ID of the deal
Return Type
- DuplicateDealResponse200|error - Duplicate a Deal
getDealFiles
function getDealFiles(int id, int 'start, int? 'limit, decimal? includeDeletedFiles, string? sort) returns GetAssociatedFilesResponse200|error
List files attached to a deal
Parameters
- id int - ID of the deal
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- includeDeletedFiles decimal? (default ()) - When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
- sort string? (default ()) - Field names and sorting mode separated by a comma (
field_name_1 ASC
,field_name_2 DESC
). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
Return Type
- GetAssociatedFilesResponse200|error - success
getDealUpdates
function getDealUpdates(int id, int 'start, int? 'limit, string? allChanges, string? items) returns GetDealUpdatesResponse200|error
List updates about a deal
Parameters
- id int - ID of the deal
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- allChanges string? (default ()) - Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
- items string? (default ()) - A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
Return Type
- GetDealUpdatesResponse200|error - Get the Deal Updates
getDealFollowers
function getDealFollowers(int id) returns GetAssociatedFollowersResponse200|error
List followers of a deal
Parameters
- id int - ID of the deal
Return Type
- GetAssociatedFollowersResponse200|error - success
addDealFollower
function addDealFollower(int id, AddDealFollowerRequest payload) returns AddDealFollowerResponse200|error
Add a follower to a deal
Return Type
- AddDealFollowerResponse200|error - Add a Follower to a Deal
deleteDealFollower
function deleteDealFollower(int id, int followerId) returns DeleteDealFollowerResponse200|error
Delete a follower from a deal
Return Type
- DeleteDealFollowerResponse200|error - Delete a Follower from a Deal
getDealMailMessages
function getDealMailMessages(int id, int 'start, int? 'limit) returns GetAssociatedMailMessagesResponse200|error
List mail messages associated with a deal
Parameters
- id int - ID of the deal
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetAssociatedMailMessagesResponse200|error - success
mergeDeals
function mergeDeals(int id, MergeDealsRequest payload) returns MergeDealsResponse200|error
Merge two deals
Return Type
- MergeDealsResponse200|error - Merges a Deal with another Deal.
getDealParticipants
function getDealParticipants(int id, int 'start, int? 'limit) returns GetDealParticipantsResponse200|error
List participants of a deal
Parameters
- id int - ID of the deal
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetDealParticipantsResponse200|error - Get all Deal participants by the DealID
addDealParticipant
function addDealParticipant(int id, AddDealParticipantRequest payload) returns AddDealParticipantResponse200|error
Add a participant to a deal
Return Type
- AddDealParticipantResponse200|error - Add new participant to the Deal
deleteDealParticipant
function deleteDealParticipant(int id, int dealParticipantId) returns DeleteDealParticipantResponse200|error
Delete a participant from a deal
Return Type
- DeleteDealParticipantResponse200|error - Delete a Participant from a Deal
getDealUsers
function getDealUsers(int id) returns ListPermittedUsersResponse200|error
List permitted users
Parameters
- id int - ID of the deal
Return Type
- ListPermittedUsersResponse200|error - success
getDealPersons
function getDealPersons(int id, int 'start, int? 'limit) returns ListPersonsResponse200|error
List all persons associated with a deal
Parameters
- id int - ID of the deal
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- ListPersonsResponse200|error - success
getDealProducts
function getDealProducts(int id, int 'start, int? 'limit, decimal? includeProductData) returns ListProductsResponse200|error
List products attached to a deal
Parameters
- id int - ID of the deal
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- includeProductData decimal? (default ()) - Whether to fetch product data along with each attached product (1) or not (0, default).
Return Type
- ListProductsResponse200|error - success
addDealProduct
function addDealProduct(int id, AddDealProductRequest payload) returns GetAddProductAttachementResponse200|error
Add a product to the deal, eventually creating a new item called a deal-product
Return Type
- GetAddProductAttachementResponse200|error - Add a Product to the Deal
updateDealProduct
function updateDealProduct(int id, int productAttachmentId, BasicDealProductRequest payload) returns GetProductAttachementResponse200|error
Update product attachment details of the deal-product (a product already attached to a deal)
Parameters
- id int - ID of the deal
- productAttachmentId int - ID of the deal-product (the ID of the product attached to the deal)
- payload BasicDealProductRequest - BasicDealProduct request
Return Type
- GetProductAttachementResponse200|error - Update Product attachment details
deleteDealProduct
function deleteDealProduct(int id, int productAttachmentId) returns DeleteDealProductResponse200|error
Delete an attached product from a deal
Parameters
- id int - ID of the deal
- productAttachmentId int - Product attachment ID. This is returned as
product_attachment_id
after attaching a product to a deal or as id when listing the products attached to a deal.
Return Type
- DeleteDealProductResponse200|error - Delete an attached Product from a Deal
getDealFields
function getDealFields() returns FieldsResponse200|error
Get all deal fields
Return Type
- FieldsResponse200|error - success
addDealField
function addDealField(CreateFieldRequest payload) returns FieldResponse200|error
Add a new deal field
Parameters
- payload CreateFieldRequest - CreateField request
Return Type
- FieldResponse200|error - success
deleteDealFields
function deleteDealFields(string ids) returns DeleteFieldsResponse200|error
Delete multiple deal fields in bulk
Parameters
- ids string - Comma-separated field IDs to delete
Return Type
- DeleteFieldsResponse200|error - success
getDealField
function getDealField(int id) returns FieldResponse200|error
Get one deal field
Parameters
- id int - ID of the field
Return Type
- FieldResponse200|error - success
updateDealField
function updateDealField(int id, UpdateFieldRequest payload) returns FieldResponse200|error
Update a deal field
Return Type
- FieldResponse200|error - success
deleteDealField
function deleteDealField(int id) returns DeleteFieldResponse200|error
Delete a deal field
Parameters
- id int - ID of the field
Return Type
- DeleteFieldResponse200|error - success
getFiles
function getFiles(int 'start, int? 'limit, decimal? includeDeletedFiles, string? sort) returns GetFilesResponse200|error
Get all files
Parameters
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- includeDeletedFiles decimal? (default ()) - When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
- sort string? (default ()) - Field names and sorting mode separated by a comma (
field_name_1 ASC
,field_name_2 DESC
). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
Return Type
- GetFilesResponse200|error - Get data about all uploaded to Pipedrive files.
addFileAndLinkIt
function addFileAndLinkIt(AddFileAndLinkItRequest payload) returns AddFileAndLinkItResponse200|error
Create a remote file and link it to an item
Parameters
- payload AddFileAndLinkItRequest - AddFileAndLinkIt request
Return Type
- AddFileAndLinkItResponse200|error - Creates a new empty file in the remote location (googledrive) that will be linked to the item you supply - deal, person or organization
linkFileToItem
function linkFileToItem(LinkFileToItemRequest payload) returns LinkFileToItemResponse200|error
Link a remote file to an item
Parameters
- payload LinkFileToItemRequest - LinkFileToItem request
Return Type
- LinkFileToItemResponse200|error - Links an existing remote file (googledrive) to the item you supply - deal, person, organization
getFile
function getFile(int id) returns GetFileResponse200|error
Get one file
Parameters
- id int - ID of the file
Return Type
- GetFileResponse200|error - Get data about one specific uploaded to Pipedrive file
updateFile
function updateFile(int id, UpdateFileRequest payload) returns UpdateFileResponse200|error
Update file details
Return Type
- UpdateFileResponse200|error - Update file name and description.
deleteFile
function deleteFile(int id) returns DeleteFileResponse200|error
Delete a file
Parameters
- id int - ID of the file
Return Type
- DeleteFileResponse200|error - Delete a file from Pipedrive
downloadFile
Download one file
Parameters
- id int - ID of the file
getFilters
function getFilters(string? 'type) returns GetFiltersResponse200|error
Get all filters
Parameters
- 'type string? (default ()) - The types of filters to fetch
Return Type
- GetFiltersResponse200|error - success
addFilter
function addFilter(AddFilterRequest payload) returns PostFilterResponse200|error
Add a new filter
Parameters
- payload AddFilterRequest - AddFilter request
Return Type
- PostFilterResponse200|error - success
deleteFilters
function deleteFilters(string ids) returns DeleteFiltersResponse200|error
Delete multiple filters in bulk
Parameters
- ids string - Comma-separated filter IDs to delete
Return Type
- DeleteFiltersResponse200|error - success
getFilterHelpers
function getFilterHelpers() returns json|error
Get all filter helpers
Return Type
- json|error - success
getFilter
function getFilter(int id) returns GetFilterResponse200|error
Get one filter
Parameters
- id int - The ID of the filter
Return Type
- GetFilterResponse200|error - success
updateFilter
function updateFilter(int id, UpdateFilterRequest payload) returns PostFilterResponse200|error
Update filter
Return Type
- PostFilterResponse200|error - success
deleteFilter
function deleteFilter(int id) returns DeleteFilterResponse200|error
Delete a filter
Parameters
- id int - The ID of the filter
Return Type
- DeleteFilterResponse200|error - success
getGlobalMessages
function getGlobalMessages(int 'limit) returns GetGlobalMessagesResponse200|error
Get global messages
Parameters
- 'limit int (default 1) - Number of messages to get from 1 to 100. The message number 1 is returned by default.
Return Type
- GetGlobalMessagesResponse200|error - Get all Global Messages
deleteGlobalMessage
function deleteGlobalMessage(int id) returns DeleteGlobalMessageResponse200|error
Dismiss a global message
Parameters
- id int - ID of global message to be dismissed.
Return Type
- DeleteGlobalMessageResponse200|error - Removes a Global Message by ID
addGoal
function addGoal(AddGoalRequest payload) returns AddOrUpdateGoalResponse200|error
Add a new goal
Parameters
- payload AddGoalRequest - AddGoal request
Return Type
- AddOrUpdateGoalResponse200|error - Successful response containing payload in the
data.goal
object.
getGoals
function getGoals(string? typeName, string? title, boolean isActive, int? assigneeId, string? assigneeType, decimal? expectedOutcomeTarget, string? expectedOutcomeTrackingMetric, int? expectedOutcomeCurrencyId, int? typeParamsPipelineId, int? typeParamsStageId, int? typeParamsActivityTypeId, string? periodStart, string? periodEnd) returns GetGoalsResponse200|error
Find goals
Parameters
- typeName string? (default ()) - Type of the goal. If provided, everyone's goals will be returned.
- title string? (default ()) - Title of the goal.
- isActive boolean (default true) - Whether goal is active or not.
- assigneeId int? (default ()) - ID of the user who's goal to fetch. When omitted, only your goals will be returned.
- assigneeType string? (default ()) - Type of the goal's assignee. If provided, everyone's goals will be returned.
- expectedOutcomeTarget decimal? (default ()) - Numeric value of the outcome. If provided, everyone's goals will be returned.
- expectedOutcomeTrackingMetric string? (default ()) - Tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
- expectedOutcomeCurrencyId int? (default ()) - Numeric ID of the goal's currency. Only applicable to goals with
expected_outcome.tracking_metric
with valuesum
. If provided, everyone's goals will be returned.
- typeParamsPipelineId int? (default ()) - ID of the pipeline or
null
for all pipelines. If provided, everyone's goals will be returned.
- typeParamsStageId int? (default ()) - ID of the stage. Applicable to only
deals_progressed
type of goals. If provided, everyone's goals will be returned.
- typeParamsActivityTypeId int? (default ()) - ID of the activity type. Applicable to only
activities_completed
oractivities_added
types of goals. If provided, everyone's goals will be returned.
- periodStart string? (default ()) - Start date of the period for which to find goals. Date in format of YYYY-MM-DD. When
period.start
is provided,period.end
must be provided too.
- periodEnd string? (default ()) - End date of the period for which to find goals. Date in format of YYYY-MM-DD.
Return Type
- GetGoalsResponse200|error - Successful response containing payload in the
data.goal
object.
updateGoal
function updateGoal(string id, BasicGoalRequest payload) returns AddOrUpdateGoalResponse200|error
Update existing goal
Return Type
- AddOrUpdateGoalResponse200|error - Successful response containing payload in the
data.goal
object.
deleteGoal
function deleteGoal(string id) returns DeleteGoalResponse200|error
Delete existing goal
Parameters
- id string - ID of the goal to be deleted.
Return Type
- DeleteGoalResponse200|error - Successful response with id 'success' field only
getGoalResult
function getGoalResult(string id, string periodStart, string periodEnd) returns GetGoalResultResponse200|error
Get result of a goal
Parameters
- id string - ID of the goal that the results are looked for.
- periodStart string - Start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD.
- periodEnd string - End date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD.
Return Type
- GetGoalResultResponse200|error - Successful response containing payload in the
data.goal
object.
searchItem
function searchItem(string term, string? itemTypes, string? fields, boolean? searchForRelatedItems, boolean? exactMatch, string? includeFields, int 'start, int? 'limit) returns SearchItemResponse200|error
Perform a search from multiple item types
Parameters
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match
).
- itemTypes string? (default ()) - A comma-separated string array. The type of items to perform the search from. Defaults to all.
- fields string? (default ()) - 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>email
,organization_name
,person_name
,phone
,title
</td></tr> <tr><td>File</td><td>name
</td></tr> <tr><td>Mail attachment</td><td>name
</td></tr> </table> <br> When searching for Leads, the email, organization_name, person_name, and phone fields will return results only for Leads not linked to contacts. For searching Leads by Person or Organization values, please usesearch_for_related_items
.
- searchForRelatedItems boolean? (default ()) - 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.
- exactMatch boolean? (default ()) - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
- includeFields string? (default ()) - A comma-separated string array. Supports including optional fields in the results which are not provided by default.
- 'start int (default 0) - Pagination start. Note that the pagination is based on main results and does not include related items when using
search_for_related_items
parameter.
- 'limit int? (default ()) - Items shown per page
Return Type
- SearchItemResponse200|error - success
searchItemByField
function searchItemByField(string term, string fieldType, string fieldKey, boolean exactMatch, boolean? returnItemIds, int? 'start, int? 'limit) returns SearchItemByFieldResponse200|error
Perform a search using a specific field from an item type
Parameters
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match
).
- fieldType string - The type of the field to perform the search from
- fieldKey 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.).
- exactMatch boolean (default false) - When enabled, only full exact matches against the given term are returned. The search <b>is</b> case sensitive.
- returnItemIds boolean? (default ()) - Whether to return the IDs of the matching items or not. When not set or set to
0
orfalse
, only distinct values of the searched field are returned. When set to1
ortrue
, the ID of each found item is returned.
- 'start int? (default ()) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- SearchItemByFieldResponse200|error - success
getLeads
function getLeads(int? 'limit, int? 'start, string? archivedStatus) returns GetLeadsResponse200|error
Get all leads
Parameters
- 'limit int? (default ()) - For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
- 'start int? (default ()) - For pagination, the position that represents the first result for the page
- archivedStatus string? (default ()) - Filtering based on archived status of a Lead. If not provided,
All
is used.
Return Type
- GetLeadsResponse200|error - Successful response containing payload in the
data
field.
addLead
function addLead(AddLeadRequest payload) returns OneLeadResponse200|error
Add a lead
Parameters
- payload AddLeadRequest - AddLead request
Return Type
- OneLeadResponse200|error - Successful response containing payload in the
data
field.
getLead
function getLead(string id) returns OneLeadResponse200|error
Get one lead
Parameters
- id string - The ID of the Lead
Return Type
- OneLeadResponse200|error - Successful response containing payload in the
data
field.
deleteLead
function deleteLead(string id) returns LeadIdResponse200|error
Delete a lead
Parameters
- id string - The ID of the Lead
Return Type
- LeadIdResponse200|error - Successful response with id value only. Used in DELETE calls.
updateLead
function updateLead(string id, UpdateLeadRequest payload) returns OneLeadResponse200|error
Update a lead
Return Type
- OneLeadResponse200|error - Successful response containing payload in the
data
field.
getLeadLabels
function getLeadLabels() returns GetLeadLabelsResponse200|error
Get all lead labels
Return Type
- GetLeadLabelsResponse200|error - Successful response containing payload in the
data
field.
addLeadLabel
function addLeadLabel(AddLeadLabelRequest payload) returns AddOrUpdateLeadLabelResponse200|error
Add a lead label
Parameters
- payload AddLeadLabelRequest - AddLeadLabel request
Return Type
- AddOrUpdateLeadLabelResponse200|error - Successful response containing payload in the
data
field.
deleteLeadLabel
function deleteLeadLabel(string id) returns LeadIdResponse200|error
Delete a lead label
Parameters
- id string - The ID of the Lead Label
Return Type
- LeadIdResponse200|error - Successful response with id value only. Used in DELETE calls.
updateLeadLabel
function updateLeadLabel(string id, UpdateLeadLabelRequest payload) returns AddOrUpdateLeadLabelResponse200|error
Update a lead label
Parameters
- id string - The ID of the Lead Label
- payload UpdateLeadLabelRequest - UpdateLeadLabel request
Return Type
- AddOrUpdateLeadLabelResponse200|error - Successful response containing payload in the
data
field.
getLeadSources
function getLeadSources() returns GetLeadSourcesResponse200|error
Get all lead sources
Return Type
- GetLeadSourcesResponse200|error - The successful response containing payload in the
data
field.
getMailMessage
function getMailMessage(int id, decimal includeBody) returns MailMessageResponse200|error
Get one mail message
Parameters
- id int - ID of the mail message to fetch.
- includeBody decimal (default 1) - Whether to include full message body or not.
0
= Don't include,1
= Include
Return Type
- MailMessageResponse200|error - The mail messages that are being synced with Pipedrive
getMailThreads
function getMailThreads(string folder, int 'start, int? 'limit) returns GetMailThreadsResponse200|error
Get mail threads
Parameters
- folder string - Type of folder to fetch.
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetMailThreadsResponse200|error - Get mail threads
getMailThread
function getMailThread(int id) returns GetOneMailThreadResponse200|error
Get one mail thread
Parameters
- id int - ID of the mail thread
Return Type
- GetOneMailThreadResponse200|error - Get mail threads
updateMailThreadDetails
function updateMailThreadDetails(int id, UpdateMailThreadDetailsRequest payload) returns UpdateMailThreadDetailsResponse200|error
Update mail thread details
Parameters
- id int - ID of the mail thread
- payload UpdateMailThreadDetailsRequest - UpdateMailThreadDetails request
Return Type
- UpdateMailThreadDetailsResponse200|error - Updates the properties of a mail thread.
deleteMailThread
function deleteMailThread(int id) returns DeleteMailThreadResponse200|error
Delete mail thread
Parameters
- id int - ID of the mail thread
Return Type
- DeleteMailThreadResponse200|error - Marks mail thread as deleted.
getMailThreadMessages
function getMailThreadMessages(int id) returns GetAllMailMessagesOfMailThreadResponse200|error
Get all mail messages of mail thread
Parameters
- id int - ID of the mail thread
Return Type
- GetAllMailMessagesOfMailThreadResponse200|error - Get mail messages from thread
getNotes
function getNotes(int? userId, string? leadId, int? dealId, int? personId, int? orgId, int 'start, int? 'limit, string? sort, string? startDate, string? endDate, decimal? pinnedToLeadFlag, decimal? pinnedToDealFlag, decimal? pinnedToOrganizationFlag, decimal? pinnedToPersonFlag) returns GetNotesResponse200|error
Get all notes
Parameters
- userId int? (default ()) - The ID of the user whose notes to fetch. If omitted, notes by all users will be returned.
- leadId string? (default ()) - The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned.
- dealId int? (default ()) - The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
- personId int? (default ()) - The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
- orgId int? (default ()) - The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- sort string? (default ()) - Field names and sorting mode separated by a comma (
field_name_1 ASC
,field_name_2 DESC
). Only first-level field keys are supported (no nested keys). Supported fields:id
,user_id
,deal_id
,person_id
,org_id
,content
,add_time
,update_time
.
- startDate string? (default ()) - Date in format of YYYY-MM-DD from which notes to fetch.
- endDate string? (default ()) - Date in format of YYYY-MM-DD until which notes to fetch to.
- pinnedToLeadFlag decimal? (default ()) - If set, then results are filtered by note to lead pinning state
- pinnedToDealFlag decimal? (default ()) - If set, then results are filtered by note to deal pinning state
- pinnedToOrganizationFlag decimal? (default ()) - If set, then results are filtered by note to organization pinning state
- pinnedToPersonFlag decimal? (default ()) - If set, then results are filtered by note to person pinning state
Return Type
- GetNotesResponse200|error - Get all Notes
addNote
function addNote(NoteRequest payload) returns OneNoteResponse200|error
Add a note
Parameters
- payload NoteRequest - Note request
Return Type
- OneNoteResponse200|error - Add, update or get a Note
getNote
function getNote(int id) returns OneNoteResponse200|error
Get one note
Parameters
- id int - ID of the note
Return Type
- OneNoteResponse200|error - Add, update or get a Note
updateNote
function updateNote(int id, Noterequest1 payload) returns OneNoteResponse200|error
Update a note
Return Type
- OneNoteResponse200|error - Add, update or get a Note
deleteNote
function deleteNote(int id) returns DeleteNoteResponse200|error
Delete a note
Parameters
- id int - ID of the note
Return Type
- DeleteNoteResponse200|error - Delete a Note
getNoteComments
function getNoteComments(int id, int 'start, int? 'limit) returns GetCommentsResponse200|error
Get all comments for a note
Parameters
- id int - ID of the note
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetCommentsResponse200|error - Get all Comments
addNoteComment
function addNoteComment(int id, CommentPostPutObject payload) returns OneCommentResponse200|error
Add a comment to a note
Return Type
- OneCommentResponse200|error - Add, update or get a comment
getComment
function getComment(int id, string commentId) returns OneCommentResponse200|error
Get one comment
Return Type
- OneCommentResponse200|error - Add, update or get a comment
updateCommentForNote
function updateCommentForNote(int id, string commentId, Commentpostputobject1 payload) returns OneCommentResponse200|error
Update a comment related to a note
Parameters
- id int - ID of the note
- commentId string - ID of the comment
- payload Commentpostputobject1 - CommentPostPutObject request
Return Type
- OneCommentResponse200|error - Add, update or get a comment
deleteComment
function deleteComment(int id, string commentId) returns DeleteCommentResponse200|error
Delete a comment related to a note
Return Type
- DeleteCommentResponse200|error - Delete a Comment
getNoteFields
function getNoteFields() returns GetNoteFieldsResponse200|error
Get all note fields
Return Type
- GetNoteFieldsResponse200|error - success
getOrganizations
function getOrganizations(int? userId, int? filterId, string? firstChar, int 'start, int? 'limit, string? sort) returns GetOrganizationsResponse200|error
Get all organizations
Parameters
- userId int? (default ()) - If supplied, only organizations owned by the given user will be returned. However,
filter_id
takes precedence overuser_id
when both are supplied.
- filterId int? (default ()) - ID of the filter to use
- firstChar string? (default ()) - If supplied, only organizations whose name starts with the specified letter will be returned (case insensitive).
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- sort string? (default ()) - Field names and sorting mode separated by a comma (
field_name_1 ASC
,field_name_2 DESC
). Only first-level field keys are supported (no nested keys).
Return Type
- GetOrganizationsResponse200|error - success
addOrganization
function addOrganization(AddOrganizationRequest payload) returns AddOrganizationResponse200|error
Add an organization
Parameters
- payload AddOrganizationRequest - AddOrganization request
Return Type
- AddOrganizationResponse200|error - success
deleteOrganizations
function deleteOrganizations(string ids) returns DeleteOrganizationsResponse200|error
Delete multiple organizations in bulk
Parameters
- ids string - Comma-separated IDs that will be deleted
Return Type
- DeleteOrganizationsResponse200|error - success
searchOrganization
function searchOrganization(string term, string? fields, boolean? exactMatch, int 'start, int? 'limit) returns SearchOrganizationResponse200|error
Search organizations
Parameters
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match
).
- fields string? (default ()) - A comma-separated string array. The fields to perform the search from. Defaults to all of them.
- exactMatch boolean? (default ()) - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
- 'start int (default 0) - Pagination start. Note that the pagination is based on main results and does not include related items when using
search_for_related_items
parameter.
- 'limit int? (default ()) - Items shown per page
Return Type
- SearchOrganizationResponse200|error - success
getOrganizationByName
Find organizations by name
Parameters
- term string - Search term to look for
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- json|error - success
Deprecated
getOrganization
function getOrganization(int id) returns GetOrganizationResponse200|error
Get details of an organization
Parameters
- id int - The ID of the Organization
Return Type
- GetOrganizationResponse200|error - success
updateOrganization
function updateOrganization(int id, BasicOrganization payload) returns UpdateOrganizationResponse200|error
Update an organization
Return Type
- UpdateOrganizationResponse200|error - success
deleteOrganization
function deleteOrganization(int id) returns DeleteOrganizationResponse200|error
Delete an organization
Parameters
- id int - The ID of the Organization
Return Type
- DeleteOrganizationResponse200|error - success
getOrganizationActivities
function getOrganizationActivities(int id, int 'start, int? 'limit, decimal? done, string? exclude) returns GetAssociatedActivitiesResponse200|error
List activities associated with an organization
Parameters
- id int - The ID of the Organization
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- done decimal? (default ()) - Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
- exclude string? (default ()) - A comma-separated string of activity IDs to exclude from result
Return Type
- GetAssociatedActivitiesResponse200|error - success
getOrganizationDeals
function getOrganizationDeals(int id, int 'start, int? 'limit, string status, string? sort, decimal? onlyPrimaryAssociation) returns GetAssociatedDealsResponse200|error
List deals associated with an organization
Parameters
- id int - The ID of the Organization
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- status string (default "all_not_deleted") - Only fetch deals with specific status. If omitted, all not deleted deals are fetched.
- sort string? (default ()) - Field names and sorting mode separated by a comma (
field_name_1 ASC
,field_name_2 DESC
). Only first-level field keys are supported (no nested keys).
- onlyPrimaryAssociation decimal? (default ()) - If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization.
Return Type
- GetAssociatedDealsResponse200|error - success
getOrganizationFiles
function getOrganizationFiles(int id, int 'start, int? 'limit, decimal? includeDeletedFiles, string? sort) returns GetAssociatedFilesResponse200|error
List files attached to an organization
Parameters
- id int - The ID of the Organization
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- includeDeletedFiles decimal? (default ()) - When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
- sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
Return Type
- GetAssociatedFilesResponse200|error - success
getOrganizationUpdates
function getOrganizationUpdates(int id, int 'start, int? 'limit, string? allChanges, string? items) returns GetAssociatedUpdatesResponse200|error
List updates about an organization
Parameters
- id int - The ID of the Organization
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- allChanges string? (default ()) - Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
- items string? (default ()) - A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
Return Type
- GetAssociatedUpdatesResponse200|error - Get the Organization Updates
getOrganizationFollowers
function getOrganizationFollowers(int id) returns Getassociatedfollowersresponse2001|error
List followers of an organization
Parameters
- id int - The ID of the Organization
Return Type
- Getassociatedfollowersresponse2001|error - success
addOrganizationFollower
function addOrganizationFollower(int id, AddOrganizationFollowerRequest payload) returns AddOrganizationFollowerResponse200|error
Add a follower to an organization
Parameters
- id int - The ID of the Organization
- payload AddOrganizationFollowerRequest - AddOrganizationFollower request
Return Type
- AddOrganizationFollowerResponse200|error - success
deleteOrganizationFollower
function deleteOrganizationFollower(int id, int followerId) returns DeleteOrganizationFollowerResponse200|error
Delete a follower from an organization
Return Type
- DeleteOrganizationFollowerResponse200|error - success
getOrganizationMailMessages
function getOrganizationMailMessages(int id, int 'start, int? 'limit) returns GetAssociatedMailMessagesResponse200|error
List mail messages associated with an organization
Parameters
- id int - The ID of the Organization
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetAssociatedMailMessagesResponse200|error - success
mergeOrganizations
function mergeOrganizations(int id, MergeOrganizationsRequest payload) returns MergeOrganizationsResponse200|error
Merge two organizations
Parameters
- id int - The ID of the Organization
- payload MergeOrganizationsRequest - MergeOrganizations request
Return Type
- MergeOrganizationsResponse200|error - success
getOrganizationUsers
function getOrganizationUsers(int id) returns Listpermittedusersresponse2001|error
List permitted users
Parameters
- id int - The ID of the Organization
Return Type
- Listpermittedusersresponse2001|error - success
getOrganizationPersons
function getOrganizationPersons(int id, int 'start, int? 'limit) returns ListPersonsResponse200|error
List persons of an organization
Parameters
- id int - The ID of the Organization
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- ListPersonsResponse200|error - success
getOrganizationFields
function getOrganizationFields() returns FieldsResponse200|error
Get all organization fields
Return Type
- FieldsResponse200|error - success
addOrganizationField
function addOrganizationField(Createfieldrequest1 payload) returns FieldResponse200|error
Add a new organization field
Parameters
- payload Createfieldrequest1 - CreateField request
Return Type
- FieldResponse200|error - success
deleteOrganizationFields
function deleteOrganizationFields(string ids) returns DeleteFieldsResponse200|error
Delete multiple organization fields in bulk
Parameters
- ids string - Comma-separated field IDs to delete
Return Type
- DeleteFieldsResponse200|error - success
getOrganizationField
function getOrganizationField(int id) returns FieldResponse200|error
Get one organization field
Parameters
- id int - ID of the field
Return Type
- FieldResponse200|error - success
updateOrganizationField
function updateOrganizationField(int id, Updatefieldrequest1 payload) returns FieldResponse200|error
Update an organization field
Return Type
- FieldResponse200|error - success
deleteOrganizationField
function deleteOrganizationField(int id) returns DeleteFieldResponse200|error
Delete an organization field
Parameters
- id int - ID of the field
Return Type
- DeleteFieldResponse200|error - success
getOrganizationRelationships
function getOrganizationRelationships(int orgId) returns GetOrganizationRelationshipsResponse200|error
Get all relationships for organization
Parameters
- orgId int - ID of the organization to get relationships for
Return Type
- GetOrganizationRelationshipsResponse200|error - success
addOrganizationRelationship
function addOrganizationRelationship(AddOrganizationRelationshipRequest payload) returns AddOrganizationRelationshipResponse200|error
Create an organization relationship
Parameters
- payload AddOrganizationRelationshipRequest - AddOrganizationRelationship request
Return Type
- AddOrganizationRelationshipResponse200|error - success
getOrganizationRelationship
function getOrganizationRelationship(int id, int? orgId) returns GetOrganizationRelationshipResponse200|error
Get one organization relationship
Parameters
- id int - ID of the organization relationship
- orgId int? (default ()) - ID of the base organization for the returned calculated values
Return Type
- GetOrganizationRelationshipResponse200|error - success
updateOrganizationRelationship
function updateOrganizationRelationship(int id, OrganizationRelationshipRequest payload) returns UpdateOrganizationRelationshipResponse200|error
Update an organization relationship
Parameters
- id int - ID of the organization relationship
- payload OrganizationRelationshipRequest - OrganizationRelationship request
Return Type
deleteOrganizationRelationship
function deleteOrganizationRelationship(int id) returns DeleteOrganizationRelationshipResponse200|error
Delete an organization relationship
Parameters
- id int - ID of the organization relationship
Return Type
getPermissionSets
function getPermissionSets() returns GetPermissionSetsResponse200|error
Get all Permission Sets
Return Type
- GetPermissionSetsResponse200|error - Get all permissions
getPermissionSet
function getPermissionSet(int id) returns SinglePermissionSetResponse200|error
Get one Permission Set
Parameters
- id int - ID of the permission set
Return Type
- SinglePermissionSetResponse200|error - The Permission Set of a specific User ID
getPermissionSetAssignments
function getPermissionSetAssignments(int id, int 'start, int? 'limit) returns UserAssignmentsToPermissionSetResponse200|error
List Permission Set assignments
Parameters
- id int - ID of the permission set
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- UserAssignmentsToPermissionSetResponse200|error - The Assignments of a specific User ID
getPersons
function getPersons(int? userId, int? filterId, string? firstChar, int 'start, int? 'limit, string? sort) returns GetPersonsResponse200|error
Get all persons
Parameters
- userId int? (default ()) - If supplied, only persons owned by the given user will be returned. However,
filter_id
takes precedence overuser_id
when both are supplied.
- filterId int? (default ()) - ID of the filter to use.
- firstChar string? (default ()) - If supplied, only persons whose name starts with the specified letter will be returned (case insensitive).
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- sort string? (default ()) - Field names and sorting mode separated by a comma (
field_name_1 ASC
,field_name_2 DESC
). Only first-level field keys are supported (no nested keys).
Return Type
- GetPersonsResponse200|error - success
addPerson
function addPerson(AddPersonRequest payload) returns AddPersonResponse200|error
Add a person
Parameters
- payload AddPersonRequest - AddPerson request
Return Type
- AddPersonResponse200|error - success
deletePersons
function deletePersons(string? ids) returns DeletePersonsResponse200|error
Delete multiple persons in bulk
Parameters
- ids string? (default ()) - Comma-separated IDs that will be deleted
Return Type
- DeletePersonsResponse200|error - success
searchPersons
function searchPersons(string term, string? fields, boolean? exactMatch, int? organizationId, string? includeFields, int 'start, int? 'limit) returns SearchPersonsResponse200|error
Search persons
Parameters
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match
).
- fields string? (default ()) - A comma-separated string array. The fields to perform the search from. Defaults to all of them.
- exactMatch boolean? (default ()) - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
- organizationId int? (default ()) - Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000.
- includeFields string? (default ()) - Supports including optional fields in the results which are not provided by default.
- 'start int (default 0) - Pagination start. Note that the pagination is based on main results and does not include related items when using
search_for_related_items
parameter.
- 'limit int? (default ()) - Items shown per page
Return Type
- SearchPersonsResponse200|error - success
findPersonByName
function findPersonByName(string term, int? orgId, int 'start, int? 'limit, decimal? searchByEmail) returns json|error
Find persons by name
Parameters
- term string - Search term to look for
- orgId int? (default ()) - ID of the organization person is associated with.
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- searchByEmail decimal? (default ()) - When enabled, term will only be matched against email addresses of people. Default: false
Return Type
- json|error - success
Deprecated
getPerson
function getPerson(int id) returns GetPersonResponse200|error
Get details of a person
Parameters
- id int - ID of a person
Return Type
- GetPersonResponse200|error - success
updatePerson
function updatePerson(int id, BasicPersonRequest payload) returns UpdatePersonResponse200|error
Update a person
Return Type
- UpdatePersonResponse200|error - success
deletePerson
function deletePerson(int id) returns DeletePersonResponse200|error
Delete a person
Parameters
- id int - ID of a person
Return Type
- DeletePersonResponse200|error - success
getPersonActivities
function getPersonActivities(int id, int 'start, int? 'limit, decimal? done, string? exclude) returns GetAssociatedActivitiesResponse200|error
List activities associated with a person
Parameters
- id int - ID of a person
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- done decimal? (default ()) - Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
- exclude string? (default ()) - A comma-separated string of activity IDs to exclude from result
Return Type
- GetAssociatedActivitiesResponse200|error - success
getPersonDeals
function getPersonDeals(int id, int 'start, int? 'limit, string status, string? sort) returns GetAssociatedDealsResponse200|error
List deals associated with a person
Parameters
- id int - ID of a person
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- status string (default "all_not_deleted") - Only fetch deals with specific status. If omitted, all not deleted deals are fetched.
- sort string? (default ()) - Field names and sorting mode separated by a comma (
field_name_1 ASC
,field_name_2 DESC
). Only first-level field keys are supported (no nested keys).
Return Type
- GetAssociatedDealsResponse200|error - success
getPersonFiles
function getPersonFiles(int id, int 'start, int? 'limit, decimal? includeDeletedFiles, string? sort) returns GetAssociatedFilesResponse200|error
List files attached to a person
Parameters
- id int - ID of a person
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- includeDeletedFiles decimal? (default ()) - When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
- sort string? (default ()) - Field names and sorting mode separated by a comma (
field_name_1 ASC
,field_name_2 DESC
). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
Return Type
- GetAssociatedFilesResponse200|error - success
getPersonUpdates
function getPersonUpdates(int id, int 'start, int? 'limit, string? allChanges, string? items) returns GetAssociatedPersonUpdatesResponse200|error
List updates about a person
Parameters
- id int - ID of a person
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- allChanges string? (default ()) - Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
- items string? (default ()) - A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
Return Type
- GetAssociatedPersonUpdatesResponse200|error - Get the Person Updates
getPersonFollowers
function getPersonFollowers(int id) returns GetAssociatedFollowersResponse200|error
List followers of a person
Parameters
- id int - ID of a person
Return Type
- GetAssociatedFollowersResponse200|error - success
addPersonFollower
function addPersonFollower(int id, AddPersonFollowerRequest payload) returns AddPersonFollowerResponse200|error
Add a follower to a person
Return Type
- AddPersonFollowerResponse200|error - success
deletePersonFollower
function deletePersonFollower(int id, int followerId) returns DeletePersonResponse200|error
Deletes a follower from a person.
Return Type
- DeletePersonResponse200|error - success
getPersonMailMessages
function getPersonMailMessages(int id, int 'start, int? 'limit) returns GetAssociatedMailMessagesResponse200|error
List mail messages associated with a person
Parameters
- id int - ID of a person
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetAssociatedMailMessagesResponse200|error - success
mergePersons
function mergePersons(int id, MergePersonsRequest payload) returns MergePersonsResponse200|error
Merge two persons
Return Type
- MergePersonsResponse200|error - success
getPersonUsers
function getPersonUsers(int id) returns Listpermittedusersresponse2001|error
List permitted users
Parameters
- id int - ID of a person
Return Type
- Listpermittedusersresponse2001|error - success
deletePersonPicture
function deletePersonPicture(int id) returns DeletePersonResponse200|error
Delete person picture
Parameters
- id int - ID of a person
Return Type
- DeletePersonResponse200|error - success
getPersonProducts
function getPersonProducts(int id, int 'start, int? 'limit) returns GetPersonProductsResponse200|error
List products associated with a person
Parameters
- id int - ID of a person
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetPersonProductsResponse200|error - success
getPersonFields
function getPersonFields() returns FieldsResponse200|error
Get all person fields
Return Type
- FieldsResponse200|error - success
addPersonField
function addPersonField(Createfieldrequest2 payload) returns FieldResponse200|error
Add a new person field
Parameters
- payload Createfieldrequest2 - CreateField request
Return Type
- FieldResponse200|error - success
deletePersonFields
function deletePersonFields(string ids) returns DeleteFieldsResponse200|error
Delete multiple person fields in bulk
Parameters
- ids string - Comma-separated field IDs to delete
Return Type
- DeleteFieldsResponse200|error - success
getPersonField
function getPersonField(int id) returns FieldResponse200|error
Get one person field
Parameters
- id int - ID of the field
Return Type
- FieldResponse200|error - success
updatePersonField
function updatePersonField(int id, Updatefieldrequest2 payload) returns FieldResponse200|error
Update a person field
Return Type
- FieldResponse200|error - success
deletePersonField
function deletePersonField(int id) returns DeleteFieldResponse200|error
Delete a person field
Parameters
- id int - ID of the field
Return Type
- DeleteFieldResponse200|error - success
getPipelines
function getPipelines() returns GetPipelinesResponse200|error
Get all pipelines
Return Type
- GetPipelinesResponse200|error - Get all Pipelines
addPipeline
function addPipeline(PipelineRequest payload) returns AddPipelineResponse200|error
Add a new pipeline
Parameters
- payload PipelineRequest - Pipeline request
Return Type
- AddPipelineResponse200|error - Add Pipeline
getPipeline
function getPipeline(int id, string? totalsConvertCurrency) returns GetPipelineResponse200|error
Get one pipeline
Parameters
- id int - ID of the pipeline
- totalsConvertCurrency string? (default ()) - 3-letter currency code of any of the supported currencies. When supplied,
per_stages_converted
is returned indeals_summary
which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter todefault_currency
in which case users default currency is used.
Return Type
- GetPipelineResponse200|error - Get Pipeline
updatePipeline
function updatePipeline(int id, Pipelinerequest1 payload) returns UpdatePipelineResponse200|error
Edit a pipeline
Return Type
- UpdatePipelineResponse200|error - Edit Pipeline
deletePipeline
function deletePipeline(int id) returns DeletePipelineResponse200|error
Delete a pipeline
Parameters
- id int - ID of the pipeline
Return Type
- DeletePipelineResponse200|error - Delete Pipeline
getPipelineConversionStatistics
function getPipelineConversionStatistics(int id, string startDate, string endDate, int? userId) returns GetPipelineConversionStatisticsResponse200|error
Get deals conversion rates in pipeline
Parameters
- id int - ID of the pipeline
- startDate string - Start of the period. Date in format of YYYY-MM-DD.
- endDate string - End of the period. Date in format of YYYY-MM-DD.
- userId int? (default ()) - ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
Return Type
- GetPipelineConversionStatisticsResponse200|error - Get Pipeline Deals conversion rates
getPipelineDeals
function getPipelineDeals(int id, int? filterId, int? userId, decimal? everyone, int? stageId, int 'start, int? 'limit, decimal? getSummary, string? totalsConvertCurrency) returns GetStageDealsResponse200|error
Get deals in a pipeline
Parameters
- id int - ID of the pipeline
- filterId int? (default ()) - If supplied, only deals matching the given filter will be returned.
- userId int? (default ()) - If supplied,
filter_id
will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
- everyone decimal? (default ()) - If supplied,
filter_id
anduser_id
will not be considered – instead, deals owned by everyone will be returned.
- stageId int? (default ()) - If supplied, only deals within the given stage will be returned.
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- getSummary decimal? (default ()) - Whether to include summary of the pipeline in the
additional_data
or not.
- totalsConvertCurrency string? (default ()) - 3-letter currency code of any of the supported currencies. When supplied,
per_stages_converted
is returned insidedeals_summary
insideadditional_data
which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter todefault_currency
in which case users default currency is used. Only works whenget_summary
parameter flag is enabled.
Return Type
- GetStageDealsResponse200|error - Get Deals in a Stage
getPipelineMovementStatistics
function getPipelineMovementStatistics(int id, string startDate, string endDate, int? userId) returns GetPipelineMovementStatisticsResponse200|error
Get deals movements in pipeline
Parameters
- id int - ID of the pipeline
- startDate string - Start of the period. Date in format of YYYY-MM-DD.
- endDate string - End of the period. Date in format of YYYY-MM-DD.
- userId int? (default ()) - ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
Return Type
- GetPipelineMovementStatisticsResponse200|error - Get Pipeline Deals conversion rates
getProducts
function getProducts(int? userId, int[]? ids, string? firstChar, boolean? getSummary, int 'start, int? 'limit) returns GetProductsResponse200|error
Get all products
Parameters
- userId int? (default ()) - If supplied, only Products owned by the given user will be returned
- ids int[]? (default ()) - An array of integers with the IDs of the Products that sould be returned in the response
- firstChar string? (default ()) - If supplied, only Products whose name starts with the specified letter will be returned (case insensitive)
- getSummary boolean? (default ()) - If supplied, response will return the total numbers of Products in the
additional_data.summary.total_count
property
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetProductsResponse200|error - List of products
addProduct
function addProduct(AddProductRequest payload) returns GetproductResponse200|error
Add a product
Parameters
- payload AddProductRequest - AddProduct request
Return Type
- GetproductResponse200|error - Add Product data
searchProducts
function searchProducts(string term, string? fields, boolean? exactMatch, string? includeFields, int 'start, int? 'limit) returns SearchProductsResponse200|error
Search products
Parameters
- term string - The search term to look for. Minimum 2 characters (or 1 if using
exact_match
).
- fields string? (default ()) - A comma-separated string array. The fields to perform the search from. Defaults to all of them.
- exactMatch boolean? (default ()) - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
- includeFields string? (default ()) - Supports including optional fields in the results which are not provided by default.
- 'start int (default 0) - Pagination start. Note that the pagination is based on main results and does not include related items when using
search_for_related_items
parameter.
- 'limit int? (default ()) - Items shown per page
Return Type
- SearchProductsResponse200|error - success
findProductsByName
function findProductsByName(string term, string? currency, int 'start, int? 'limit) returns FindProductsByNameResponse200|error
Find products by name
Parameters
- term string - Search term to look for, minimum 3 characters.
- currency string? (default ()) - Currency code in which prices should be returned in. If omitted, prices in user's default currency will be returned.
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- FindProductsByNameResponse200|error - Returns data about the Products that were found
Deprecated
getProduct
function getProduct(int id) returns GetproductResponse200|error
Get one product
Parameters
- id int - ID of the product
Return Type
- GetproductResponse200|error - Get product information by id
updateProduct
function updateProduct(int id, ProductRequest payload) returns UpdateProductResponse200|error
Update a product
Return Type
- UpdateProductResponse200|error - Updates Product data
deleteProduct
function deleteProduct(int id) returns DeleteProductResponse200|error
Delete a product
Parameters
- id int - ID of the product
Return Type
- DeleteProductResponse200|error - Deletes a product
getProductDeals
Get deals where a product is attached to
Parameters
- id int - ID of the product
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- status string (default "all_not_deleted") - Only fetch deals with specific status. If omitted, all not deleted deals are fetched.
getProductFiles
function getProductFiles(int id, int 'start, int? 'limit, decimal? includeDeletedFiles, string? sort) returns GetAssociatedFilesResponse200|error
List files attached to a product
Parameters
- id int - ID of the product
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- includeDeletedFiles decimal? (default ()) - When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
- sort string? (default ()) - Field names and sorting mode separated by a comma (
field_name_1 ASC
,field_name_2 DESC
). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
Return Type
- GetAssociatedFilesResponse200|error - success
getProductFollowers
function getProductFollowers(int id, int 'start, int? 'limit) returns GetProductFollowersResponseSuccess|error
List followers of a product
Parameters
- id int - ID of the product
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetProductFollowersResponseSuccess|error - Lists the followers of a Product
addProductFollower
function addProductFollower(int id, AddProductFollowerRequest payload) returns NewFollowerResponse200|error
Add a follower to a product
Return Type
- NewFollowerResponse200|error - Adds a follower to a Product
deleteProductFollower
function deleteProductFollower(int id, int followerId) returns DeleteProductFollowerResponse200|error
Delete a follower from a product
Return Type
- DeleteProductFollowerResponse200|error - Deletes a follower from a Product
getProductUsers
List permitted users
Parameters
- id int - ID of the product
getProductFields
function getProductFields() returns GetProductFieldsResponse200|error
Get all product fields
Return Type
- GetProductFieldsResponse200|error - Get data about all Product Fields
addProductField
function addProductField(ProductfieldsBody payload) returns GetProductFieldResponse200|error
Add a new product field
Parameters
- payload ProductfieldsBody - ProductField request
Return Type
- GetProductFieldResponse200|error - Get the data for a single Product Field
deleteProductFields
function deleteProductFields(string ids) returns DeleteProductFieldsResponse200|error
Delete multiple product fields in bulk
Parameters
- ids string - Comma-separated field IDs to delete
Return Type
- DeleteProductFieldsResponse200|error - Mark multiple Product Fields as deleted
getProductField
function getProductField(int id) returns GetProductFieldResponse200|error
Get one product field
Parameters
- id int - ID of the Product Field
Return Type
- GetProductFieldResponse200|error - Get the data for a single Product Field
updateProductField
function updateProductField(int id, AddOrUpdateProductFieldResponse200 payload) returns GetProductFieldResponse200|error
Update a product field
Parameters
- id int - ID of the Product Field
- payload AddOrUpdateProductFieldResponse200 - AddOrUpdateProductField request
Return Type
- GetProductFieldResponse200|error - Get the data for a single Product Field
deleteProductField
function deleteProductField(int id) returns DeleteProductFieldResponse200|error
Delete a product field
Parameters
- id int - ID of the Product Field
Return Type
- DeleteProductFieldResponse200|error - Delete a Product Field
getRecents
function getRecents(string sinceTimestamp, string? items, int 'start, int? 'limit) returns GetRecentsResponse200|error
Get recents
Parameters
- sinceTimestamp string - Timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
- items string? (default ()) - Multiple selection of item types to include in query (optional)
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetRecentsResponse200|error - List of items changed since "since_timestamp"
getRoles
function getRoles(int 'start, int? 'limit) returns GetRolesResponse200|error
Get all roles
Return Type
- GetRolesResponse200|error - Get all roles
addRole
function addRole(AddRoleRequest payload) returns AddRoleResponse200|error
Add a role
Parameters
- payload AddRoleRequest - AddRole request
Return Type
- AddRoleResponse200|error - Add a role
getRole
function getRole(int id) returns GetRoleResponse200|error
Get one role
Parameters
- id int - ID of the role
Return Type
- GetRoleResponse200|error - Get one role
updateRole
function updateRole(int id, BaseRoleRequest payload) returns UpdateRoleResponse200|error
Update role details
Return Type
- UpdateRoleResponse200|error - Update role details
deleteRole
function deleteRole(int id) returns DeleteRoleResponse200|error
Delete a role
Parameters
- id int - ID of the role
Return Type
- DeleteRoleResponse200|error - Delete a role
getRoleAssignments
function getRoleAssignments(int id, int 'start, int? 'limit) returns GetUserRoleAssignmentsResponse200|error
List role assignments
Parameters
- id int - ID of the role
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetUserRoleAssignmentsResponse200|error - List assignments for a role
addRoleAssignment
function addRoleAssignment(int id, AddRoleAssignmentRequest payload) returns AddRoleAssignmentResponse200|error
Add role assignment
Return Type
- AddRoleAssignmentResponse200|error - Add assignment for a role
deleteRoleAssignment
function deleteRoleAssignment(int id) returns DeleteRoleAssignmentResponse200|error
Delete a role assignment
Parameters
- id int - ID of the role
Return Type
- DeleteRoleAssignmentResponse200|error - Delete assignment from a role
getRoleSubRoles
function getRoleSubRoles(int id, int 'start, int? 'limit) returns GetRoleSubrolesResponse200|error
List role sub-roles
Parameters
- id int - ID of the role
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetRoleSubrolesResponse200|error - List role sub-roles
getRoleSettings
function getRoleSettings(int id) returns GetRoleSettingsResponse200|error
List role settings
Parameters
- id int - ID of the role
Return Type
- GetRoleSettingsResponse200|error - List role settings
addOrUpdateRoleSetting
function addOrUpdateRoleSetting(int id, AddOrUpdateRoleSettingRequest payload) returns AddOrUpdateRoleSettingResponse200|error
Add or update role setting
Parameters
- id int - ID of the role
- payload AddOrUpdateRoleSettingRequest - AddOrUpdateRoleSetting request
Return Type
- AddOrUpdateRoleSettingResponse200|error - List role settings
search
function search(string term, string? itemType, int 'start, int? 'limit, decimal? exactMatch) returns json|error
Perform a search
Parameters
- term string - Search term to look for, minimum 2 characters.
- itemType string? (default ()) - Search for items of exact type. If omitted, all types of items are searched.
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
- exactMatch decimal? (default ()) - When enabled, only full exact matches against the given term are returned. The minimum 2 character limit for the term is discarded when exact_match is enabled. It will only work if search term is 30 characters or less.
Return Type
- json|error - success
Deprecated
searchByField
function searchByField(string term, string fieldType, string fieldKey, decimal? exactMatch, string? returnFieldKey, decimal? returnItemIds, int 'start, int? 'limit) returns json|error
Perform a search using a specific field value
Parameters
- term string - Search term to look for, minimum 2 characters.
- fieldType string - Type of the field to perform the search from.
- fieldKey string - Key of the field to search from. Field key can be obtained by fetching the list of fields using any of fields API GET methods (dealFields, personFields, ..).
- exactMatch decimal? (default ()) - When enabled, only full exact matches against the given term are returned. By default, term can be present anywhere in the resulting field values to be considered a match. The minimum 2 character limit for the term is discarded when exact_match is enabled.
- returnFieldKey string? (default ()) - Name of the field in search results from which the search was performed. When omitted, 'value' will be used. You may want to set this parameter to match the field_key.
- returnItemIds decimal? (default ()) - Whether to return matching items IDs in search results. When omitted or set to 0, only distinct values of the searched field are returned. When enabled, the return_field_key parameter is ignored and the results include the searched field as its own key.
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- json|error - success
Deprecated
getStages
function getStages(int? pipelineId) returns GetStagesResponse200|error
Get all stages
Parameters
- pipelineId int? (default ()) - The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.
Return Type
- GetStagesResponse200|error - Get all Stages
addStage
function addStage(AddStageRequest payload) returns StageResponse200|error
Add a new stage
Parameters
- payload AddStageRequest - AddStage request
Return Type
- StageResponse200|error - Get all Stages
deleteStages
function deleteStages(string ids) returns DeleteStagesResponse200|error
Delete multiple stages in bulk
Parameters
- ids string - Comma-separated stage IDs to delete
Return Type
- DeleteStagesResponse200|error - Delete multiple Stages
getStage
function getStage(int id) returns GetStageResponse200|error
Get one stage
Parameters
- id int - ID of the stage
Return Type
- GetStageResponse200|error - Get Stage
updateStage
function updateStage(int id, UpdateStageRequest payload) returns StageResponse200|error
Update stage details
Return Type
- StageResponse200|error - Get all Stages
deleteStage
function deleteStage(int id) returns DeleteStageResponse200|error
Delete a stage
Parameters
- id int - ID of the stage
Return Type
- DeleteStageResponse200|error - Delete Stage
getStageDeals
function getStageDeals(int id, int? filterId, int? userId, decimal? everyone, int 'start, int? 'limit) returns GetStageDealsResponse200|error
Get deals in a stage
Parameters
- id int - ID of the stage
- filterId int? (default ()) - If supplied, only deals matching the given filter will be returned.
- userId int? (default ()) - If supplied,
filter_id
will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
- everyone decimal? (default ()) - If supplied,
filter_id
anduser_id
will not be considered – instead, deals owned by everyone will be returned.
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetStageDealsResponse200|error - Get Deals in a Stage
getSubscription
function getSubscription(int id) returns SubscriptionsIdResponse200|error
Get details of a subscription
Parameters
- id int - ID of the Subscription
Return Type
- SubscriptionsIdResponse200|error - success
deleteSubscription
function deleteSubscription(int id) returns SubscriptionsIdResponse200|error
Delete a subscription
Parameters
- id int - ID of the Subscription
Return Type
- SubscriptionsIdResponse200|error - success
findSubscriptionByDeal
function findSubscriptionByDeal(int dealId) returns SubscriptionsIdResponse200|error
Find subscription by deal
Parameters
- dealId int - ID of the Deal
Return Type
- SubscriptionsIdResponse200|error - success
getSubscriptionPayments
function getSubscriptionPayments(int id) returns PaymentResponse200|error
Get all payments of a Subscription
Parameters
- id int - ID of the Subscription
Return Type
- PaymentResponse200|error - success
addRecurringSubscription
function addRecurringSubscription(AddRecurringSubscriptionRequest payload) returns SubscriptionsIdResponse200|error
Add a recurring subscription
Parameters
- payload AddRecurringSubscriptionRequest - AddRecurringSubscription request
Return Type
- SubscriptionsIdResponse200|error - success
addSubscriptionInstallment
function addSubscriptionInstallment(AddSubscriptionInstallmentRequest payload) returns SubscriptionsIdResponse200|error
Add an installment subscription
Parameters
- payload AddSubscriptionInstallmentRequest - AddSubscriptionInstallment request
Return Type
- SubscriptionsIdResponse200|error - success
updateRecurringSubscription
function updateRecurringSubscription(int id, UpdateRecurringSubscriptionRequest payload) returns SubscriptionsIdResponse200|error
Update a recurring subscription
Parameters
- id int - ID of the Subscription
- payload UpdateRecurringSubscriptionRequest - UpdateRecurringSubscription request
Return Type
- SubscriptionsIdResponse200|error - success
updateSubscriptionInstallment
function updateSubscriptionInstallment(int id, UpdateSubscriptionInstallmentRequest payload) returns SubscriptionsIdResponse200|error
Update an installment subscription
Parameters
- id int - ID of the Subscription
- payload UpdateSubscriptionInstallmentRequest - UpdateSubscriptionInstallment request
Return Type
- SubscriptionsIdResponse200|error - success
cancelRecurringSubscription
function cancelRecurringSubscription(int id, CancelRecurringSubscriptionRequest payload) returns SubscriptionsIdResponse200|error
Cancel a recurring subscription
Parameters
- id int - ID of the Subscription
- payload CancelRecurringSubscriptionRequest - CancelRecurringSubscription request
Return Type
- SubscriptionsIdResponse200|error - success
getTeams
function getTeams(string orderBy, decimal skipUsers) returns TeamsResponse200|error
Get all teams
Parameters
- orderBy string (default "id") - Field name to sort returned teams by
- skipUsers decimal (default 1) - When enabled, the teams will not include IDs of member users
Return Type
- TeamsResponse200|error - The list of team objects
addTeam
function addTeam(AddTeamRequest payload) returns TeamResponse200|error
Add a new team
Parameters
- payload AddTeamRequest - AddTeam request
Return Type
- TeamResponse200|error - The team data
getTeam
function getTeam(int id, decimal skipUsers) returns TeamResponse200|error
Get a single team
Parameters
- id int - ID of the team
- skipUsers decimal (default 1) - When enabled, the teams will not include IDs of member users
Return Type
- TeamResponse200|error - The team data
updateTeam
function updateTeam(int id, UpdateTeamRequest payload) returns TeamResponse200|error
Update a team
Return Type
- TeamResponse200|error - The team data
getTeamUsers
Get all users in a team
Parameters
- id int - ID of the team
addTeamUser
function addTeamUser(int id, AddTeamUserRequest payload) returns UserIds|error
Add users to a team
deleteTeamUser
Delete users from a team
Parameters
- id int - ID of the team
getUserTeams
function getUserTeams(int id, string orderBy, decimal skipUsers) returns TeamsResponse200|error
Get all teams of a user
Parameters
- id int - ID of the user
- orderBy string (default "id") - Field name to sort returned teams by
- skipUsers decimal (default 1) - When enabled, the teams will not include IDs of member users
Return Type
- TeamsResponse200|error - The list of team objects
getUsers
function getUsers() returns UsersResponse200|error
Get all users
Return Type
- UsersResponse200|error - The list of user objects
addUser
function addUser(AddUserRequest payload) returns UserResponse200|error
Add a new user
Parameters
- payload AddUserRequest - AddUser request
Return Type
- UserResponse200|error - The data of the User
findUsersByName
function findUsersByName(string term, decimal searchByEmail) returns UsersResponse200|error
Find users by name
Parameters
- term string - Search term to look for
- searchByEmail decimal (default 1) - When enabled, term will only be matched against email addresses of users. Default:
false
Return Type
- UsersResponse200|error - The list of user objects
getCurrentUser
function getCurrentUser() returns GetCurrentUserResponse200|error
Get current user data
Return Type
- GetCurrentUserResponse200|error - The data of the logged in user
getUser
function getUser(int id) returns UserResponse200|error
Get one user
Parameters
- id int - ID of the user
Return Type
- UserResponse200|error - The data of the User
updateUser
function updateUser(int id, UpdateUserRequest payload) returns UserResponse200|error
Update user details
Return Type
- UserResponse200|error - The data of the User
getUserFollowers
List followers of a user
Parameters
- id int - ID of the user
getUserPermissions
function getUserPermissions(int id) returns GetUserPermissionsResponse200|error
List user permissions
Parameters
- id int - ID of the user
Return Type
- GetUserPermissionsResponse200|error - The list of User permissions
getUserRoleAssignments
function getUserRoleAssignments(int id, int 'start, int? 'limit) returns GetUserRoleAssignmentsResponse200|error
List role assignments
Parameters
- id int - ID of the user
- 'start int (default 0) - Pagination start
- 'limit int? (default ()) - Items shown per page
Return Type
- GetUserRoleAssignmentsResponse200|error - List assignments for a role
addUserRoleAssignment
function addUserRoleAssignment(int id, AddUserRoleAssignmentRequest payload) returns AddRoleAssignmentResponse200|error
Add role assignment
Parameters
- id int - ID of the user
- payload AddUserRoleAssignmentRequest - AddUserRoleAssignment request
Return Type
- AddRoleAssignmentResponse200|error - Add assignment for a role
deleteUserRoleAssignment
function deleteUserRoleAssignment(int id) returns DeleteRoleAssignmentResponse200|error
Delete a role assignment
Parameters
- id int - ID of the user
Return Type
- DeleteRoleAssignmentResponse200|error - Delete assignment from a role
getUserRoleSettings
function getUserRoleSettings(int id) returns GetRoleSettingsResponse200|error
List user role settings
Parameters
- id int - ID of the user
Return Type
- GetRoleSettingsResponse200|error - List role settings
getUserConnections
function getUserConnections() returns UserConnectionsResponse200|error
Get all user connections
Return Type
- UserConnectionsResponse200|error - The data of user connections
getUserSettings
function getUserSettings() returns GetUserSettingsResponse200|error
List settings of an authorized user
Return Type
- GetUserSettingsResponse200|error - The list of user settings
getWebhooks
function getWebhooks() returns GetWebhooksResponse200|error
Get all webhooks
Return Type
- GetWebhooksResponse200|error - The list of webhooks objects from the logged in company and user
addWebhook
function addWebhook(AddWebhookRequest payload) returns WebhookResponse200|error
Create a new webhook
Parameters
- payload AddWebhookRequest - AddWebhook request
Return Type
- WebhookResponse200|error - The created webhook object
deleteWebhook
function deleteWebhook(int id) returns BaseResponse200|error
Delete existing webhook
Parameters
- id int - The ID of the webhook to delete
Return Type
- BaseResponse200|error - The webhook deletion success response
Records
pipedrive: ActivityDistributionDataWithAdditionalData
Fields
- Fields Included from *ActivityDistributionDataWithAdditionalData1
- activity_distribution Activitydistributiondatawithadditionaldata1ActivityDistribution|()
- anydata...
- Fields Included from *ActivityDistributionDataWithAdditionalData2
pipedrive: ActivityDistributionDataWithAdditionalData1
Fields
- activity_distribution Activitydistributiondatawithadditionaldata1ActivityDistribution? - The distribution of Activities related to the Organization grouped by the User ID
pipedrive: Activitydistributiondatawithadditionaldata1ActivityDistribution
The distribution of Activities related to the Organization grouped by the User ID
Fields
- ASSIGNED_TO_USER_ID Activitydistributiondatawithadditionaldata1ActivityDistributionAssignedToUserId? - The ID of the User
pipedrive: Activitydistributiondatawithadditionaldata1ActivityDistributionAssignedToUserId
The ID of the User
Fields
- activities Activitydistributiondatawithadditionaldata1ActivityDistributionAssignedToUserIdActivities? - The count of Activities related to the User grouped by Activity type
- name string? - The name of the User
- activity_count int? - The overall count of Activities for the User
- share int? - The percentage of Activities belongs to the User
pipedrive: Activitydistributiondatawithadditionaldata1ActivityDistributionAssignedToUserIdActivities
The count of Activities related to the User grouped by Activity type
Fields
- ACTIVITY_TYPE_NAME int? - The count of Activities related to a specific type
pipedrive: ActivityDistributionDataWithAdditionalData2
The additional data of the list
Fields
- 'start int? - Pagination start
- 'limit int? - Items shown per page
- more_items_in_collection boolean? - If there are more list items in the collection than displayed or not
pipedrive: ActivityResponseObject1
Fields
- due_date string? - Due date of the Activity. Format: YYYY-MM-DD
- due_time string? - Due time of the Activity in UTC. Format: HH:MM
- duration string? - Duration of the Activity. Format: HH:MM
- deal_id int? - The ID of the Deal this Activity is associated with
- person_id int? - The ID of the Person this Activity is associated with
- org_id int? - The ID of the Organization this Activity is associated with
- note string? - Note of the Activity (HTML format)
- location string? - The address of the Activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.
- public_description string? - Additional details about the Activity that is synced to your external calendar. Unlike the note added to the Activity, the description is publicly visible to any guests added to the Activity.
pipedrive: ActivityResponseObject2
Fields
- id int? - The Activity ID, generated when the Activity was created
- done boolean? - Whether the Activity is done or not
- subject string? - Subject of the Activity
- 'type string? - Type of the Activity. This is in correlation with the
key_string
parameter of ActivityTypes.
- user_id int? - The ID of the User whom the Activity is assigned to
- participants record {}[]? - List of multiple Persons (participants) this Activity is associated with
- busy_flag boolean? - Marks if the Activity is set as 'Busy' or 'Free'. If the flag is set to
true
, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (null
), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time.
- attendees record {}[]? - Attendees of the Activity. This can be either your existing Pipedrive contacts or an external email address.
- company_id int? - The User's company ID
- reference_type string? - If the Activity references some other object, it is indicated here. For example, value
Salesphone
refers to Activities created with Caller.
- reference_id int? - Together with the
reference_type
, gives the ID of the other object
- conference_meeting_client string? - The ID of Marketplace app, which is connected to this Activity
- conference_meeting_url string? - The link to join the meeting which is associated with this Activity
- conference_meeting_id string? - The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this Activity
- add_time string? - The creation date and time of the Activity in UTC. Format: YYYY-MM-DD HH:MM:SS.
- marked_as_done_time string? - The date and time this Activity was marked as done. Format: YYYY-MM-DD HH:MM:SS.
- last_notification_time string? - The date and time of latest notifications sent about this Activity to the participants or the attendees of this Activity
- last_notification_user_id int? - The ID of the User who triggered the sending of the latest notifications about this Activity to the participants or the attendees of this Activity
- notification_language_id int? - The ID of the language the notifications are sent in
- lead_id string? - The ID of the Lead in the UUID format this Activity is associated with
- active_flag boolean? - Whether the Activity is active or not
- update_time string? - The last update date and time of the Activity. Format: YYYY-MM-DD HH:MM:SS.
- update_user_id int? - The ID of the User who was the last to update this Activity
- gcal_event_id string? - For the Activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon.
- google_calendar_id string? - The Google calendar ID that this Activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon.
- google_calendar_etag string? - The Google calendar API etag (version) that is used for syncing this Activity. NB! This field is related to old Google calendar sync and will be deprecated soon.
- calendar_sync_include_context string? - For Activities that sync to an external calendar, this setting indicates if the Activity syncs with context (what are the Deals, Persons, Organizations this Activity is related to)
- source_timezone string? - The timezone the Activity was created in an external calendar
- rec_rule string? - The rule for the recurrence of the Activity. Is important for activities synced into Pipedrive from an external calendar. Example: "RRULE:FREQ=WEEKLY;BYDAY=WE"
- rec_rule_extension string? - Additional rules for the recurrence of the Activity, extend the
rec_rule
. Is important for activities synced into Pipedrive from an external calendar.
- rec_master_activity_id int? - The ID of parent Activity for a recurrent Activity if the current Activity is an exception to recurrence rules
- series record {}[]? - The list of recurring Activity instances. It is in a structure as follows:
[{due_date: "2020-06-24", due_time: "10:00:00"}]
- created_by_user_id int? - The ID of the User who created the Activity
- location_subpremise string? - Subfield of location field. Indicates apartment/suite number.
- location_street_number string? - Subfield of location field. Indicates house number.
- location_route string? - Subfield of location field. Indicates street name.
- location_sublocality string? - Subfield of location field. Indicates district/sublocality.
- location_locality string? - Subfield of location field. Indicates city/town/village/locality.
- location_admin_area_level_1 string? - Subfield of location field. Indicates state/county.
- location_admin_area_level_2 string? - Subfield of location field. Indicates region.
- location_country string? - Subfield of location field. Indicates country.
- location_postal_code string? - Subfield of location field. Indicates ZIP/postal code.
- location_formatted_address string? - Subfield of location field. Indicates full/combined address.
- location_lat decimal? - Subfield of location field. Indicates latitude.
- location_long decimal? - Subfield of location field. Indicates longitude.
- org_name string? - Name of the Organization this Activity is associated with
- person_name string? - Name of the Person this Activity is associated with
- deal_title string? - Name of the Deal this Activity is associated with
- owner_name string? - Name of the User this Activity is owned by
- person_dropbox_bcc string? - The bcc email address of the Person
- deal_dropbox_bcc string? - The bcc email address of the Deal
- assigned_to_user_id int? - The ID of the User to whom the Activity is assigned to. Equal to
user_id
.
- file record {}? - The file that is attached to this Activity. For example, this can be a reference to an audio note file generated with Pipedrive mobile app.
pipedrive: ActivityResponseObjectData
Fields
- Fields Included from *ActivityResponseObject1
- Fields Included from *ActivityResponseObject2
- id int|()
- done boolean|()
- subject string|()
- type string|()
- user_id int|()
- participants record { anydata... }[]|()
- busy_flag boolean|()
- attendees record { anydata... }[]|()
- company_id int|()
- reference_type string|()
- reference_id int|()
- conference_meeting_client string|()
- conference_meeting_url string|()
- conference_meeting_id string|()
- add_time string|()
- marked_as_done_time string|()
- last_notification_time string|()
- last_notification_user_id int|()
- notification_language_id int|()
- lead_id string|()
- active_flag boolean|()
- update_time string|()
- update_user_id int|()
- gcal_event_id string|()
- google_calendar_id string|()
- google_calendar_etag string|()
- calendar_sync_include_context string|()
- source_timezone string|()
- rec_rule string|()
- rec_rule_extension string|()
- rec_master_activity_id int|()
- series record { anydata... }[]|()
- created_by_user_id int|()
- location_subpremise string|()
- location_street_number string|()
- location_route string|()
- location_sublocality string|()
- location_locality string|()
- location_admin_area_level_1 string|()
- location_admin_area_level_2 string|()
- location_country string|()
- location_postal_code string|()
- location_formatted_address string|()
- location_lat decimal|()
- location_long decimal|()
- org_name string|()
- person_name string|()
- deal_title string|()
- owner_name string|()
- person_dropbox_bcc string|()
- deal_dropbox_bcc string|()
- assigned_to_user_id int|()
- file record { anydata... }
- anydata...
pipedrive: AddActivityRequest
Fields
- due_date string? - Due date of the Activity. Format: YYYY-MM-DD
- due_time string? - Due time of the Activity in UTC. Format: HH:MM
- duration string? - Duration of the Activity. Format: HH:MM
- deal_id int? - The ID of the Deal this Activity is associated with
- person_id int? - The ID of the Person this Activity is associated with
- org_id int? - The ID of the Organization this Activity is associated with
- note string? - Note of the Activity (HTML format)
- location string? - The address of the Activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.
- public_description string? - Additional details about the Activity that is synced to your external calendar. Unlike the note added to the Activity, the description is publicly visible to any guests added to the Activity.
- subject string? - Subject of the Activity. When value for subject is not set, it will be given a default value
Call
.
- 'type string? - Type of the Activity. This is in correlation with the
key_string
parameter of ActivityTypes. When value for type is not set, it will be given a default valueCall
.
- user_id int? - The ID of the User whom the Activity is assigned to. If omitted, the Activity is assigned to the authorized User.
- participants record {}[]? - List of multiple Persons (participants) this Activity is associated with. If omitted, single participant from
person_id
field is used. It requires a structure as follows:[{"person_id":1,"primary_flag":true}]
- busy_flag boolean? - Set the Activity as 'Busy' or 'Free'. If the flag is set to
true
, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it withnull
. When the value of the flag is unset (null
), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time.
- attendees record {}[]? - Attendees of the Activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows:
[{"email_address":"mail@example.org"}]
or[{"person_id":1, "email_address":"mail@example.org"}]
- done record {}? - Whether the Activity is done or not. 0 = Not done, 1 = Done
pipedrive: AddActivityResponse200
Fields
- success boolean? -
- data ActivityResponseObjectData? -
- additional_data Addactivityresponse200AdditionalData? -
- related_objects Addactivityresponse200RelatedObjects? -
pipedrive: Addactivityresponse200AdditionalData
Fields
- updates_story_id int? - This field will be deprecated
pipedrive: Addactivityresponse200RelatedObjects
Fields
- organization Addactivityresponse200RelatedObjectsOrganization? -
pipedrive: Addactivityresponse200RelatedObjectsOrganization
Fields
pipedrive: Addactivityresponse200RelatedObjectsPerson
Fields
pipedrive: AddActivityTypeRequest
Fields
- name string - The name of the ActivityType
- icon_key string - Icon graphic to use for representing this activity type.
- color string? - A designated color for the ActivityType in 6-character HEX format (e.g.
FFFFFF
for white,000000
for black)
pipedrive: AddCallLogRequest
Fields
- user_id int? - The ID of the owner of the call log
- activity_id int? - If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify
deal_id
,person_id
ororg_id
, as they will be ignored in favor of the values already available in the activity.
- subject string? - Name of the activity this call is attached to
- duration string? - Call duration in seconds
- outcome string - Describes the outcome of the call
- from_phone_number string? - The number that made the call
- to_phone_number string - The number called
- start_time string - The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.
- end_time string - The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.
- person_id int? - The ID of the Person this call is associated with
- org_id int? - The ID of the Organization this call is associated with
- deal_id int? - The ID of the Deal this call is associated with
- note string? - Note for the call log in HTML format
pipedrive: AddCallLogResponse200
Fields
- success boolean? - If the response is successful or not
- data ResponseCallLogObject? -
pipedrive: AddDealFollowerRequest
Fields
- user_id int - ID of the user
pipedrive: AddDealFollowerResponse200
Fields
- success boolean? - If the response is successful or not
- data Adddealfollowerresponse200Data? -
pipedrive: Adddealfollowerresponse200Data
Fields
- user_id int? - The User ID who added the Follower
- id int? - The Follower ID
- deal_id int? - The ID of the Deal which the Follower was added to
- add_time string? - The date and time when the Deal Follower was added
pipedrive: AddDealParticipantRequest
Fields
- person_id int - ID of the person
pipedrive: AddDealParticipantResponse200
Fields
- success boolean? - If the request was successful or not
- data PersonItem? - The object of Participant
- related_objects Getdealsresponse200RelatedObjects? -
pipedrive: AddDealProductRequest
Fields
- item_price decimal? - Price at which this product will be added to the deal
- quantity int? - Quantity – e.g. how many items of this product will be added to the deal
- discount_percentage decimal? - Discount %. If omitted, will be set to 0
- duration decimal? - Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)
- product_variation_id int? - ID of the product variation to use. When omitted, no variation will be used.
- comments string? - Any textual comment associated with this product-deal attachment. Visible and editable in the application UI.
- enabled_flag record {}? - Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.
- product_id int - ID of the product that will be attached
pipedrive: AddDealRequest
Fields
- title string? - Deal title
- value string? - Value of the deal. If omitted, value will be set to 0.
- currency string? - Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.
- user_id int? - ID of the user who will be marked as the owner of this deal. If omitted, the authorized user ID will be used.
- person_id int? - ID of the person this deal will be associated with
- org_id int? - ID of the organization this deal will be associated with
- stage_id int? - ID of the stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on
stage_id
). If omitted, the deal will be placed in the first stage of the default pipeline.
- status string? - open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open.
- expected_close_date string? - The expected close date of the Deal. In ISO 8601 format: YYYY-MM-DD.
- probability decimal? - Deal success probability percentage. Used/shown only when
deal_probability
for the pipeline of the deal is enabled.
- lost_reason string? - Optional message about why the deal was lost (to be used when status=lost)
- visible_to record {}? - Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td></tr><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
- add_time string? - Optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
pipedrive: AddFileAndLinkItRequest
Fields
- file_type string - The file type
- title string - The title of the file
- item_type string - The item type
- item_id int - ID of the item to associate the file with
- remote_location string - The location type to send the file to. Only
googledrive
is supported at the moment.
pipedrive: AddFileAndLinkItResponse200
Fields
- success boolean? - If the request was successful or not
- data Getassociatedfilesresponse200Data? - The File data
pipedrive: AddFilterRequest
Fields
- name string - The name of the filter
- conditions record {} - The conditions of the filter as a JSON object. It requires a minimum structure as follows: {"glue":"and","conditions":[{"glue":"and","conditions": [CONDITION_OBJECTS]},{"glue":"or","conditions":[CONDITION_OBJECTS]}]}. Replace CONDITION_OBJECTS with JSON objects of the following structure: {"object":"","field_id":"", "operator":"","value":"", "extra_value":""} or leave the array empty. Depending on the object type you should use another API endpoint to get field_id. There are five types of objects you can choose from: "person", "deal", "organization", "product", "activity" and you can use these types of operators depending on what type of a field you have: "IS NOT NULL", "IS NULL", "<=", ">=", "<", ">", "!=", "=", "LIKE '%$%'", "NOT LIKE '%$%'", "LIKE '$%'", "NOT LIKE '$%'", "LIKE '%$'", "NOT LIKE '%$'". To get a better understanding of how filters work try creating them directly from the Pipedrive application.
- 'type record {} - The type of filter to create
pipedrive: AddGoalRequest
Fields
- title string? - Title of the goal.
- assignee record {}? - Who is this goal assigned to. It requires the following JSON structure: { "id": "1", "type": "person" }.
type
can be eitherperson
,company
orteam
. ID of the assignee person, company or team.
- 'type record {}? - Type of the goal. It requires the following JSON structure: { "name": "deals_started", "params": { "pipeline_id": 1 } }. Type can be one of:
deals_won
,deals_progressed
,activities_completed
,activities_added
,deals_started
orrevenue_forecast
.params
can includepipeline_id
,stage_id
oractivity_type_id
.stage_id
is related to onlydeals_progressed
type of goals andactivity_type_id
toactivities_completed
oractivities_added
types of goals. To track goal in all pipelines setpipeline_id
asnull
.
- expected_outcome record {}? - Expected outcome of the goal. Expected outcome can be tracked either by
quantity
or bysum
. It requires the following JSON structure: { "target": "50", "tracking_metric": "quantity" } or { "target": "50", "tracking_metric": "sum", "currency_id": 1 }.currency_id
should only be added tosum
type of goals.
- duration record {}? - Date when the goal starts and ends. It requires the following JSON structure: { "start": "2019-01-01", "end": "2022-12-31" }. Date in format of YYYY-MM-DD. "end" can be set to
null
for an infinite, open-ended goal.
- interval string? - Interval of the goal
pipedrive: AdditionalBaseOrganizationItemInfo
Fields
- Fields Included from *OrganizationCountAndAddressInfo
- email_messages_count int|()
- people_count int|()
- activities_count int|()
- done_activities_count int|()
- undone_activities_count int|()
- files_count int|()
- notes_count int|()
- followers_count int|()
- address string|()
- address_subpremise string|()
- address_street_number string|()
- address_route string|()
- address_sublocality string|()
- address_locality string|()
- address_admin_area_level_1 string|()
- address_admin_area_level_2 string|()
- address_country string|()
- address_postal_code string|()
- address_formatted_address string|()
- anydata...
- Fields Included from *DealsCountAndActivityInfo
- open_deals_count int|()
- related_open_deals_count int|()
- closed_deals_count int|()
- related_closed_deals_count int|()
- won_deals_count int|()
- related_won_deals_count int|()
- lost_deals_count int|()
- related_lost_deals_count int|()
- next_activity_date string|()
- next_activity_time string|()
- next_activity_id int|()
- last_activity_id int|()
- last_activity_date string|()
- anydata...
pipedrive: AdditionalData1
Fields
- products_quantity_total int? - Total quantity of the Products
- products_sum_total int? - Total sum of the Products
- variations_enabled boolean? - Is variations enabled or not
- products_quantity_total_formatted string? - Total formatted quantity of the Products
- products_sum_total_formatted string? - Total formatted sum of the Products
pipedrive: AdditionalData2
Fields
- pagination Additionaldata2Pagination? - Pagination details of the list
pipedrive: Additionaldata2Pagination
Pagination details of the list
Fields
- 'start int? - Pagination start
- 'limit int? - Items shown per page
- more_items_in_collection boolean? - Whether there are more list items in the collection than displayed
- next_start int? - Next pagination start
pipedrive: AdditionalPersonInfo
Fields
- Fields Included from *PersonNameInfoWithOrgAndOwnerId
- owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
- org_id record { name string|(), people_count int|(), owner_id int|(), address string|(), cc_email string|(), value int|(), active_flag boolean|(), anydata... }
- name string|()
- first_name string|()
- last_name string|()
- anydata...
- Fields Included from *PersonCountEmailDealAndActivityInfo
- email_messages_count int|()
- activities_count int|()
- done_activities_count int|()
- undone_activities_count int|()
- files_count int|()
- notes_count int|()
- followers_count int|()
- last_incoming_mail_time string|()
- last_outgoing_mail_time string|()
- open_deals_count int|()
- related_open_deals_count int|()
- closed_deals_count int|()
- related_closed_deals_count int|()
- won_deals_count int|()
- related_won_deals_count int|()
- lost_deals_count int|()
- related_lost_deals_count int|()
- next_activity_date string|()
- next_activity_time string|()
- next_activity_id int|()
- last_activity_id int|()
- last_activity_date string|()
- anydata...
pipedrive: AddLeadLabelRequest
Fields
- name string - The name of the Lead Label
- color string - The color of the label. Only a subset of colors can be used.
pipedrive: AddLeadRequest
Fields
- title string - The name of the Lead
- owner_id int? - The ID of the User which will be the owner of the created Lead. If not provided, the user making the request will be used.
- label_ids string[]? - The IDs of the Lead Labels which will be associated with the Lead
- person_id int? - The ID of a Person which this Lead will be linked to. If the Person does not exist yet, it needs to be created first. This property is required unless
organization_id
is specified.
- organization_id int? - The ID of an Organization which this Lead will be linked to. If the Organization does not exist yet, it needs to be created first. This property is required unless
person_id
is specified.
- value LeadsValue? - The potential value of the Lead.
- expected_close_date string? - The date of when the Deal which will be created from the Lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.
- visible_to record {}? - Visibility of the Lead. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td></tr><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
- was_seen boolean? - A flag indicating whether the Lead was seen by someone in the Pipedrive UI
pipedrive: AddOrganizationFollowerRequest
Fields
- user_id int - The ID of the user
pipedrive: AddOrganizationFollowerResponse200
Fields
- success boolean? - If the request was successful or not
- data OrganizationFollower? -
pipedrive: AddOrganizationRelationshipRequest
Fields
- org_id int? - ID of the base organization for the returned calculated values
- 'type string? - The type of organization relationship
- rel_owner_org_id int? - The owner of this relationship. If type is
parent
, then the owner is the parent and the linked organization is the daughter.
- rel_linked_org_id int? - The linked organization in this relationship. If type is
parent
, then the linked organization is the daughter.
pipedrive: AddOrganizationRelationshipResponse200
Fields
- success boolean? - If the response is successful or not
- related_objects Getorganizationrelationshipsresponse200RelatedObjects? -
pipedrive: Addorganizationrelationshipresponse200Data
Fields
- id int? - The ID of the Organization Relationship
- 'type string? - The type of the Relationship
- rel_owner_org_id record {}? -
- rel_linked_org_id record {}? -
- add_time string? - The creation date and time of the Relationship
- update_time string? - The last updated date and time of the Relationship
- active_flag string? - If the Relationship is active or not
pipedrive: AddOrganizationRequest
Fields
- name string? - Organization name
- owner_id int? - The ID of the user who will be marked as the owner of this Organization. When omitted, the authorized User ID will be used.
- visible_to record {}? - Visibility of the organization. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td></tr><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
- add_time string? - Optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
pipedrive: AddOrganizationResponse200
Fields
- success boolean? - If the response is successful or not
- related_objects Getorganizationsresponse200RelatedObjects? -
pipedrive: AddOrUpdateGoalResponse200
Fields
- success boolean? - If the request was successful or not
- data Addorupdategoalresponse200Data? -
pipedrive: Addorupdategoalresponse200Data
Fields
pipedrive: Addorupdategoalresponse200DataGoal
Fields
- id string? - ID of the goal
- owner_id string? - ID of the creator of the goal
- title string? - The title of the goal
- 'type GoalType? - Type of the goal
- assignee GoalAssignee? - Who is the goal assigned to
- interval string? - Interval of the goal
- duration GoalDuration? - Duration of the goal
- expected_outcome GoalExpectedOutcome? - Expected outcome of the goal
- is_active boolean? - If the goal is currently active or not
- report_ids int[]? - The IDs of the reports that belong to the goal
pipedrive: AddOrUpdateLeadLabelResponse200
Fields
- success boolean? -
- data Getleadlabelsresponse200Data? -
pipedrive: AddOrUpdateProductFieldResponse200
Fields
- name string - Name of the field
- options record {}[]? - When field_type is either set or enum, possible options on update must be supplied as an array of objects each containing id and label, for example: [{"id":1, "label":"red"},{"id":2, "label":"blue"},{"id":3, "label":"lilac"}]
pipedrive: AddOrUpdateRoleSettingRequest
Fields
- setting_key string -
- value decimal - Possible values for
default_visibility
settings:1
,3
,5
or7
pipedrive: AddOrUpdateRoleSettingResponse200
Fields
- success boolean? - If the response is successful or not
- data Addorupdaterolesettingresponse200Data? - The response data
pipedrive: Addorupdaterolesettingresponse200Data
The response data
Fields
- id int? - The ID of the Role
- deal_default_visibility decimal? - The setting
pipedrive: AddPersonFollowerRequest
Fields
- user_id int - ID of the user
pipedrive: AddPersonFollowerResponse200
Fields
- success boolean? - If the response is successful or not
- data Addpersonfollowerresponse200Data? -
pipedrive: Addpersonfollowerresponse200Data
Fields
- user_id int? - The ID of the User who was added as a follower to a Person
- id int? - The ID of the Follower
- person_id int? - The ID of the Person to whom the follower was added
- add_time string? - The date and time when the Follower was added to a Person. Format: YYYY-MM-DD HH:MM:SS
pipedrive: AddPersonRequest
Fields
- name string? - Person name
- owner_id int? - ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used.
- org_id int? - ID of the organization this person will belong to.
- email string[]? - Email addresses (one or more) associated with the person, presented in the same manner as received by GET request of a person.
- phone string[]? - Phone numbers (one or more) associated with the person, presented in the same manner as received by GET request of a person.
- visible_to record {}? - Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td></tr><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
- add_time string? - Optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
pipedrive: AddPersonResponse200
Fields
- success boolean? - If the response is successful or not
- data record { id int?, company_id int?, active_flag boolean?, phone record { value string?, primary boolean?, label string? }[]?, email record { value string?, primary boolean?, label string? }[]?, first_char string?, add_time string?, update_time string?, visible_to string?, picture_id record { id int?, item_type string?, item_id int?, active_flag boolean?, add_time string?, update_time string?, added_by_user_id int?, pictures record { '128 string?, '512 string? } }, label int?, org_name string?, owner_name string?, cc_email string?, owner_id record { id int?, name string?, email string?, has_pic int?, pic_hash string?, active_flag boolean?, value int? }, org_id record { name string?, people_count int?, owner_id int?, address string?, cc_email string?, value int?, active_flag boolean? }, name string?, first_name string?, last_name string?, email_messages_count int?, activities_count int?, done_activities_count int?, undone_activities_count int?, files_count int?, notes_count int?, followers_count int?, last_incoming_mail_time string?, last_outgoing_mail_time string?, open_deals_count int?, related_open_deals_count int?, closed_deals_count int?, related_closed_deals_count int?, won_deals_count int?, related_won_deals_count int?, lost_deals_count int?, related_lost_deals_count int?, next_activity_date string?, next_activity_time string?, next_activity_id int?, last_activity_id int?, last_activity_date string? }? -
- related_objects Listproductsresponse200RelatedObjects? -
pipedrive: AddPipelineResponse200
Fields
- success boolean? - If the response is successful or not
- data Addpipelineresponse200Data? - The Pipeline object
pipedrive: Addpipelineresponse200Data
The Pipeline object
Fields
- id int? - The ID of the Pipeline
- name string? - The name of the Pipeline
- url_title string? - The Pipeline title displayed in the URL
- order_nr int? - Defines the order of Pipelines. First order (
order_nr=0
) is the default Pipeline.
- active boolean? - Whether this Pipeline will be made inactive (hidden) or active
- deal_probability boolean? - Whether Deal probability is disabled or enabled for this Pipeline
- add_time string? - The Pipeline creation time. Format: YYYY-MM-DD HH:MM:SS.
- update_time string? - The Pipeline update time. Format: YYYY-MM-DD HH:MM:SS.
pipedrive: AddProductFollowerRequest
Fields
- user_id int - ID of the user
pipedrive: AddProductRequest
Fields
- name string? - Name of the product.
- code string? - Product code.
- unit string? - Unit in which this product is sold
- tax decimal? - Tax percentage
- active_flag decimal? - Whether this product will be made active or not.
- selectable decimal? - Whether this product can be selected in Deals or not.
- visible_to record {}? - Visibility of the product. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
- owner_id int? - ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used.
- prices record {}[]? - Array of objects, each containing:
currency
(string),price
(number),cost
(number, optional),overhead_cost
(number, optional). Note that there can only be one price per product per currency. Whenprices
is omitted altogether, no prices will be set up for the product
pipedrive: AddRecurringSubscriptionRequest
Fields
- deal_id int - ID of the Deal this Recurring Subscription is associated with
- currency string - The currency of the Recurring Subscription. Accepts a 3-character currency code.
- description string? - Description of the Recurring Subscription
- cadence_type string - Interval between payments
- cycles_count int? - Shows how many payments the Subscription has. Note that one field must be set:
cycles_count
orinfinite
. Ifcycles_count
is set, thencycle_amount
andstart_date
are also required.
- cycle_amount int - Amount of each payment
- start_date string - Start date of the Recurring Subscription. Format: YYYY-MM-DD
- infinite boolean? - This indicates that the Recurring Subscription will last until it's manually canceled or deleted. Note that only one field must be set:
cycles_count
orinfinite
.
- payments record {}[]? - Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
- update_deal_value boolean? - Indicates that the Deal value must be set to Recurring Subscription's MRR value
pipedrive: AddRoleAssignmentRequest
Fields
- user_id int - ID of the user
pipedrive: AddRoleAssignmentResponse200
Fields
- success boolean? - If the response is successful or not
- data Addroleassignmentresponse200Data? - The response data
pipedrive: Addroleassignmentresponse200Data
The response data
Fields
- user_id int? - The ID of the User that was added to the Role
- role_id int? - The ID of the Role the User was added to
pipedrive: AddRoleRequest
Fields
- parent_role_id int? - The ID of the parent Role
- name string? - The name of the Role
pipedrive: AddRoleResponse200
Fields
- success boolean? - If the response is successful or not
- data Addroleresponse200Data? - The response data
pipedrive: Addroleresponse200Data
The response data
Fields
- id record {}? - The ID of the created Role
pipedrive: AddStageRequest
Fields
- name string - Name of the Stage
- pipeline_id int - The ID of the Pipeline to add Stage to.
- deal_probability int? - Deal success probability percentage. Used/shown when Deal weighted values are used
- rotten_flag int? - Whether Deals in this stage can become rotten
- rotten_days int? - The number of days the Deals not updated in this Stage would become rotten. Applies only if the
rotten_flag
is set.
pipedrive: AddSubscriptionInstallmentRequest
Fields
- deal_id int - ID of the Deal this Installment Subscription is associated with
- currency string - The currency of the Installment Subscription. Accepts a 3-character currency code.
- payments record {}[] - Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
- update_deal_value boolean? - Indicates that the Deal value must be set to the Installment Subscription's total value
pipedrive: AddTeamRequest
Fields
- name string - The Team name
- description string? - The Team description
- manager_id int - The Team manager ID
- users int[]? - List of User IDs
pipedrive: AddTeamUserRequest
Fields
- users int[] - List of User IDs
pipedrive: AddUserRequest
Fields
- name string - Name of the user
- email string - Email of the user
- active_flag boolean - Whether the user is active or not.
false
= Not activated,true
= Activated
pipedrive: AddUserRoleAssignmentRequest
Fields
- role_id int - ID of the role
pipedrive: AddWebhookRequest
Fields
- subscription_url string - A full, valid, publicly accessible URL. Determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the
subscription_url
.
- event_action string - Type of action to receive notifications about. Wildcard will match all supported actions.
- event_object string - Type of object to receive notifications about. Wildcard will match all supported objects.
- user_id int? - The ID of the user this webhook will be authorized with. If not set, current authorized user will be used. Note that this does not filter only certain user's events — rather, this specifies the user's permissions under which each event is checked. Events about objects the selected user is not entitled to access are not sent. If you want to receive notifications for all events, a top-level admin user should be used.
- http_auth_user string? - HTTP basic auth username of the subscription URL endpoint (if required).
- http_auth_password string? - HTTP basic auth password of the subscription URL endpoint (if required).
pipedrive: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- apiToken string - Represents API Key
api_token
pipedrive: BaseDeal
Fields
- stage_id int? - The ID of the Deal stage
- title string? - The title of the Deal
- value decimal? - The value of the Deal
- currency string? - The currency associated with the Deal
- add_time string? - The creation date and time of the Deal
- update_time string? - The last updated date and time of the Deal
- stage_change_time string? - The last updated date and time of the Deal stage
- active boolean? - If the Deal is activated or not
- deleted boolean? - If the Deal is deleted or not
- status string? - The status of the Deal
- probability decimal? - The success probability percentage of the Deal
- next_activity_date string? - The date of the next activity associated with the Deal
- next_activity_time string? - The time of the next activity associated with the Deal
- next_activity_id int? - The ID of the next activity associated with the Deal
- last_activity_id int? - The ID of the last activity associated with the Deal
- last_activity_date string? - The date of the last activity associated with the Deal
- lost_reason string? - The reason for losing the Deal
- visible_to string? - The visibility of the Deal
- close_time string? - The date and time of closing the Deal
- pipeline_id int? - The ID of pipeline associated with the Deal
- won_time string? - The date and time of changing the Deal status as won
- first_won_time string? - The date and time of the first time changing the Deal status as won
- lost_time string? - The date and time of changing the Deal status as lost
- products_count int? - The number of Products associated with the Deal
- files_count int? - The number of Files associated with the Deal
- notes_count int? - The number of Notes associated with the Deal
- followers_count int? - The number of Followers associated with the Deal
- email_messages_count int? - The number of emails associated with the Deal
- activities_count int? - The number of Activities associated with the Deal
- done_activities_count int? - The number of completed Activities associated with the Deal
- undone_activities_count int? - The number of incomplete Activities associated with the Deal
- participants_count int? - The number of Participants associated with the Deal
- expected_close_date string? - The expected close date of the Deal
- last_incoming_mail_time string? - The date and time of the last incoming email associated with the Deal
- last_outgoing_mail_time string? - The date and time of the last outgoing email associated with the Deal
- label string? - The label assigned to the Deal
- stage_order_nr int? - The order number of the Deal stage associated with the Deal
- person_name string? - The name of the Person associated with the Deal
- org_name string? - The name of the Organization associated with the Deal
- next_activity_subject string? - The subject of the next activity associated with the Deal
- next_activity_type string? - The type of the next activity associated with the Deal
- next_activity_duration string? - The duration of the next activity associated with the Deal
- next_activity_note string? - The note of the next activity associated with the Deal
- formatted_value string? - The Deal value formatted with selected currency. E.g. US$500
- weighted_value decimal? - Probability times Deal value. Probability can either be Deal probability or if not set, then stage probability.
- formatted_weighted_value string? - The weighted_value formatted with selected currency. E.g. US$500
- weighted_value_currency string? - The currency associated with the Deal
- rotten_time string? - The date and time of changing the Deal status as rotten
- owner_name string? - The name of the Deal owner
- cc_email string? - The Cc email of the Deal
- org_hidden boolean? - If the Organization that is associated with the Deal is hidden or not
- person_hidden boolean? - If the Person that is associated with the Deal is hidden or not
pipedrive: BaseMailThread
The mail thread object
Fields
- Fields Included from *BaseMailThread1
- id int|()
- account_id string|()
- user_id int|()
- subject string|()
- snippet string|()
- read_flag record { anydata... }
- mail_tracking_status string|()
- has_attachments_flag record { anydata... }
- has_inline_attachments_flag record { anydata... }
- has_real_attachments_flag record { anydata... }
- deleted_flag record { anydata... }
- synced_flag record { anydata... }
- smart_bcc_flag record { anydata... }
- mail_link_tracking_enabled_flag record { anydata... }
- write_flag boolean|()
- anydata...
- Fields Included from *BaseMailThread2
- parties Basemailthread2Parties|()
- drafts_parties record { anydata... }[]|()
- folders string[]|()
- version decimal|()
- snippet_draft string|()
- snippet_sent string|()
- message_count int|()
- has_draft_flag record { anydata... }
- has_sent_flag record { anydata... }
- archived_flag record { anydata... }
- shared_flag record { anydata... }
- external_deleted_flag record { anydata... }
- first_message_to_me_flag record { anydata... }
- last_message_timestamp string|()
- first_message_timestamp string|()
- last_message_sent_timestamp string|()
- last_message_received_timestamp string|()
- add_time string|()
- update_time string|()
- deal_id int|()
- deal_status string|()
- lead_id string|()
- all_messages_sent_flag record { anydata... }
- anydata...
pipedrive: BaseMailThread1
Fields
- id int? - ID of the mail thread
- account_id string? - The connection account ID
- user_id int? - ID of the user whom mail message will be assigned to
- subject string? - The subject
- snippet string? - A snippet
- read_flag record {}? - Whether the mail thread is read
- mail_tracking_status string? - Mail tracking status
- has_attachments_flag record {}? - Whether the mail thread has an attachment
- has_inline_attachments_flag record {}? - Whether the mail thread has inline attachments
- has_real_attachments_flag record {}? - Whether the mail thread has real attachments (which are not inline)
- deleted_flag record {}? - Whether the mail thread is deleted
- synced_flag record {}? - Whether the mail thread is synced
- smart_bcc_flag record {}? - Whether one of the parties of the mail thread is Bcc
- mail_link_tracking_enabled_flag record {}? - Whether the link tracking of the mail thread is enabled
- write_flag boolean? - We strongly advise you to avoid the use of this property. We will soon deprecate this property
pipedrive: BaseMailThread2
Fields
- parties Basemailthread2Parties? - Parties of the mail thread
- drafts_parties record {}[]? - Parties of the drafted mail thread
- folders string[]? - Folders in which messages from thread are being stored
- 'version decimal? - Version
- snippet_draft string? - A snippet from a draft
- snippet_sent string? - A snippet from a message sent
- message_count int? - An amount of messages
- has_draft_flag record {}? - Whether the mail thread has any drafts
- has_sent_flag record {}? - Whether the mail thread has messages sent
- archived_flag record {}? - Whether the mail thread is archived
- shared_flag record {}? - Whether the mail thread is shared
- external_deleted_flag record {}? - Whether the mail thread has been deleted externally
- first_message_to_me_flag record {}? - Whether the mail thread was initialized by others
- last_message_timestamp string? - Last message timestamp
- first_message_timestamp string? - The time when the mail thread has had the first message received or created
- last_message_sent_timestamp string? - The last time when the mail thread has had a message sent
- last_message_received_timestamp string? - The last time when the mail thread has had a message received
- add_time string? - The time when the mail thread was inserted to database
- update_time string? - The time when the mail thread was updated in database received
- deal_id int? - The ID of the deal
- deal_status string? - Status of the deal
- lead_id string? - The ID of the lead
- all_messages_sent_flag record {}? - Whether all the mail thread messages have been sent
pipedrive: Basemailthread2Parties
Parties of the mail thread
Fields
- to Basemailthread2PartiesTo[]? - Recipients of the mail thread
- 'from Basemailthread2PartiesTo[]? - Senders of the mail thread
pipedrive: Basemailthread2PartiesTo
Member of a thread
Fields
- id int? - ID of the mail thread participant
- name string? - Name of the mail thread participant
- latest_sent boolean? - Whether the mail thread participant was last to send an email
- email_address string? - Email address of the mail thread participant
- message_time decimal? - Message time
- linked_person_id int? - ID of the linked person
- linked_person_name string? - Email of the linked person
- mail_message_party_id int? - ID of the mail message party
- linked_organization_id int? - Linked Organization ID
pipedrive: BaseMailThreadData
The mail thread object
Fields
- Fields Included from *BaseMailThread1
- id int|()
- account_id string|()
- user_id int|()
- subject string|()
- snippet string|()
- read_flag record { anydata... }
- mail_tracking_status string|()
- has_attachments_flag record { anydata... }
- has_inline_attachments_flag record { anydata... }
- has_real_attachments_flag record { anydata... }
- deleted_flag record { anydata... }
- synced_flag record { anydata... }
- smart_bcc_flag record { anydata... }
- mail_link_tracking_enabled_flag record { anydata... }
- write_flag boolean|()
- anydata...
- Fields Included from *BaseMailThread2
- parties Basemailthread2Parties|()
- drafts_parties record { anydata... }[]|()
- folders string[]|()
- version decimal|()
- snippet_draft string|()
- snippet_sent string|()
- message_count int|()
- has_draft_flag record { anydata... }
- has_sent_flag record { anydata... }
- archived_flag record { anydata... }
- shared_flag record { anydata... }
- external_deleted_flag record { anydata... }
- first_message_to_me_flag record { anydata... }
- last_message_timestamp string|()
- first_message_timestamp string|()
- last_message_sent_timestamp string|()
- last_message_received_timestamp string|()
- add_time string|()
- update_time string|()
- deal_id int|()
- deal_status string|()
- lead_id string|()
- all_messages_sent_flag record { anydata... }
- anydata...
pipedrive: BaseOrganizationItem
Fields
- Fields Included from *BaseOrganizationItem1
- id int|()
- company_id int|()
- owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
- name string|()
- active_flag boolean|()
- picture_id record { id int|(), item_type string|(), item_id int|(), active_flag boolean|(), add_time string|(), update_time string|(), added_by_user_id int|(), pictures Pictures|(), anydata... }
- country_code string|()
- first_char string|()
- add_time string|()
- update_time string|()
- visible_to string|()
- label int|()
- owner_name string|()
- cc_email string|()
- anydata...
- Fields Included from *AdditionalBaseOrganizationItemInfo
- email_messages_count int|()
- people_count int|()
- activities_count int|()
- done_activities_count int|()
- undone_activities_count int|()
- files_count int|()
- notes_count int|()
- followers_count int|()
- address string|()
- address_subpremise string|()
- address_street_number string|()
- address_route string|()
- address_sublocality string|()
- address_locality string|()
- address_admin_area_level_1 string|()
- address_admin_area_level_2 string|()
- address_country string|()
- address_postal_code string|()
- address_formatted_address string|()
- open_deals_count int|()
- related_open_deals_count int|()
- closed_deals_count int|()
- related_closed_deals_count int|()
- won_deals_count int|()
- related_won_deals_count int|()
- lost_deals_count int|()
- related_lost_deals_count int|()
- next_activity_date string|()
- next_activity_time string|()
- next_activity_id int|()
- last_activity_id int|()
- last_activity_date string|()
- anydata...
pipedrive: BaseOrganizationItem1
Fields
- id int? - The ID of the Organization
- company_id int? - The ID of the Company related to the Organization
- owner_id record {}? -
- name string? - The name of the Organization
- active_flag boolean? - If the Organization is activated or not
- picture_id record {}? -
- country_code string? - The country code of the Organization
- first_char string? - The first character of the Organization name
- add_time string? - The creation date and time of the Organization
- update_time string? - The last updated date and time of the Organization
- visible_to string? - The visibility group ID of who can see the Organization
- label int? - The ID of the label
- owner_name string? - The name of the Organization owner
- cc_email string? - The CC email of the Organization
pipedrive: BaseOrganizationItemWithEditNameFlag
Fields
- Fields Included from *BaseOrganizationItem
- id int|()
- company_id int|()
- owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
- name string|()
- active_flag boolean|()
- picture_id record { id int|(), item_type string|(), item_id int|(), active_flag boolean|(), add_time string|(), update_time string|(), added_by_user_id int|(), pictures Pictures|(), anydata... }
- country_code string|()
- first_char string|()
- add_time string|()
- update_time string|()
- visible_to string|()
- label int|()
- owner_name string|()
- cc_email string|()
- email_messages_count int|()
- people_count int|()
- activities_count int|()
- done_activities_count int|()
- undone_activities_count int|()
- files_count int|()
- notes_count int|()
- followers_count int|()
- address string|()
- address_subpremise string|()
- address_street_number string|()
- address_route string|()
- address_sublocality string|()
- address_locality string|()
- address_admin_area_level_1 string|()
- address_admin_area_level_2 string|()
- address_country string|()
- address_postal_code string|()
- address_formatted_address string|()
- open_deals_count int|()
- related_open_deals_count int|()
- closed_deals_count int|()
- related_closed_deals_count int|()
- won_deals_count int|()
- related_won_deals_count int|()
- lost_deals_count int|()
- related_lost_deals_count int|()
- next_activity_date string|()
- next_activity_time string|()
- next_activity_id int|()
- last_activity_id int|()
- last_activity_date string|()
- anydata...
- Fields Included from *BaseOrganizationItemWithEditNameFlag1
- edit_name boolean|()
- anydata...
pipedrive: BaseOrganizationItemWithEditNameFlag1
Fields
- edit_name boolean? - If the company ID of the Organization and company ID of the request is same or not
pipedrive: BaseOrganizationItemWithEditNameFlagData
Fields
- Fields Included from *BaseOrganizationItem
- id int|()
- company_id int|()
- owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
- name string|()
- active_flag boolean|()
- picture_id record { id int|(), item_type string|(), item_id int|(), active_flag boolean|(), add_time string|(), update_time string|(), added_by_user_id int|(), pictures Pictures|(), anydata... }
- country_code string|()
- first_char string|()
- add_time string|()
- update_time string|()
- visible_to string|()
- label int|()
- owner_name string|()
- cc_email string|()
- email_messages_count int|()
- people_count int|()
- activities_count int|()
- done_activities_count int|()
- undone_activities_count int|()
- files_count int|()
- notes_count int|()
- followers_count int|()
- address string|()
- address_subpremise string|()
- address_street_number string|()
- address_route string|()
- address_sublocality string|()
- address_locality string|()
- address_admin_area_level_1 string|()
- address_admin_area_level_2 string|()
- address_country string|()
- address_postal_code string|()
- address_formatted_address string|()
- open_deals_count int|()
- related_open_deals_count int|()
- closed_deals_count int|()
- related_closed_deals_count int|()
- won_deals_count int|()
- related_won_deals_count int|()
- lost_deals_count int|()
- related_lost_deals_count int|()
- next_activity_date string|()
- next_activity_time string|()
- next_activity_id int|()
- last_activity_id int|()
- last_activity_date string|()
- anydata...
- edit_name boolean? - If the company ID of the Organization and company ID of the request is same or not
pipedrive: BasePipelineWithSelectedFlag
Fields
- Fields Included from *Pipeline1
- Fields Included from *Pipeline2
- selected boolean|()
- anydata...
pipedrive: BaseResponse200
Fields
- success boolean? - If the response is successful or not
- status string? - The status of the response
pipedrive: BaseRoleRequest
Details of the role
Fields
- parent_role_id int? - The ID of the parent Role
- name string? - The name of the Role
pipedrive: BaseTeam
Fields
- id int? - The Team ID
- Fields Included from *UpdateTeamWithAdditionalProperties
pipedrive: BasicDeal
Fields
- title string? - Deal title
- value string? - Value of the deal. If omitted, value will be set to 0.
- currency string? - Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.
- user_id int? - ID of the user who will be marked as the owner of this deal. If omitted, the authorized user ID will be used.
- person_id int? - ID of the person this deal will be associated with
- org_id int? - ID of the organization this deal will be associated with
- stage_id int? - ID of the stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on
stage_id
). If omitted, the deal will be placed in the first stage of the default pipeline.
- status string? - open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open.
- expected_close_date string? - The expected close date of the Deal. In ISO 8601 format: YYYY-MM-DD.
- probability decimal? - Deal success probability percentage. Used/shown only when
deal_probability
for the pipeline of the deal is enabled.
- lost_reason string? - Optional message about why the deal was lost (to be used when status=lost)
- visible_to record {}? - Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td></tr><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
pipedrive: BasicDealProductRequest
Fields
- item_price decimal? - Price at which this product will be added to the deal
- quantity int? - Quantity – e.g. how many items of this product will be added to the deal
- discount_percentage decimal? - Discount %. If omitted, will be set to 0
- duration decimal? - Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)
- product_variation_id int? - ID of the product variation to use. When omitted, no variation will be used.
- comments string? - Any textual comment associated with this product-deal attachment. Visible and editable in the application UI.
- enabled_flag record {}? - Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.
pipedrive: BasicDealProductRequestData
Fields
- Fields Included from *BasicDealProductRequestData1
- Fields Included from *BasicDealProductRequestData2
pipedrive: BasicDealProductRequestData1
Fields
- item_price decimal? - Price at which this product will be added to the deal
- quantity int? - Quantity – e.g. how many items of this product will be added to the deal
- discount_percentage decimal? - Discount %. If omitted, will be set to 0
- duration decimal? - Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)
- product_variation_id int? - ID of the product variation to use. When omitted, no variation will be used.
- comments string? - Any textual comment associated with this product-deal attachment. Visible and editable in the application UI.
- enabled_flag record {}? - Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.
pipedrive: BasicDealProductRequestData2
Fields
- id int? - The ID of the deal-product (the ID of the Product attached to the Deal)
- company_id int? - The ID of the Company
- deal_id int? - The ID of the Deal
- product_id int? - The ID of the Product
- duration_unit string? - The type of the duration. (For example hourly, daily, etc.)
- sum_no_discount decimal? - The Product sum without the discount
- sum decimal? - The sum of all the Products attached to the Deal
- currency string? - The currency associated with the Deal Product
- add_time string? - The date and time when the Product was added to the Deal
- last_edit string? - The date and time when the Deal Product was last edited
- active_flag boolean? - Boolean indicates if the Product is activated or not
- tax decimal? - The Product tax
- name string? - The Product name
pipedrive: BasicGoalRequest
Fields
- title string? - Title of the goal.
- assignee record {}? - Who is this goal assigned to. It requires the following JSON structure: { "id": "1", "type": "person" }.
type
can be eitherperson
,company
orteam
. ID of the assignee person, company or team.
- 'type record {}? - Type of the goal. It requires the following JSON structure: { "name": "deals_started", "params": { "pipeline_id": 1 } }. Type can be one of:
deals_won
,deals_progressed
,activities_completed
,activities_added
,deals_started
orrevenue_forecast
.params
can includepipeline_id
,stage_id
oractivity_type_id
.stage_id
is related to onlydeals_progressed
type of goals andactivity_type_id
toactivities_completed
oractivities_added
types of goals. To track goal in all pipelines setpipeline_id
asnull
.
- expected_outcome record {}? - Expected outcome of the goal. Expected outcome can be tracked either by
quantity
or bysum
. It requires the following JSON structure: { "target": "50", "tracking_metric": "quantity" } or { "target": "50", "tracking_metric": "sum", "currency_id": 1 }.currency_id
should only be added tosum
type of goals.
- duration record {}? - Date when the goal starts and ends. It requires the following JSON structure: { "start": "2019-01-01", "end": "2022-12-31" }. Date in format of YYYY-MM-DD. "end" can be set to
null
for an infinite, open-ended goal.
- interval string? - Interval of the goal
pipedrive: BasicOrganization
Fields
- name string? - Organization name
- owner_id int? - The ID of the user who will be marked as the owner of this Organization. When omitted, the authorized User ID will be used.
- visible_to record {}? - Visibility of the organization. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td></tr><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
pipedrive: BasicPersonRequest
Fields
- name string? - Person name
- owner_id int? - ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used.
- org_id int? - ID of the organization this person will belong to.
- email string[]? - Email addresses (one or more) associated with the person, presented in the same manner as received by GET request of a person.
- phone string[]? - Phone numbers (one or more) associated with the person, presented in the same manner as received by GET request of a person.
- visible_to record {}? - Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td></tr><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
pipedrive: CallLogResponse400
Fields
- success boolean? -
- _error string? - The description of the error
- error_info string? - A message describing how to solve the problem
- data record {}? -
- additional_data record {}? -
pipedrive: CallLogResponse403
Fields
- success boolean? -
- _error string? - The description of the error
- error_info string? - A message describing how to solve the problem
- data record {}? -
- additional_data record {}? -
pipedrive: CallLogResponse404
Fields
- success boolean? -
- _error string? - The description of the error
- error_info string? - A message describing how to solve the problem
- data record {}? -
- additional_data record {}? -
pipedrive: CallLogResponse410
Fields
- success boolean? -
- _error string? - The description of the error
- error_info string? - A message describing how to solve the problem
- data record {}? -
- additional_data record {}? -
pipedrive: CallLogResponse500
Fields
- success boolean? -
- _error string? - The description of the error
- error_info string? - A message describing how to solve the problem
- data record {}? -
- additional_data record {}? -
pipedrive: CancelRecurringSubscriptionRequest
Fields
- end_date string? - Subscription termination date. All payments after specified date will be deleted. Default value is the current date.
pipedrive: CommentPostPutObject
Fields
- content string - Content of the comment in HTML format. Subject to sanitization on the back-end.
pipedrive: Commentpostputobject1
Fields
- content string - Content of the comment in HTML format. Subject to sanitization on the back-end.
pipedrive: CreateFieldRequest
Fields
- name string - Name of the field
- options string? - When
field_type
is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. Example:[{"label":"New Item"}]
- add_visible_flag boolean? - Whether the field is available in 'add new' modal or not (both in web and mobile app)
- field_type string - Type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>
address
</td><td>Address field (has multiple subfields, autocompleted by Google Maps)</td></tr><tr><td>date
</td><td>Date (format YYYY-MM-DD)</td></tr><tr><td>daterange
</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td></tr><tr><td>double
</td><td>Numeric value</td></tr><tr><td>enum
</td><td>Options field with a single possible chosen option</td></tr><tr><td>int
</td><td>Integer value</td></tr><tr><td>monetary
</td><td>Monetary field (has a numeric value and a currency value)</td></tr><tr><td>org
</td><td>Organization field (contains an organization ID which is stored on the same account)</td></tr><tr><td>people
</td><td>Person field (contains a person ID which is stored on the same account)</td></tr><tr><td>phone
</td><td>Phone field (up to 255 numbers and/or characters)</td></tr><tr><td>set
</td><td>Options field with a possibility of having multiple chosen options</td></tr><tr><td>text
</td><td>Long text (up to 65k characters)</td></tr><tr><td>time
</td><td>Time field (format HH:MM:SS)</td></tr><tr><td>timerange
</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td></tr><tr><td>user
</td><td>User field (contains a user ID of another Pipedrive user)</td></tr><tr><td>varchar
</td><td>Text (up to 255 characters)</td></tr><tr><td>varchar_auto
</td><td>Autocomplete text (up to 255 characters)</td></tr><tr><td>visible_to
</td><td>System field that keeps item's visibility setting</td></tr></table>
pipedrive: Createfieldrequest1
Fields
- name string - Name of the field
- options string? - When
field_type
is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. Example:[{"label":"New Item"}]
- add_visible_flag boolean? - Whether the field is available in 'add new' modal or not (both in web and mobile app)
- field_type string - Type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>
address
</td><td>Address field (has multiple subfields, autocompleted by Google Maps)</td></tr><tr><td>date
</td><td>Date (format YYYY-MM-DD)</td></tr><tr><td>daterange
</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td></tr><tr><td>double
</td><td>Numeric value</td></tr><tr><td>enum
</td><td>Options field with a single possible chosen option</td></tr><tr><td>int
</td><td>Integer value</td></tr><tr><td>monetary
</td><td>Monetary field (has a numeric value and a currency value)</td></tr><tr><td>org
</td><td>Organization field (contains an organization ID which is stored on the same account)</td></tr><tr><td>people
</td><td>Person field (contains a person ID which is stored on the same account)</td></tr><tr><td>phone
</td><td>Phone field (up to 255 numbers and/or characters)</td></tr><tr><td>set
</td><td>Options field with a possibility of having multiple chosen options</td></tr><tr><td>text
</td><td>Long text (up to 65k characters)</td></tr><tr><td>time
</td><td>Time field (format HH:MM:SS)</td></tr><tr><td>timerange
</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td></tr><tr><td>user
</td><td>User field (contains a user ID of another Pipedrive user)</td></tr><tr><td>varchar
</td><td>Text (up to 255 characters)</td></tr><tr><td>varchar_auto
</td><td>Autocomplete text (up to 255 characters)</td></tr><tr><td>visible_to
</td><td>System field that keeps item's visibility setting</td></tr></table>
pipedrive: Createfieldrequest2
Fields
- name string - Name of the field
- options string? - When
field_type
is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. Example:[{"label":"New Item"}]
- add_visible_flag boolean? - Whether the field is available in 'add new' modal or not (both in web and mobile app)
- field_type string - Type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>
address
</td><td>Address field (has multiple subfields, autocompleted by Google Maps)</td></tr><tr><td>date
</td><td>Date (format YYYY-MM-DD)</td></tr><tr><td>daterange
</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td></tr><tr><td>double
</td><td>Numeric value</td></tr><tr><td>enum
</td><td>Options field with a single possible chosen option</td></tr><tr><td>int
</td><td>Integer value</td></tr><tr><td>monetary
</td><td>Monetary field (has a numeric value and a currency value)</td></tr><tr><td>org
</td><td>Organization field (contains an organization ID which is stored on the same account)</td></tr><tr><td>people
</td><td>Person field (contains a person ID which is stored on the same account)</td></tr><tr><td>phone
</td><td>Phone field (up to 255 numbers and/or characters)</td></tr><tr><td>set
</td><td>Options field with a possibility of having multiple chosen options</td></tr><tr><td>text
</td><td>Long text (up to 65k characters)</td></tr><tr><td>time
</td><td>Time field (format HH:MM:SS)</td></tr><tr><td>timerange
</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td></tr><tr><td>user
</td><td>User field (contains a user ID of another Pipedrive user)</td></tr><tr><td>varchar
</td><td>Text (up to 255 characters)</td></tr><tr><td>varchar_auto
</td><td>Autocomplete text (up to 255 characters)</td></tr><tr><td>visible_to
</td><td>System field that keeps item's visibility setting</td></tr></table>
pipedrive: CreateUpdateDeleteActivityTypeResponse200
Fields
- success boolean? - If the response is successful or not
- data Getactivitytypesresponse200Data? -
pipedrive: DealCountAndActivityInfo
Fields
- Fields Included from *DealCountAndActivityInfo1
- Fields Included from *DealCountAndActivityInfo2
pipedrive: DealCountAndActivityInfo1
Fields
- open_deals_count int? - The count of open Deals related with the item
- related_open_deals_count int? - The count of related open Deals related with the item
- closed_deals_count int? - The count of closed Deals related with the item
- related_closed_deals_count int? - The count of related closed Deals related with the item
- won_deals_count int? - The count of won Deals related with the item
- related_won_deals_count int? - The count of related won Deals related with the item
- lost_deals_count int? - The count of lost Deals related with the item
- related_lost_deals_count int? - The count of related lost Deals related with the item
pipedrive: DealCountAndActivityInfo2
Fields
- next_activity_date string? - The date of the next activity associated with the Deal
- next_activity_time string? - The time of the next activity associated with the Deal
- next_activity_id int? - The ID of the next activity associated with the Deal
- last_activity_id int? - The ID of the last activity associated with the Deal
- last_activity_date string? - The date of the last activity associated with the Deal
pipedrive: DealCreator
The creator of the Deal
Fields
- id int? - The ID of the Deal creator
- name string? - The name of the Deal creator
- email string? - The email of the Deal creator
- has_pic boolean? - If the creator has a picture or not
- pic_hash string? - The creator picture hash
- active_flag boolean? - If the creator is activated or not
- value int? - The ID of the Deal creator
pipedrive: DealNonStrict
Fields
- Fields Included from *DealNonStrict1
- id int|()
- creator_user_id DealCreator|()
- user_id record { id int|(), name string|(), email string|(), has_pic boolean|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
- person_id record { active_flag boolean|(), name string|(), email Dealpersondatawithid1Email[]|(), phone Dealpersondatawithid1Phone[]|(), owner_id int|(), value int|(), anydata... }
- org_id record { name string|(), people_count int|(), owner_id int|(), address string|(), active_flag boolean|(), cc_email string|(), value int|(), anydata... }
- anydata...
- Fields Included from *BaseDeal
- stage_id int|()
- title string|()
- value decimal|()
- currency string|()
- add_time string|()
- update_time string|()
- stage_change_time string|()
- active boolean|()
- deleted boolean|()
- status string|()
- probability decimal|()
- next_activity_date string|()
- next_activity_time string|()
- next_activity_id int|()
- last_activity_id int|()
- last_activity_date string|()
- lost_reason string|()
- visible_to string|()
- close_time string|()
- pipeline_id int|()
- won_time string|()
- first_won_time string|()
- lost_time string|()
- products_count int|()
- files_count int|()
- notes_count int|()
- followers_count int|()
- email_messages_count int|()
- activities_count int|()
- done_activities_count int|()
- undone_activities_count int|()
- participants_count int|()
- expected_close_date string|()
- last_incoming_mail_time string|()
- last_outgoing_mail_time string|()
- label string|()
- stage_order_nr int|()
- person_name string|()
- org_name string|()
- next_activity_subject string|()
- next_activity_type string|()
- next_activity_duration string|()
- next_activity_note string|()
- formatted_value string|()
- weighted_value decimal|()
- formatted_weighted_value string|()
- weighted_value_currency string|()
- rotten_time string|()
- owner_name string|()
- cc_email string|()
- org_hidden boolean|()
- person_hidden boolean|()
- anydata...
pipedrive: DealNonStrict1
Fields
- id int? - The ID of the Deal
- creator_user_id DealCreator? - The creator of the Deal
- user_id record {}? -
- person_id record {}? -
- org_id record {}? -
pipedrive: DealOrganizationDataWithId1
The Organization which is associated with the Deal
Fields
- name string? - The name of the Organization associated with the Deal
- people_count int? - The number of people connected with the Organization that is associated with the Deal
- owner_id int? - The ID of the owner of the Organization that is associated with the Deal
- address string? - The address of the Organization that is associated with the Deal
- active_flag boolean? - If the associated Organization is activated or not
- cc_email string? - The CC email of the Organization associated with the Deal
pipedrive: DealOrganizationDataWithId2
Fields
- value int? - The ID of the Organization associated with the Deal
pipedrive: DealPersonDataWithId1
The Person who is associated with the Deal
Fields
- active_flag boolean? - If the associated Person is activated or not
- name string? - The name of the Person associated with the Deal
- email Dealpersondatawithid1Email[]? - The emails of the Person associated with the Deal
- phone Dealpersondatawithid1Phone[]? - The phone numbers of the Person associated with the Deal
- owner_id int? - The ID of the owner of the Person that is associated with the Deal
pipedrive: Dealpersondatawithid1Email
Fields
- label string? - The type of the email
- value string? - The email of the associated Person
- primary boolean? - If this is the primary email or not
pipedrive: Dealpersondatawithid1Phone
Fields
- label string? - The type of the phone number
- value string? - The phone number of the Person associated with the Deal
- primary boolean? - If this is the primary phone number or not
pipedrive: DealPersonDataWithId2
Fields
- value int? - The ID of the Person associated with the Deal
pipedrive: DealResponse200
Fields
- success boolean? - If the response is successful or not
- data DealNonStrict? -
- additional_data Dealresponse200AdditionalData? -
- related_objects Getdealsresponse200RelatedObjects? -
pipedrive: Dealresponse200AdditionalData
Fields
- matches_filters int[]? - The array of filter ID's with what this added Deal matches
pipedrive: DealsCountAndActivityInfo
Fields
- Fields Included from *DealsCountAndActivityInfo1
- Fields Included from *DealsCountAndActivityInfo2
pipedrive: DealsCountAndActivityInfo1
Fields
- open_deals_count int? - The count of open Deals related with the item
- related_open_deals_count int? - The count of related open Deals related with the item
- closed_deals_count int? - The count of closed Deals related with the item
- related_closed_deals_count int? - The count of related closed Deals related with the item
- won_deals_count int? - The count of won Deals related with the item
- related_won_deals_count int? - The count of related won Deals related with the item
- lost_deals_count int? - The count of lost Deals related with the item
- related_lost_deals_count int? - The count of related lost Deals related with the item
pipedrive: DealsCountAndActivityInfo2
Fields
- next_activity_date string? - The date of the next activity associated with the Deal
- next_activity_time string? - The time of the next activity associated with the Deal
- next_activity_id int? - The ID of the next activity associated with the Deal
- last_activity_id int? - The ID of the last activity associated with the Deal
- last_activity_date string? - The date of the last activity associated with the Deal
pipedrive: DealStrict
The Deal object
Fields
- Fields Included from *DealStrict1
- Fields Included from *BaseDeal
- stage_id int|()
- title string|()
- value decimal|()
- currency string|()
- add_time string|()
- update_time string|()
- stage_change_time string|()
- active boolean|()
- deleted boolean|()
- status string|()
- probability decimal|()
- next_activity_date string|()
- next_activity_time string|()
- next_activity_id int|()
- last_activity_id int|()
- last_activity_date string|()
- lost_reason string|()
- visible_to string|()
- close_time string|()
- pipeline_id int|()
- won_time string|()
- first_won_time string|()
- lost_time string|()
- products_count int|()
- files_count int|()
- notes_count int|()
- followers_count int|()
- email_messages_count int|()
- activities_count int|()
- done_activities_count int|()
- undone_activities_count int|()
- participants_count int|()
- expected_close_date string|()
- last_incoming_mail_time string|()
- last_outgoing_mail_time string|()
- label string|()
- stage_order_nr int|()
- person_name string|()
- org_name string|()
- next_activity_subject string|()
- next_activity_type string|()
- next_activity_duration string|()
- next_activity_note string|()
- formatted_value string|()
- weighted_value decimal|()
- formatted_weighted_value string|()
- weighted_value_currency string|()
- rotten_time string|()
- owner_name string|()
- cc_email string|()
- org_hidden boolean|()
- person_hidden boolean|()
- anydata...
pipedrive: DealStrict1
Fields
- id int? - The ID of the Deal
- creator_user_id int? - The ID of the Deal creator
- user_id int? - The ID of the User
- person_id int? - The ID of the Person associated with the Deal
- org_id int? - The ID of the Organization associated with the Deal
pipedrive: DealUserDataWithId1
The User who is associated with the Deal
Fields
- id int? - The ID of the User
- name string? - The Name of the User
- email string? - The email of the User
- has_pic boolean? - If the User has a picture or not
- pic_hash string? - The User picture hash
- active_flag boolean? - If the User is activated or not
pipedrive: DealUserDataWithId2
Fields
- value int? - The ID of the User
pipedrive: DeleteActivitiesResponse200
Fields
- success boolean? -
- data Deleteactivitiesresponse200Data? -
pipedrive: Deleteactivitiesresponse200Data
Fields
- id int[]? - An array of IDs of Activities that were deleted
pipedrive: DeleteActivityResponse200
Fields
- success boolean? -
- data Deleteactivityresponse200Data? -
pipedrive: Deleteactivityresponse200Data
Fields
- id int? - The ID of the Activity that was deleted
pipedrive: DeleteActivityTypesResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: Deleteactivitytypesresponse200Data
Fields
- id int[]? - The IDs of deleted ActivityTypes
pipedrive: DeleteCallLogResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: DeleteCommentResponse200
Fields
- success boolean? - If the request was successful or not
- data boolean? - If the response is successful or not
pipedrive: DeleteDealFollowerResponse200
Fields
- success boolean? - If the request was successful or not
pipedrive: Deletedealfollowerresponse200Data
Fields
- id int? - The ID of the Deal Follower that was deleted
pipedrive: DeleteDealParticipantResponse200
Fields
- success boolean? - If the request was successful or not
pipedrive: Deletedealparticipantresponse200Data
Fields
- id int? - The ID of the Deal Participant that was deleted
pipedrive: DeleteDealProductResponse200
Fields
- success boolean? - If the request was successful or not
- data Deletedealproductresponse200Data? -
pipedrive: Deletedealproductresponse200Data
Fields
- id int? - The ID of an attached Product that was deleted from the Deal
- product_attachment_id int? - The ID of an attached Product that was deleted from the Deal
pipedrive: DeleteDealResponse200
Fields
- success boolean? - If the request was successful or not
- data Deletedealresponse200Data? -
pipedrive: Deletedealresponse200Data
Fields
- id int? - The ID of the Deal that was deleted
pipedrive: DeleteDealsResponse200
Fields
- success boolean? - If the response is successful or not
- data Deletedealsresponse200Data? -
pipedrive: Deletedealsresponse200Data
Fields
- id int[]? - The list of deleted Deals IDs
pipedrive: DeleteFieldResponse200
Fields
- success boolean? - If the response is successful or not
- data Deletefieldresponse200Data? -
pipedrive: Deletefieldresponse200Data
Fields
- id int? - The ID of the Field that was deleted
pipedrive: DeleteFieldsResponse200
Fields
- success boolean? - If the response is successful or not
- data Deletefieldsresponse200Data? -
pipedrive: Deletefieldsresponse200Data
Fields
- id int[]? - The list of deleted Field IDs
pipedrive: DeleteFileResponse200
Fields
- success boolean? - If the request was successful or not
- data Deletefileresponse200Data? -
pipedrive: Deletefileresponse200Data
Fields
- id int? - The ID of the File
pipedrive: DeleteFilterResponse200
Fields
- success boolean? - If the response is successful or not
- data Deletefilterresponse200Data? -
pipedrive: Deletefilterresponse200Data
Fields
- id int? - The ID of the deleted filter
pipedrive: DeleteFiltersResponse200
Fields
- success boolean? - If the response is successful or not
- data Deletefiltersresponse200Data? -
pipedrive: Deletefiltersresponse200Data
Fields
- id int[]? - The array of the IDs of the deleted filter
pipedrive: DeleteGlobalMessageResponse200
Fields
- success boolean? - If the request was successful or not
- data Getglobalmessagesresponse200Data? - The Global Message data
- handle_time decimal? - The total time of the controller processing
- _req_time_ctx_ms record {}? - The list of timers formatted by name and elapsed time in ms (such as
app
,app_xss_clean
,db_connect
)
pipedrive: DeleteGoalResponse200
Fields
- success boolean? - If the request was successful or not
pipedrive: DeleteMailThreadResponse200
Fields
- success boolean? - If the response is successful or not
- data BaseMailThread[]? - An array of mail threads
pipedrive: DeleteNoteResponse200
Fields
- success boolean? - If the request was successful or not
- data boolean? - If the response is successful or not
pipedrive: DeleteOrganizationFollowerResponse200
Fields
- success boolean? - If the request was successful or not
pipedrive: Deleteorganizationfollowerresponse200Data
Fields
- id int? - The ID of the follower that was deleted from the Organization
pipedrive: DeleteOrganizationRelationshipResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: Deleteorganizationrelationshipresponse200Data
Fields
- id int? - The ID of the deleted Organization Relationship
pipedrive: DeleteOrganizationResponse200
Fields
- success boolean? - If the request was successful or not
pipedrive: Deleteorganizationresponse200Data
Fields
- id int? - The ID of the Organization that was deleted
pipedrive: DeleteOrganizationsResponse200
Fields
- success boolean? - If the request was successful or not
pipedrive: Deleteorganizationsresponse200Data
Fields
- id decimal[]? - The IDs of the Organizations that were deleted
pipedrive: DeletePersonResponse200
Fields
- success boolean? - If the response is successful or not
- data Deletepersonresponse200Data? -
pipedrive: Deletepersonresponse200Data
Fields
- id int? - The ID of the deleted Person
pipedrive: DeletePersonsResponse200
Fields
- success boolean? - If the response is successful or not
- data Deletepersonsresponse200Data? -
pipedrive: Deletepersonsresponse200Data
Fields
- id int[]? - The list of deleted Persons IDs
pipedrive: DeletePipelineResponse200
Fields
- success boolean? - If the request was successful or not
- data Deletepipelineresponse200Data? -
pipedrive: Deletepipelineresponse200Data
Fields
- id int? - Deleted Pipeline ID
pipedrive: DeleteProductFieldResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: Deleteproductfieldresponse200Data
Fields
- id record {}? - The ID of the deleted Product Field
pipedrive: DeleteProductFieldsResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: Deleteproductfieldsresponse200Data
Fields
- id int[]? - Array of all the IDs of the deleted Product Fields
pipedrive: DeleteProductFollowerResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: Deleteproductfollowerresponse200Data
Fields
- id record {}? - The ID of removed Follower
pipedrive: DeleteProductResponse200
Fields
- success boolean? - If the response is successful or not
- data Deleteproductresponse200Data? -
pipedrive: Deleteproductresponse200Data
Fields
- id record {}? - The ID of removed Product
pipedrive: DeleteRoleAssignmentResponse200
Fields
- success boolean? - If the response is successful or not
- data Deleteroleassignmentresponse200Data? - The response data
pipedrive: Deleteroleassignmentresponse200Data
The response data
Fields
- id record {}? - The ID of the Role the User was removed from
pipedrive: DeleteRoleResponse200
Fields
- success boolean? - If the response is successful or not
- data Deleteroleresponse200Data? - The response data
pipedrive: Deleteroleresponse200Data
The response data
Fields
- id record {}? - The ID of the deleted Role
pipedrive: DeleteStageResponse200
Fields
- success boolean? - If the request was successful or not
- data Deletestageresponse200Data? -
pipedrive: Deletestageresponse200Data
Fields
- id int? - Deleted Stage ID
pipedrive: DeleteStagesResponse200
Fields
- success boolean? - If the request was successful or not
- data Deletestagesresponse200Data? -
pipedrive: Deletestagesresponse200Data
Fields
- id int[]? - The list of deleted Stage IDs
pipedrive: DuplicateDealResponse200
Fields
- success boolean? - If the response is successful or not
- data DealStrict? - The Deal object
pipedrive: Email
Fields
- value string? - Email
- primary boolean? - Boolean that indicates if email is primary for the Person or not
- label string? - Label that indicates the type of the email. (Possible values - work, home or other)
pipedrive: FailResponse
Fields
- success boolean? - If the response is successful or not
- _error string? - The error message
pipedrive: FieldResponse200
Fields
- success boolean? - If the response is successful or not
- data Fieldsresponse200Data? -
pipedrive: FieldsResponse200
Fields
- success boolean? - If the response is successful or not
- data Fieldsresponse200Data[]? -
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: Fieldsresponse200AdditionalData
The additional data of the list
Fields
- 'start int? - Pagination start
- 'limit int? - Items shown per page
- more_items_in_collection boolean? - If there are more list items in the collection than displayed or not
pipedrive: Fieldsresponse200Data
Fields
- id int? - The ID of the Field. Value is
null
in case of subfields.
- 'key string? - The key of the Field. For custom fields this is generated upon creation.
- name string? - The name of the Field
- order_nr int? - The order number of the Field
- field_type record {}? -
- add_time string? - The creation time of the Field
- update_time string? - The update time of the Field
- last_updated_by_user_id int? - The ID of the user who created or most recently updated the Field, only applicable for custom fields
- active_flag boolean? - The active flag of the Field
- edit_flag boolean? - The edit flag of the Field
- index_visible_flag boolean? - Not used
- details_visible_flag boolean? - Not used
- add_visible_flag boolean? - Not used
- important_flag boolean? - Not used
- bulk_edit_allowed boolean? - Whether or not the Field of an Item can be edited in bulk
- searchable_flag boolean? - Whether ot not Items can be searched by this Field
- filtering_allowed boolean? - Whether or not Items can be filtered by this Field
- sortable_flag boolean? - Whether or not Items can be sorted by this Field
- mandatory_flag boolean? - Whether or not the Field is mandatory
- options record {}[]? - The options of the Field. When there are no options,
null
is returned.
- options_deleted record {}[]? - The deleted options of the Field. Only present when there is at least 1 deleted option.
- is_subfield boolean? - Whether or not the Field is a subfield of another Field. Only present if Field is subfield.
- subfields record {}[]? - Subfields of the Field. Only present when Field has subfields.
pipedrive: FindProductsByNameResponse200
Fields
- success boolean? - If the response is successful or not
- additional_data record {}? - Any additional data related to the Products
pipedrive: Findproductsbynameresponse200Data
Fields
- id int? - The ID of the Product
- variation_id string? - The ID of the price variation of the Product
- name string? - The name of the Product
- title string? - The title of the Product
- variation_name string? - The name of the price variation of the Product
- price decimal? - The value corresponding to the Product price
- price_formatted string? - The Product price with the currency format
pipedrive: Follower
Fields
- user_id int? - The ID of the User
- id int? - The ID of the User follower
- person_id int? - The ID of the Person
- add_time string? - The date and time when the Follower was added to the Person
pipedrive: GetActivitiesResponse200
Fields
- success boolean? -
- data ActivityResponseObjectData[]? -
- additional_data Getactivitiesresponse200AdditionalData? -
- related_objects Getactivitiesresponse200RelatedObjects? -
pipedrive: Getactivitiesresponse200AdditionalData
Fields
- pagination Additionaldata2Pagination? - Pagination details of the list
pipedrive: Getactivitiesresponse200RelatedObjects
Fields
- organization Getactivitiesresponse200RelatedObjectsOrganization? -
pipedrive: Getactivitiesresponse200RelatedObjectsDeal
Fields
- DEAL_ID Getactivitiesresponse200RelatedObjectsDealDealId? - The ID of the Deal which is associated with the item
pipedrive: Getactivitiesresponse200RelatedObjectsDealDealId
The ID of the Deal which is associated with the item
Fields
- id int? - The ID of the Deal associated with the item
- title string? - The title of the Deal associated with the item
- status string? - The status of the Deal associated with the item
- value decimal? - The value of the Deal that is associated with the item
- currency string? - The currency of the Deal value
- stage_id int? - The ID of the stage the Deal is currently at
- pipeline_id int? - The ID of the pipeline the Deal is in
pipedrive: Getactivitiesresponse200RelatedObjectsOrganization
Fields
pipedrive: Getactivitiesresponse200RelatedObjectsPerson
Fields
pipedrive: Getactivitiesresponse200RelatedObjectsUser
Fields
pipedrive: GetActivityResponse200
Fields
- success boolean? -
- data ActivityResponseObjectData? -
- related_objects Getactivitiesresponse200RelatedObjects? -
pipedrive: GetActivityTypesResponse200
Fields
- success boolean? - If the response is successful or not
- data Getactivitytypesresponse200Data[]? - The array of ActivityTypes
pipedrive: Getactivitytypesresponse200Data
Fields
- id int? - The ID of the ActivityType
- name string? - The name of the ActivityType
- icon_key string? - Icon graphic to use for representing this activity type.
- color string? - A designated color for the ActivityType in 6-character HEX format (e.g.
FFFFFF
for white,000000
for black)
- order_nr int? - An order number for this ActivityType. Order numbers should be used to order the types in the ActivityType selections.
- key_string string? - A string that is generated by the API based on the given name of the ActivityType upon creation
- active_flag boolean? - The active flag of the ActivityType
- is_custom_flag boolean? - Whether the ActivityType is a custom one or not
- add_time string? - The creation time of the ActivityType
- update_time string? - The update time of the ActivityType
pipedrive: GetAddProductAttachementResponse200
Fields
- success boolean? - If the response is successful or not
- data record { item_price decimal?, quantity int?, discount_percentage decimal?, duration decimal?, product_variation_id int?, comments string?, enabled_flag record {}, id int?, company_id int?, deal_id int?, product_id int?, duration_unit string?, sum_no_discount decimal?, sum decimal?, currency string?, add_time string?, last_edit string?, active_flag boolean?, tax decimal?, name string?, product_attachment_id int? }? - The added Product object attached to the Deal
pipedrive: GetAllMailMessagesOfMailThreadResponse200
Fields
- success boolean? - If the response is successful or not
- data MailMessages[]? - The array of the mail messages of the mail thread
pipedrive: GetAssociatedActivitiesResponse200
Fields
- success boolean? - If the response is successful or not
- data ActivityResponseObjectData[]? - The array of Activities
- additional_data ActivityDistributionDataWithAdditionalData? -
pipedrive: GetAssociatedDealsResponse200
Fields
- success boolean? - If the response is successful or not
- data DealNonStrict[]? - The array of Deals
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
- related_objects Getassociateddealsresponse200RelatedObjects? -
pipedrive: Getassociateddealsresponse200RelatedObjects
Fields
- organization Addactivityresponse200RelatedObjectsOrganization? -
pipedrive: GetAssociatedFilesResponse200
Fields
- success boolean? - If the response is successful or not
- data Getassociatedfilesresponse200Data[]? - The array of Files
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: Getassociatedfilesresponse200Data
The File data
Fields
- id int? - The ID of the File
- user_id int? - The ID of the User to associate the File with
- deal_id int? - The ID of the Deal to associate the File with
- person_id int? - The ID of the Person to associate the File with
- org_id int? - The ID of the Organization to associate the File with
- product_id int? - The ID of the Product to associate the File with
- activity_id int? - The ID of the Activity to associate the File with
- add_time string? - The date and time when the File was added/created. Format: YYYY-MM-DD HH:MM:SS
- update_time string? - The last updated date and time of the File. Format: YYYY-MM-DD HH:MM:SS
- file_name string? - The original name of the File
- file_size string? - The size of the File
- active_flag boolean? - Whether the User is active or not. false = Not activated, true = Activated
- inline_flag boolean? - Whether the File was uploaded as inline or not
- remote_location string? - The location type to send the File to. Only googledrive is supported at the moment.
- remote_id string? - The ID of the remote item
- cid string? - The ID of the inline attachment
- s3_bucket string? - The location of the cloud storage
- mail_message_id string? - The ID of the mail message to associate the File with
- mail_template_id string? - The ID of the mail template to associate the File with
- deal_name string? - The name of the Deal associated with the File
- person_name string? - The name of the Person associated with the File
- org_name string? - The name of the Organization associated with the File
- product_name string? - The name of the Product associated with the File
- url string? - The URL of the download File
- name string? - The visible name of the File
- description string? - The description of the File
pipedrive: GetAssociatedFollowersResponse200
Fields
- success boolean? - If the response is successful or not
- data Follower[]? - The list of Followers
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: Getassociatedfollowersresponse2001
Fields
- success boolean? - If the request was successful or not
- data Follower[]? - The array of followers
- additional_data Getactivitiesresponse200AdditionalData? -
pipedrive: GetAssociatedMailMessagesResponse200
Fields
- success boolean? - If the response is successful or not
- data MailMessages[]? - The array of Mail Messages
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: GetAssociatedPersonUpdatesResponse200
Fields
- success boolean? - If the response is successful or not
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
- related_objects Getdealupdatesresponse200RelatedObjects? -
pipedrive: Getassociatedpersonupdatesresponse200Data
Fields
- 'object string? - The type of the Person update. (Possible object types - personChange, note, activity, file)
- timestamp string? - The creation date and time of the update
- data record {}? - The data related to the update
pipedrive: GetAssociatedUpdatesResponse200
Fields
- success boolean? - If the response is successful or not
- data Getassociatedupdatesresponse200Data[]? -
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
- related_objects Getassociatedupdatesresponse200RelatedObjects? -
pipedrive: Getassociatedupdatesresponse200Data
Fields
- 'object string? - The type of the Person update. (Possible object types - organizationChange, dealChange, file, activity)
- timestamp string? - The creation date and time of the update
- data record {}? - The data related to the update
pipedrive: Getassociatedupdatesresponse200RelatedObjects
Fields
- organization Getactivitiesresponse200RelatedObjectsOrganization? -
pipedrive: GetCommentsResponse200
Fields
- success boolean? - If the request was successful or not
- data Getcommentsresponse200Data[]? - The array of Comments
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: Getcommentsresponse200Data
Fields
- uuid string? - The ID of the Note
- active_flag boolean? - If Note is active or deleted
- add_time string? - The creation date and time of the Note
- update_time string? - The creation date and time of the Note
- content string? - Content of the Note in HTML format. Subject to sanitization on the back-end.
- object_id string? - The ID of the object that the comment is attached to, will be the id of the note
- object_type string? - The type of object that the comment is attached to, will be "note"
- user_id int? - The ID of the User who created the comment
- updater_id int? - The ID of the User who last updated the comment
- company_id int? - The ID of the company
pipedrive: GetCurrenciesResponse200
Fields
- success boolean? - If the response is successful or not
- data Getcurrenciesresponse200Data[]? - The array of Currencies
pipedrive: Getcurrenciesresponse200Data
Fields
- id int? - ID of the Currency
- code string? - Code of the Currency
- name string? - Name of the Currency
- decimal_points int? - The amount of decimal points of the Currency
- symbol string? - Symbol of the Currency
- active_flag boolean? - Whether the Currency is active or not
- is_custom_flag boolean? - Whether the Currency is a custom one or not
pipedrive: GetCurrentUserResponse200
Fields
- success boolean? - If the response is successful or not
- data User? -
pipedrive: GetDealActivitiesResponse200
Fields
- success boolean? - If the response is successful or not
- data ActivityResponseObjectData[]? - The array of Activities
- additional_data ActivityDistributionDataWithAdditionalData? -
- related_objects Getdealactivitiesresponse200RelatedObjects? -
pipedrive: Getdealactivitiesresponse200RelatedObjects
Fields
- organization Addactivityresponse200RelatedObjectsOrganization? -
pipedrive: GetDealParticipantsResponse200
Fields
- success boolean? - If the request was successful or not
- data PersonItem[]? - The array of Participants
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
- related_objects Getdealsresponse200RelatedObjects? -
pipedrive: GetDealResponse200
Fields
- success boolean? - If the response is successful or not
- data DealNonStrict? -
- additional_data Getdealresponse200AdditionalData? -
- related_objects Getdealsresponse200RelatedObjects? -
pipedrive: Getdealresponse200AdditionalData
Fields
- dropbox_email string? - The Cc email of the Deal
pipedrive: GetDealsByNameResponse200
Fields
- success boolean? - If the response is successful or not
- data Getdealsbynameresponse200Data[]? -
- additional_data Getdealsbynameresponse200AdditionalData? -
pipedrive: Getdealsbynameresponse200AdditionalData
Fields
- pagination Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: Getdealsbynameresponse200Data
The array of Deals filtered by name
Fields
- id int? - The ID of the Deal
- title string? - The title of the Deal
- user_id int? - The ID of the User who is associated with the Deal
- visible_to string? - The visibility of the Deal
- status string? - The status of the Deal
- value decimal? - The value of the Deal
- currency string? - The currency associated with the Deal
- person_name string? - The name of the Person associated with the Deal
- person_id int? - The ID of the Person associated with the Deal
- organization_name string? - The name of the Organization associated with the Deal
- organization_id int? - The ID of the Person associated with the Deal
- formatted_value string? - The Deal value formatted with selected currency. E.g. US$500
- cc_email string? - The Cc email of the Deal
pipedrive: GetDealsResponse200
Fields
- success boolean? - If the response is successful or not
- data DealNonStrict[]? - The array of Deals
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
- related_objects Getdealsresponse200RelatedObjects? -
pipedrive: Getdealsresponse200RelatedObjects
Fields
- user Getdealsresponse200RelatedObjectsUser? - The User who is associated with the Deal
- organization Getdealsresponse200RelatedObjectsOrganization? - The Organization which is associated with the Deal
- person Getdealsresponse200RelatedObjectsPerson? - The Person who is associated with the Deal
pipedrive: Getdealsresponse200RelatedObjectsOrganization
The Organization which is associated with the Deal
Fields
- name string? - The name of the Organization associated with the Deal
- people_count int? - The number of people connected with the Organization that is associated with the Deal
- owner_id int? - The ID of the owner of the Organization that is associated with the Deal
- address string? - The address of the Organization that is associated with the Deal
- active_flag boolean? - If the associated Organization is activated or not
- cc_email string? - The CC email of the Organization associated with the Deal
pipedrive: Getdealsresponse200RelatedObjectsPerson
The Person who is associated with the Deal
Fields
- active_flag boolean? - If the associated Person is activated or not
- name string? - The name of the Person associated with the Deal
- email Dealpersondatawithid1Email[]? - The emails of the Person associated with the Deal
- phone Dealpersondatawithid1Phone[]? - The phone numbers of the Person associated with the Deal
- owner_id int? - The ID of the owner of the Person that is associated with the Deal
pipedrive: Getdealsresponse200RelatedObjectsUser
The User who is associated with the Deal
Fields
- id int? - The ID of the User
- name string? - The Name of the User
- email string? - The email of the User
- has_pic boolean? - If the User has a picture or not
- pic_hash string? - The User picture hash
- active_flag boolean? - If the User is activated or not
pipedrive: GetDealsSummaryResponse200
Fields
- success boolean? - If the response is successful or not
- data Getdealssummaryresponse200Data? - The summary of Deals
pipedrive: Getdealssummaryresponse200Data
The summary of Deals
Fields
- values_total Getdealssummaryresponse200DataValuesTotal? - The total values of the Deals grouped by Deal currency
- weighted_values_total Getdealssummaryresponse200DataWeightedValuesTotal? - The total weighted values of the Deals grouped by Deal currency. The weighted value is calculated as probability times Deal value.
- total_count int? - The total number of Deals
- total_currency_converted_value decimal? - The total value of Deals converted into the company default currency
- total_weighted_currency_converted_value decimal? - The total weighted value of Deals converted into the company default currency
- total_currency_converted_value_formatted string? - The total converted value of Deals formatted with the company default currency. E.g. US$5,100.96
- total_weighted_currency_converted_value_formatted string? - The total weighted value of Deals formatted with the company default currency. E.g. US$5,100.96
pipedrive: Getdealssummaryresponse200DataValuesTotal
The total values of the Deals grouped by Deal currency
Fields
- value decimal? - The total value of Deals in the Deal currency group
- count int? - The number of Deals in the Deal currency group
- value_converted decimal? - The total value of Deals converted into the company default currency
- value_formatted string? - The total value of Deals formatted with Deal currency. E.g. €50
- value_converted_formatted string? - The value_converted formatted with Deal currency. E.g. US$50.10
pipedrive: Getdealssummaryresponse200DataWeightedValuesTotal
The total weighted values of the Deals grouped by Deal currency. The weighted value is calculated as probability times Deal value.
Fields
- value decimal? - The total weighted value of the Deals in the Deal currency group
- count int? - The number of Deals in the Deal currency group
- value_formatted string? - The total weighted value of the Deals formatted with Deal currency. E.g. €50
pipedrive: GetDealsTimelineResponse200
Fields
- success boolean? - If the response is successful or not
- data Getdealstimelineresponse200Data? - Open and won Deals grouped into periods by defined interval, amount and date-type dealField (
field_key
)
pipedrive: Getdealstimelineresponse200Data
Open and won Deals grouped into periods by defined interval, amount and date-type dealField (field_key
)
Fields
- period_start string? - The start date and time of the period
- period_end string? - The end date and time of the period
- deals DealStrict[]? - The array of Deal objects
- totals Getdealstimelineresponse200DataTotals? - The total values of Deals for the given period
pipedrive: Getdealstimelineresponse200DataTotals
The total values of Deals for the given period
Fields
- count int? - The number of Deals for the given period
- values record {}? - The total values of Deals grouped by Deal currency
- weighted_values record {}? - The total weighted values of Deals for the given period grouped by Deal currency. The weighted value of a Deal is calculated as probability times Deal value.
- open_count int? - The number of open Deals for the given period
- open_values record {}? - The total values of open Deals for the given period grouped by Deal currency
- weighted_open_values record {}? - The total weighted values of open Deals for the given period grouped by Deal currency. The weighted value of a Deal is calculated as probability times Deal value.
- won_count int? - The number of won Deals for the given period
- won_values record {}? - The total values of won Deals for the given period grouped by Deal currency
pipedrive: GetDealUpdatesResponse200
Fields
- success boolean? - If the response is successful or not
- data Getdealupdatesresponse200Data[]? -
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
- related_objects Getdealupdatesresponse200RelatedObjects? -
pipedrive: Getdealupdatesresponse200Data
Fields
- 'object string? - The type of the Deal update. (Possible object types - dealChange, note, activity, mailMessage, invoice, document, file)
- timestamp string? - The creation date and time of the update
- data record {}? - The data related to the update
pipedrive: Getdealupdatesresponse200RelatedObjects
Fields
- organization Getactivitiesresponse200RelatedObjectsOrganization? -
pipedrive: GetFileResponse200
Fields
- success boolean? - If the request was successful or not
- data Getassociatedfilesresponse200Data? - The File data
pipedrive: GetFilesResponse200
Fields
- success boolean? - If the request was successful or not
- data Getassociatedfilesresponse200Data[]? - The array of all uploaded files
- additional_data Getfilesresponse200AdditionalData? -
pipedrive: Getfilesresponse200AdditionalData
Fields
pipedrive: GetFilterResponse200
Fields
- success boolean? - If the response is successful or not
- data Getfiltersresponse200Data? - The filter object
pipedrive: GetFiltersResponse200
Fields
- success boolean? - If the response is successful or not
- data Getfiltersresponse200Data[]? - The array of filters
pipedrive: Getfiltersresponse200Data
The filter object
Fields
- id int? - The ID of the filter
- name string? - The name of the filter
- active_flag boolean? - The active flag of the filter
- 'type string? - The type of the item
- user_id int? - The owner of the filter
- add_time string? - The date and time when the filter was added
- update_time string? - The date and time when the filter was updated
- visible_to int? - The visibility group ID of who can see then filter
- custom_view_id int? - Used by Pipedrive webapp
pipedrive: GetGlobalMessagesResponse200
Fields
- success boolean? - If the request was successful or not
- data Getglobalmessagesresponse200Data[]? - The array of Global Messages
- handle_time decimal? - The total time of the controller processing
- _req_time_ctx_ms record {}? - The list of timers formatted by name and elapsed time in ms (such as
app
,app_xss_clean
,app_sanitizer_xss
)
pipedrive: Getglobalmessagesresponse200Data
The Global Message data
Fields
- id int? - The ID of the Global Message
- user_id int? - The ID of the User related to the Global Message
- company_id int? - The ID of the Company related to the Global Message
- type_info Getglobalmessagesresponse200TypeInfo? - The Global Message type info
- user_data record {}? - The User data for the Global Message (such as
user_id
,name
,email
,phone
)
- html string? - HTML for each returned Global Message to render views
pipedrive: Getglobalmessagesresponse200TypeInfo
The Global Message type info
Fields
- message_type string? - The Global Message type for validation checks
- dismissible_flag boolean? - Whether a User can dismiss the Global Message or not
- priority int? - Sorts messages by priority DESC (from 0 to 10)
pipedrive: GetGoalResultResponse200
Fields
- success boolean? - If the request was successful or not
- data Getgoalresultresponse200Data? -
pipedrive: Getgoalresultresponse200Data
Fields
- progress int? - Numeric progress of the goal
pipedrive: GetGoalsResponse200
Fields
- success boolean? - If the request was successful or not
- data Getgoalsresponse200Data? -
pipedrive: Getgoalsresponse200Data
Fields
- goals Goal[]? -
pipedrive: GetLeadLabelsResponse200
Fields
- success boolean? -
- data Getleadlabelsresponse200Data[]? -
pipedrive: Getleadlabelsresponse200Data
Fields
- id string? - The unique ID of the Lead Label
- name string? - The name of the Lead Label
- color string? - The color of the label. Only a subset of colors can be used.
- add_time string? - The date and time of when the Lead Label was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
- update_time string? - The date and time of when the Lead Label was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
pipedrive: GetLeadSourcesResponse200
Fields
- success boolean? -
- data Getleadsourcesresponse200Data[]? -
pipedrive: Getleadsourcesresponse200Data
Fields
- name string? - The unique name of a Lead Source
pipedrive: GetLeadsResponse200
Fields
- success boolean? -
- data Getleadsresponse200Data[]? -
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: Getleadsresponse200Data
Fields
- id string? - The unique ID of the Lead in the UUID format
- title string? - The title of the Lead
- owner_id int? - The ID of the User who owns the Lead
- creator_id int? - The ID of the User who created the Lead
- label_ids string[]? - The IDs of the Lead Labels which are associated with the Lead
- person_id int? - The ID of a Person which this Lead is linked to
- organization_id int? - The ID of an Organization which this Lead is linked to
- source_name string? - Defines where the Lead comes from. Will be
API
if the Lead was created through the Public API and will beManually created
if the Lead was created manually through the UI.
- is_archived boolean? - A flag indicating whether the Lead is archived or not
- was_seen boolean? - A flag indicating whether the Lead was seen by someone in the Pipedrive UI
- value LeadsValue? - The potential value of the Lead.
- expected_close_date string? - The date of when the Deal which will be created from the Lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.
- next_activity_id int? - The ID of the next activity associated with the Lead
- add_time string? - The date and time of when the Lead was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
- update_time string? - The date and time of when the Lead was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
- visible_to record {}? - Visibility of the Lead. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td></tr><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
- cc_email string? - The CC email of the lead
pipedrive: GetMailThreadsResponse200
Fields
- success boolean? - If the response is successful or not
- data BaseMailThread[]? - The array of mail threads
pipedrive: GetNoteFieldsResponse200
Fields
- success boolean? - If the response is successful or not
- data Getnotefieldsresponse200Data[]? -
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: Getnotefieldsresponse200Data
Fields
- id int? - The ID of the Field
- 'key string? - The key of the Field
- name string? - The name of the Field
- field_type string? - Type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>
address
</td><td>Address field (has multiple subfields, autocompleted by Google Maps)</td></tr><tr><td>date
</td><td>Date (format YYYY-MM-DD)</td></tr><tr><td>daterange
</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td></tr><tr><td>double
</td><td>Numeric value</td></tr><tr><td>enum
</td><td>Options field with a single possible chosen option</td></tr><tr><td>int
</td><td>Integer value</td></tr><tr><td>monetary
</td><td>Monetary field (has a numeric value and a currency value)</td></tr><tr><td>org
</td><td>Organization field (contains an organization ID which is stored on the same account)</td></tr><tr><td>people
</td><td>Person field (contains a person ID which is stored on the same account)</td></tr><tr><td>phone
</td><td>Phone field (up to 255 numbers and/or characters)</td></tr><tr><td>set
</td><td>Options field with a possibility of having multiple chosen options</td></tr><tr><td>text
</td><td>Long text (up to 65k characters)</td></tr><tr><td>time
</td><td>Time field (format HH:MM:SS)</td></tr><tr><td>timerange
</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td></tr><tr><td>user
</td><td>User field (contains a user ID of another Pipedrive user)</td></tr><tr><td>varchar
</td><td>Text (up to 255 characters)</td></tr><tr><td>varchar_auto
</td><td>Autocomplete text (up to 255 characters)</td></tr><tr><td>visible_to
</td><td>System field that keeps item's visibility setting</td></tr></table>
- active_flag boolean? - The active flag of the Field
- edit_flag boolean? - The edit flag of the Field
- bulk_edit_allowed boolean? - Not used
- mandatory_flag boolean? - Whether or not the Field is mandatory
- options record {}[]? - The options of the Field. When there are no options,
null
is returned.
pipedrive: GetNotesResponse200
Fields
- success boolean? - If the request was successful or not
- data Getnotesresponse200Data[]? - The array of Notes
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: Getnotesresponse200Data
Fields
- id int? - The ID of the Note
- active_flag boolean? - If Note is active or deleted
- add_time string? - The creation date and time of the Note
- content string? - Content of the Note in HTML format. Subject to sanitization on the back-end.
- deal Getnotesresponse200Deal? - The Deal this Note is attached to
- lead_id string? - The ID of the Lead the Note is attached to
- deal_id int? - The ID of the Deal the Note is attached to
- last_update_user_id int? - The ID of the User who updated the Note last
- org_id int? - The ID of the Organization this Note is attached to
- organization Getnotesresponse200Organization? - The Organization this Note is attached to
- person Getnotesresponse200Person? - The Person this Note is attached to
- person_id int? - The ID of the Person this Note is attached to
- pinned_to_deal_flag boolean? - If true, then the results are filtered by Note to Deal pinning state.
- pinned_to_organization_flag boolean? - If true, then the results are filtered by Note to Organization pinning state.
- pinned_to_person_flag boolean? - If true, then the results are filtered by Note to Person pinning state.
- update_time string? - The last updated date and time of the Note
- user Getnotesresponse200User? - The User who created the Note
- user_id int? - The ID of the Note creator
pipedrive: Getnotesresponse200Deal
The Deal this Note is attached to
Fields
- title string? - The title of the Deal this Note is attached to
pipedrive: Getnotesresponse200Organization
The Organization this Note is attached to
Fields
- name string? - The name of the Organization this Note is attached to
pipedrive: Getnotesresponse200Person
The Person this Note is attached to
Fields
- name string? - The name of the Person this Note is attached to
pipedrive: Getnotesresponse200User
The User who created the Note
Fields
- email string? - The Email of the Note creator
- icon_url string? - The URL of the Note creator avatar picture
- is_you boolean? - If the Note is created by you or not
- name string? - The name of the Note creator
pipedrive: GetOneMailThreadResponse200
Fields
- success boolean? - If the response is successful or not
- data BaseMailThreadData? - The mail thread object
pipedrive: GetOrganizationRelationshipResponse200
Fields
- success boolean? - If the response is successful or not
- related_objects Getorganizationrelationshipsresponse200RelatedObjects? -
pipedrive: GetOrganizationRelationshipsResponse200
Fields
- success boolean? - If the response is successful or not
- data OrganizationRelationshipDetails[]? - The array of Organization Relationships
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
- related_objects Getorganizationrelationshipsresponse200RelatedObjects? -
pipedrive: Getorganizationrelationshipsresponse200RelatedObjects
Fields
- organization Getactivitiesresponse200RelatedObjectsOrganization? -
pipedrive: GetOrganizationResponse200
Fields
- success boolean? - If the response is successful or not
- data OrganizationItem1? -
- additional_data Getorganizationresponse200AdditionalData? -
- related_objects Getorganizationsresponse200RelatedObjects? -
pipedrive: Getorganizationresponse200AdditionalData
Fields
- followers Getorganizationresponse200AdditionalDataFollowers? - The follower that is associated with the item
- dropbox_email string? - Dropbox email for the Organization
pipedrive: Getorganizationresponse200AdditionalDataFollowers
The follower that is associated with the item
Fields
pipedrive: GetOrganizationsResponse200
Fields
- success boolean? - If the response is successful or not
- data BaseOrganizationItem[]? - The array of Organizations
- additional_data Getactivitiesresponse200AdditionalData? -
- related_objects Getorganizationsresponse200RelatedObjects? -
pipedrive: Getorganizationsresponse200RelatedObjects
Fields
- organization Getactivitiesresponse200RelatedObjectsOrganization? -
- picture Getorganizationsresponse200RelatedObjectsPicture? - The picture that is associated with the item
pipedrive: Getorganizationsresponse200RelatedObjectsPicture
The picture that is associated with the item
Fields
pipedrive: GetPermissionSetsResponse200
Fields
- success boolean? - If the response is successful or not
- data Getpermissionsetsresponse200Data[]? - The array of Permission Set
pipedrive: Getpermissionsetsresponse200Data
Fields
- id int? - The ID of User Permission Set
- name string? - The name of Permission Set
- assignment_count int? - The number of Users assigned to this Permission Set
pipedrive: GetPersonProductsResponse200
Fields
- success boolean? - If the response is successful or not
- data Getpersonproductsresponse200Data[]? - The array of Deal Products
- additional_data Getactivitiesresponse200AdditionalData? -
pipedrive: Getpersonproductsresponse200Data
Fields
- DEAL_ID Getpersonproductsresponse200DealId? -
pipedrive: Getpersonproductsresponse200DealId
Fields
- product Getpersonproductsresponse200DealIdProduct? -
pipedrive: Getpersonproductsresponse200DealIdDeal
Fields
- id int? - The ID of the Deal
- company_id int? - The ID of the company
- creator_user_id int? - The ID of the Deal creator
- user_id int? - The ID of the User
- person_id int? - The ID of the Person associated with the Deal
- org_id int? - The ID of the Organization associated with the Deal
- stage_id int? - The ID of the Deal stage
- title string? - The title of the Deal
- value decimal? - The value of the Deal
- currency string? - The currency associated with the Deal
- add_time string? - The creation date and time of the Deal
- first_add_time string? - First creation date and time of the Deal
- update_time string? - The last updated date and time of the Deal
- stage_change_time string? - The last updated date and time of the Deal stage
- active boolean? - If the Deal is activated or not
- deleted boolean? - If the Deal is deleted or not
- status string? - The status of the Deal
- probability decimal? - The success probability percentage of the Deal
- next_activity_date string? - The date of the next activity associated with the Deal
- next_activity_time string? - The time of the next activity associated with the Deal
- next_activity_id int? - The ID of the next activity associated with the Deal
- last_activity_id int? - The ID of the last activity associated with the Deal
- last_activity_date string? - The date of the last activity associated with the Deal
- lost_reason string? - The reason for losing the Deal
- visible_to string? - The visibility of the Deal
- close_time string? - The date and time of closing the Deal
- pipeline_id int? - The ID of pipeline associated with the Deal
- won_time string? - The date and time of changing the Deal status as won
- first_won_time string? - The date and time of the first time changing the Deal status as won
- lost_time string? - The date and time of changing the Deal status as lost
- products_count int? - The number of Products associated with the Deal
- files_count int? - The number of Files associated with the Deal
- notes_count int? - The number of Notes associated with the Deal
- followers_count int? - The number of Followers associated with the Deal
- email_messages_count int? - The number of emails associated with the Deal
- activities_count int? - The number of Activities associated with the Deal
- done_activities_count int? - The number of completed Activities associated with the Deal
- undone_activities_count int? - The number of incomplete Activities associated with the Deal
- participants_count int? - The number of Participants associated with the Deal
- expected_close_date string? - The expected close date of the Deal
- last_incoming_mail_time string? - The date and time of the last incoming email associated with the Deal
- last_outgoing_mail_time string? - The date and time of the last outgoing email associated with the Deal
- label string? - The label assigned to the Deal
pipedrive: Getpersonproductsresponse200DealIdProduct
Fields
- id int? - The ID of the Product
- company_id int? - The ID of the company
- name string? - The name of the product
- code string? - Product code
- description string? - The Description of the Product
- unit string? - Unit in which this product is sold
- tax decimal? - Tax percentage
- category string? - Category of the Product
- active_flag decimal? - Whether this product will be made active or not
- selectable decimal? - Whether this product can be selected in Deals or not
- first_char string? - The First letter of the Product name
- visible_to record {}? - Visibility of the product. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td></tr><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
- owner_id int? - The ID of the user who will be marked as the owner of this product. When omitted, authorized user ID will be used.
- files_count int? - Files count
- followers_count int? - Followers count
- add_time string? - The date and time when the Product was added to the Deal
- update_time string? - The date and time when the Product was updated to the Deal
- deal_id int? - The ID of the Deal
pipedrive: GetPersonResponse200
Fields
- success boolean? - If the response is successful or not
- data record { id int?, company_id int?, active_flag boolean?, phone record { value string?, primary boolean?, label string? }[]?, email record { value string?, primary boolean?, label string? }[]?, first_char string?, add_time string?, update_time string?, visible_to string?, picture_id record { id int?, item_type string?, item_id int?, active_flag boolean?, add_time string?, update_time string?, added_by_user_id int?, pictures record { '128 string?, '512 string? } }, label int?, org_name string?, owner_name string?, cc_email string?, owner_id record { id int?, name string?, email string?, has_pic int?, pic_hash string?, active_flag boolean?, value int? }, org_id record { name string?, people_count int?, owner_id int?, address string?, cc_email string?, value int?, active_flag boolean? }, name string?, first_name string?, last_name string?, email_messages_count int?, activities_count int?, done_activities_count int?, undone_activities_count int?, files_count int?, notes_count int?, followers_count int?, last_incoming_mail_time string?, last_outgoing_mail_time string?, open_deals_count int?, related_open_deals_count int?, closed_deals_count int?, related_closed_deals_count int?, won_deals_count int?, related_won_deals_count int?, lost_deals_count int?, related_lost_deals_count int?, next_activity_date string?, next_activity_time string?, next_activity_id int?, last_activity_id int?, last_activity_date string? }? -
- additional_data Getpersonresponse200AdditionalData? -
- related_objects Getorganizationsresponse200RelatedObjects? -
pipedrive: Getpersonresponse200AdditionalData
Fields
- dropbox_email string? - Dropbox email for the Person
pipedrive: GetPersonsResponse200
Fields
- success boolean? - If the response is successful or not
- data PersonItem[]? - The array of Persons
- additional_data Getactivitiesresponse200AdditionalData? -
- related_objects Getorganizationsresponse200RelatedObjects? -
pipedrive: GetPipelineConversionStatisticsResponse200
Fields
- success boolean? - If the response is successful or not
- data Getpipelineconversionstatisticsresponse200Data? - The Pipeline object
pipedrive: Getpipelineconversionstatisticsresponse200Data
The Pipeline object
Fields
- stage_conversions Getpipelineconversionstatisticsresponse200DataStageConversions[]? - The Stage conversions
- won_conversion int? - Won conversion
- lost_conversion int? - Lost conversion
pipedrive: Getpipelineconversionstatisticsresponse200DataStageConversions
Fields
- from_stage_id int? - The Stage ID from where conversion starts
- to_stage_id int? - The Stage ID to where conversion ends
- conversion_rate int? - Conversion rate
pipedrive: GetPipelineMovementStatisticsResponse200
Fields
- success boolean? - If the response is successful or not
- data Getpipelinemovementstatisticsresponse200Data? - The Pipeline object
pipedrive: Getpipelinemovementstatisticsresponse200Data
The Pipeline object
Fields
- movements_between_stages Getpipelinemovementstatisticsresponse200DataMovementsBetweenStages? - Movements between Stages
- new_deals Getpipelinemovementstatisticsresponse200DataNewDeals? - Deals summary
- deals_left_open Getpipelinemovementstatisticsresponse200DataNewDeals? - Deals summary
- won_deals Getpipelinemovementstatisticsresponse200DataNewDeals? - Deals summary
- lost_deals Getpipelinemovementstatisticsresponse200DataNewDeals? - Deals summary
- average_age_in_days Getpipelinemovementstatisticsresponse200DataAverageAgeInDays? - Moved Deals average age in days
pipedrive: Getpipelinemovementstatisticsresponse200DataAverageAgeInDays
Moved Deals average age in days
Fields
- across_all_stages int? - Moved Deals average age across all Stages
- by_stages Getpipelinemovementstatisticsresponse200DataAverageAgeInDaysByStages[]? - Moved Deals average age by Stages
pipedrive: Getpipelinemovementstatisticsresponse200DataAverageAgeInDaysByStages
Moved Deals average age by the Stage
Fields
- stage_id int? - The Stage ID
- value int? - Average Deals age in specific Stage
pipedrive: Getpipelinemovementstatisticsresponse200DataMovementsBetweenStages
Movements between Stages
Fields
- count int? - The count of the Deals that have been moved between Stages
pipedrive: Getpipelinemovementstatisticsresponse200DataNewDeals
Deals summary
Fields
- count int? - Deals count
- deals_ids int[]? - IDs of the Deals that have been moved
- values Getpipelinemovementstatisticsresponse200DataNewDealsValues? - Deals values
- formatted_values Getpipelinemovementstatisticsresponse200DataNewDealsFormattedValues? - Deals values formatted
pipedrive: Getpipelinemovementstatisticsresponse200DataNewDealsFormattedValues
Deals values formatted
Fields
- CURRENCY_ID string? - Deals value formatted
pipedrive: Getpipelinemovementstatisticsresponse200DataNewDealsValues
Deals values
Fields
- CURRENCY_ID int? - Deals value
pipedrive: GetPipelineResponse200
Fields
- success boolean? - If the response is successful or not
- data record { id int?, name string?, url_title string?, order_nr int?, active boolean?, deal_probability boolean?, add_time string?, update_time string?, selected boolean?, deals_summary record { per_stages record { STAGE_ID record { CURRENCY_ID record { count int?, value int?, value_formatted string?, weighted_value int?, weighted_value_formatted string? } } }, per_currency record { CURRENCY_ID int? }, total_count int?, per_currency_full record { CURRENCY_ID record { count int?, value int? } } } }? - The Pipeline object
pipedrive: GetPipelinesResponse200
Fields
- success boolean? - If the response is successful or not
- data BasePipelineWithSelectedFlag[]? - Pipelines array
pipedrive: GetProductAttachementResponse200
Fields
- success boolean? - If the response is successful or not
- data BasicDealProductRequestData? -
pipedrive: GetProductFieldResponse200
Fields
- success boolean? - If the response is successful or not
- data ProductFieldData? -
pipedrive: GetProductFieldsResponse200
Fields
- success boolean? - If the response is successful or not
- data ProductField[]? - Array containing data for all Product Fields
- additional_data record {}? - Additional data for the Product Field, such as pagination
pipedrive: GetProductFollowersResponseSuccess
Fields
- success boolean? - If the response is successful or not
- data GetproductfollowersresponsesuccessData[]? - The list of Followers
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: GetproductfollowersresponsesuccessData
Fields
- user_id int? - The ID of the User
- id int? - The ID of the User follower
- product_id int? - The ID of the Product
- add_time string? - The date and time when the Follower was added to the Person
pipedrive: GetproductResponse200
Fields
- success boolean? - If the response is successful or not
- data Product? -
- related_objects Getactivitiesresponse200RelatedObjects? -
pipedrive: Getproductresponse2001
Fields
- success boolean? - If the response is successful or not
- data Product? -
- related_objects Getactivitiesresponse200RelatedObjects? -
pipedrive: GetProductsResponse200
Fields
- success boolean? - If the response is successful or not
- data Getproductresponse2001[]? - Array containing data for all Products
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
- related_objects Getactivitiesresponse200RelatedObjects? -
pipedrive: GetRecentsResponse200
Fields
- success boolean? - If the response is successful or not
- data (record { item string?, id int?, data record { due_date string?, due_time string?, duration string?, deal_id int?, person_id int?, org_id int?, note string?, location string?, public_description string?, id string?, done boolean?, subject string?, 'type string?, user_id int?, participants record {}[]?, busy_flag boolean?, attendees record {}[]?, company_id int?, reference_type string?, reference_id int?, conference_meeting_client string?, conference_meeting_url string?, conference_meeting_id string?, add_time string?, marked_as_done_time string?, last_notification_time string?, last_notification_user_id int?, notification_language_id int?, lead_id string?, active_flag boolean?, update_time string?, update_user_id int?, gcal_event_id string?, google_calendar_id string?, google_calendar_etag string?, calendar_sync_include_context string?, source_timezone string?, rec_rule string?, rec_rule_extension string?, rec_master_activity_id int?, series record {}[]?, created_by_user_id int?, location_subpremise string?, location_street_number string?, location_route string?, location_sublocality string?, location_locality string?, location_admin_area_level_1 string?, location_admin_area_level_2 string?, location_country string?, location_postal_code string?, location_formatted_address string?, location_lat decimal?, location_long decimal?, org_name string?, person_name string?, deal_title string?, owner_name string?, person_dropbox_bcc string?, deal_dropbox_bcc string?, assigned_to_user_id int?, file record {} } }|record { item string?, id int?, data record { id int?, name string?, icon_key string?, color string?, order_nr int?, key_string string?, active_flag boolean?, is_custom_flag boolean?, add_time string?, update_time string? } }|record { item string?, id int?, data record { id int?, creator_user_id int?, user_id int?, person_id int?, org_id int?, stage_id int?, title string?, value decimal?, currency string?, add_time string?, update_time string?, stage_change_time string?, active boolean?, deleted boolean?, status string?, probability decimal?, next_activity_date string?, next_activity_time string?, next_activity_id int?, last_activity_id int?, last_activity_date string?, lost_reason string?, visible_to string?, close_time string?, pipeline_id int?, won_time string?, first_won_time string?, lost_time string?, products_count int?, files_count int?, notes_count int?, followers_count int?, email_messages_count int?, activities_count int?, done_activities_count int?, undone_activities_count int?, participants_count int?, expected_close_date string?, last_incoming_mail_time string?, last_outgoing_mail_time string?, label string?, stage_order_nr int?, person_name string?, org_name string?, next_activity_subject string?, next_activity_type string?, next_activity_duration string?, next_activity_note string?, formatted_value string?, weighted_value decimal?, formatted_weighted_value string?, weighted_value_currency string?, rotten_time string?, owner_name string?, cc_email string?, org_hidden boolean?, person_hidden boolean? } }|record { item string?, id int?, data record { id int?, user_id int?, deal_id int?, person_id int?, org_id int?, product_id int?, activity_id int?, add_time string?, update_time string?, file_name string?, file_size string?, active_flag boolean?, inline_flag boolean?, remote_location string?, remote_id string?, cid string?, s3_bucket string?, mail_message_id string?, mail_template_id string?, deal_name string?, person_name string?, org_name string?, product_name string?, url string?, name string?, description string? } }|record { item string?, id int?, data record { id int?, name string?, active_flag boolean?, 'type string?, user_id int?, add_time string?, update_time string?, visible_to int?, custom_view_id int? } }|record { item string?, id int?, data record { id int?, active_flag boolean?, add_time string?, content string?, deal record { title string? }, lead_id string?, deal_id int?, last_update_user_id int?, org_id int?, organization record { name string? }, person record { name string? }, person_id int?, pinned_to_deal_flag boolean?, pinned_to_organization_flag boolean?, pinned_to_person_flag boolean?, update_time string?, user record { email string?, icon_url string?, is_you boolean?, name string? }, user_id int? } }|record { item string?, id int?, data record { id int?, company_id int?, active_flag boolean?, phone record { value string?, primary boolean?, label string? }[]?, email record { value string?, primary boolean?, label string? }[]?, first_char string?, add_time string?, update_time string?, visible_to string?, picture_id record { id int?, item_type string?, item_id int?, active_flag boolean?, add_time string?, update_time string?, added_by_user_id int?, pictures record { '128 string?, '512 string? } }, label int?, org_name string?, owner_name string?, cc_email string?, owner_id int?, org_id int?, merge_what_id int?, name string?, first_name string?, last_name string?, email_messages_count int?, activities_count int?, done_activities_count int?, undone_activities_count int?, files_count int?, notes_count int?, followers_count int?, last_incoming_mail_time string?, last_outgoing_mail_time string?, open_deals_count int?, related_open_deals_count int?, closed_deals_count int?, related_closed_deals_count int?, won_deals_count int?, related_won_deals_count int?, lost_deals_count int?, related_lost_deals_count int?, next_activity_date string?, next_activity_time string?, next_activity_id int?, last_activity_id int?, last_activity_date string?, participant_open_deals_count int?, participant_closed_deals_count int? } }|record { item string?, id int?, data record { id int?, company_id int?, owner_id record { id int?, name string?, email string?, has_pic int?, pic_hash string?, active_flag boolean?, value int? }, name string?, active_flag boolean?, picture_id record { value int?, item_type string?, item_id int?, active_flag boolean?, add_time string?, update_time string?, added_by_user_id int?, pictures record { '128 string?, '512 string? } }, country_code string?, first_char string?, add_time string?, update_time string?, visible_to string?, label int?, owner_name string?, cc_email string?, email_messages_count int?, people_count int?, activities_count int?, done_activities_count int?, undone_activities_count int?, files_count int?, notes_count int?, followers_count int?, address string?, address_subpremise string?, address_street_number string?, address_route string?, address_sublocality string?, address_locality string?, address_admin_area_level_1 string?, address_admin_area_level_2 string?, address_country string?, address_postal_code string?, address_formatted_address string?, open_deals_count int?, related_open_deals_count int?, closed_deals_count int?, related_closed_deals_count int?, won_deals_count int?, related_won_deals_count int?, lost_deals_count int?, related_lost_deals_count int?, next_activity_date string?, next_activity_time string?, next_activity_id int?, last_activity_id int?, last_activity_date string? } }|record { item string?, id int?, data record { id int?, name string?, url_title string?, order_nr int?, active boolean?, deal_probability boolean?, add_time string?, update_time string? } }|record { item string?, id int?, data record { id int?, name string?, code string?, description string?, unit string?, tax decimal?, category string?, active_flag boolean?, selectable boolean?, first_char string?, visible_to int?, owner_id int?, files_count int?, followers_count int?, add_time string?, update_time string?, prices record {}[]? } }|record { item string?, id int?, data record { id int?, order_nr int?, name string?, active_flag boolean?, deal_probability int?, pipeline_id int?, rotten_flag int?, rotten_days int?, add_time string?, update_time string? } }|record { item string?, id int?, data record { id int?, name string?, default_currency string?, locale string?, lang int?, email string?, phone string?, activated boolean?, last_login string?, created string?, modified string?, signup_flow_variation string?, has_created_company boolean?, is_admin record {}, active_flag boolean?, timezone_name string?, timezone_offset string?, role_id int?, icon_url string?, is_you boolean? } }?)[]? -
- additional_data Getrecentsresponse200AdditionalData? -
pipedrive: Getrecentsresponse200AdditionalData
Fields
- since_timestamp string? - Timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
- last_timestamp_on_page string? - Timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
- pagination Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: GetRoleResponse200
Fields
- success boolean? - If the response is successful or not
- data SubRole? - The details of the sub-role
- additional_data Getroleresponse200AdditionalData? - The additional data in the Role
pipedrive: Getroleresponse200AdditionalData
The additional data in the Role
Fields
- settings Getroleresponse200AdditionalDataSettings? - The settings for the Role
pipedrive: Getroleresponse200AdditionalDataSettings
The settings for the Role
Fields
- deal_default_visibility decimal? - The default visibility level of the Deals for the Role
- lead_default_visibility decimal? - The default visibility level of the Leads for the Role
- org_default_visibility decimal? - The default visibility level of the Organizations for the Role
- person_default_visibility decimal? - The default visibility level of the People for the Role
- product_default_visibility decimal? - The default visibility level of the Products for the Role
- deal_access_level decimal? - The access level of the Deals for the Role (only for default Role)
- org_access_level decimal? - The access level of the Organizations for the Role (only for default Role)
- person_access_level decimal? - The access level of the People for the Role (only for default Role)
- product_access_level decimal? - The access level of the Products for the Role (only for default Role)
pipedrive: GetRoleSettingsResponse200
Fields
- success boolean? - If the response is successful or not
- data Getroleresponse200AdditionalDataSettings? - The settings for the Role
pipedrive: GetRolesResponse200
Fields
- success boolean? - If the response is successful or not
- data SubRole[]? - The array of Roles
- additional_data Getrolesresponse200AdditionalData? - The additional data in the Role list
pipedrive: Getrolesresponse200AdditionalData
The additional data in the Role list
Fields
- pagination Getrolesresponse200AdditionalDataPagination? - The pagination details in the Role list
pipedrive: Getrolesresponse200AdditionalDataPagination
The pagination details in the Role list
Fields
- 'start int? - Pagination start
- 'limit int? - Items shown per page
- more_items_in_collection boolean? - Whether there are more list items in the collection than displayed
pipedrive: GetRoleSubrolesResponse200
Fields
- success boolean? - If the response is successful or not
- data SubRole[]? - The array of sub-roles
- additional_data Getrolesresponse200AdditionalData? - The additional data in the Role list
pipedrive: GetStageDealsResponse200
Fields
- success boolean? - If the request was successful or not
- data DealStrict[]? - The array of Deals
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
pipedrive: GetStageResponse200
Fields
- success boolean? - If the request was successful or not
- data record { id int?, order_nr int?, name string?, active_flag boolean?, deal_probability int?, pipeline_id int?, rotten_flag int?, rotten_days int?, add_time string?, update_time string?, deals_summary record { per_stages record { STAGE_ID record { CURRENCY_ID record { count int?, value int?, value_formatted string?, weighted_value int?, weighted_value_formatted string? } } }, per_currency record { CURRENCY_ID int? }, total_count int?, per_currency_full record { CURRENCY_ID record { count int?, value int? } } } }? - The Stage object
pipedrive: GetStagesResponse200
Fields
- success boolean? - If the request was successful or not
- data Stages[]? - The array of Stages
pipedrive: GetUserCallLogsResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: GetUserPermissionsResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: Getuserpermissionsresponse200Data
Fields
- can_add_custom_fields boolean? - If the User can add custom fields
- can_add_products boolean? - If the User can add Products
- can_add_prospects_as_leads boolean? - If the User can add prospects as Leads
- can_bulk_edit_items boolean? - If the User can bulk edit items
- can_change_visibility_of_items boolean? - If the User can change visibility of items
- can_convert_deals_to_leads boolean? - If the User can convert Deals to Leads
- can_create_own_workflow boolean? - If the User can create workflows
- can_delete_activities boolean? - If the User can delete Activities
- can_delete_custom_fields boolean? - If the User can delete custom fields
- can_delete_deals boolean? - If the User can delete Deals
- can_edit_custom_fields boolean? - If the User can edit custom fields
- can_edit_deals_closed_date boolean? - If the User can edit Deals' closed date
- can_edit_products boolean? - If the User can edit Products
- can_edit_shared_filters boolean? - If the User can edit shared filters
- can_export_data_from_lists boolean? - If the User can export data from item lists
- can_follow_other_users boolean? - If the User can follow other Users
- can_merge_deals boolean? - If the User can merge Deals
- can_merge_organizations boolean? - If the User can merge Organizations
- can_merge_people boolean? - If the User can merge people
- can_modify_labels boolean? - If the User can modify labels
- can_see_company_wide_statistics boolean? - If the User can see company-wide statistics
- can_see_deals_list_summary boolean? - If the User can see the summary on the Deals page
- can_see_hidden_items_names boolean? - If the User can see the names of hidden items
- can_see_other_users boolean? - If the User can see other Users
- can_see_other_users_statistics boolean? - If the User can see other Users' statistics
- can_see_security_dashboard boolean? - If the User can see security dashboard
- can_share_filters boolean? - If the User can share filters
- can_share_insights boolean? - If the User can share insights
- can_use_api boolean? - If the User can use API
- can_use_email_tracking boolean? - If the User can use email tracking
- can_use_import boolean? - If the User can use import
pipedrive: GetUserRoleAssignmentsResponse200
Fields
- success boolean? - If the response is successful or not
- data RoleAssignment[]? - The Role assignments
- additional_data Getrolesresponse200AdditionalData? - The additional data in the Role list
pipedrive: GetUserSettingsResponse200
Fields
- success boolean? - If the response is successful or not
- data Getusersettingsresponse200Data? -
pipedrive: Getusersettingsresponse200Data
Fields
- marketplace_allow_custom_install_url boolean? - If the vendors are allowed to install custom Marketplace apps with functionality and content in the Pipedrive UI or not
- marketplace_app_extensions_vendor boolean? - If the vendors are allowed to extend their Marketplace apps with functionality and content in the Pipedrive UI or not
- marketplace_team boolean? - If the vendors are allowed to be part of the Marketplace team or not
- list_limit decimal? - Number of results shown in list by default
- beta_app boolean? - If beta app is enabled
- prevent_salesphone_callto_override boolean? - Prevent salesphone call to override
- file_upload_destination string? - The destination of File upload
- callto_link_syntax string? - The call to link syntax
- autofill_deal_expected_close_date boolean? - If the expected close date of the Deal is filled automatically or not
- person_duplicate_condition string? - Allow the vendors to duplicate a Person
pipedrive: GetWebhooksResponse200
Fields
- success boolean? - If the response is successful or not
- status string? - The status of the response
- data Getwebhooksresponse200Data[]? - The array of Webhooks
pipedrive: Getwebhooksresponse200Data
Fields
- id int? - The ID of the Webhook
- company_id int? - The ID of the Company related to the Webhook
- owner_id int? - The ID of the User who owns the Webhook
- user_id int? - The ID of the User related to the Webhook
- event_action string? - The Webhook action
- event_object string? - The Webhook object
- subscription_url string? - The subscription URL of the Webhook
- is_active record {}? - The Webhook's status
- add_time string? - The date when the Webhook was added
- remove_time string? - The date when the Webhook was removed (if removed)
- 'type string? - The type of the Webhook
- http_auth_user string? - The username of the
subscription_url
of the Webhook
- http_auth_password string? - The password of the
subscription_url
of the Webhook
- additional_data record {}? - Any additional data related to the Webhook
- remove_reason string? - The removal reason of the Webhook (if removed)
- last_delivery_time string? - The last delivery time of the Webhook
- last_http_status int? - The last delivery HTTP status of the Webhook
- admin_id int? - The ID of the admin of the Webhook
pipedrive: Goal
Fields
- id string? - ID of the goal
- owner_id string? - ID of the creator of the goal
- title string? - The title of the goal
- 'type GoalType? - Type of the goal
- assignee GoalAssignee? - Who is the goal assigned to
- interval string? - Interval of the goal
- duration GoalDuration? - Duration of the goal
- expected_outcome GoalExpectedOutcome? - Expected outcome of the goal
- is_active boolean? - If the goal is currently active or not
- report_ids int[]? - The IDs of the reports that belong to the goal
pipedrive: GoalAssignee
Who is the goal assigned to
Fields
- id record {}? - ID of the goal assignee
- 'type string? - Type of the assignee
pipedrive: GoalDuration
Duration of the goal
Fields
- 'start string? - Start date of the goal
- end string? - End date of the goal
pipedrive: GoalExpectedOutcome
Expected outcome of the goal
Fields
- target int? - Numeric target of the goal
- tracking_metric string? - Tracking metric of the goal
pipedrive: GoalType
Type of the goal
Fields
- name string? - Name of the goal type
- params GoalTypeParams? - Parameters that accompany the goal type
pipedrive: GoalTypeParams
Parameters that accompany the goal type
Fields
- pipeline_id string? - Pipeline ID of the goal
pipedrive: InlineResponse200
Fields
- success boolean? - If the response is successful or not
- data ResponseCallLogObject? -
pipedrive: InlineResponse403
Fields
- success boolean? - If the response is successful or not
- message string? - The error message
pipedrive: LeadIdResponse200
Fields
- success boolean? -
- data Leadidresponse200Data? -
pipedrive: Leadidresponse200Data
Fields
- id string? -
pipedrive: LeadResponse404
Fields
- success boolean? -
- _error string? - The description of the error
- error_info string? - A message describing how to solve the problem
- data record {}? -
- additional_data record {}? -
pipedrive: LeadsidValue
The potential value of the Lead.
Fields
- amount decimal - Amount
- currency string - Currency
pipedrive: LeadsValue
The potential value of the Lead.
Fields
- amount decimal - Amount
- currency string - Currency
pipedrive: LinkFileToItemRequest
Fields
- item_type string - The item type
- item_id int - ID of the item to associate the file with
- remote_id string - The remote item id
- remote_location string - The location type to send the file to. Only
googledrive
is supported at the moment.
pipedrive: LinkFileToItemResponse200
Fields
- success boolean? - If the request was successful or not
- data Getassociatedfilesresponse200Data? - The File data
pipedrive: ListPermittedUsersResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: Listpermittedusersresponse2001
Fields
- success boolean? - If the response is successful or not
- data decimal[]? - The list of permitted Users IDs
pipedrive: Listpermittedusersresponse200Data
Fields
- id int[]? - The list of permitted Users IDs
pipedrive: ListPersonsResponse200
Fields
- success boolean? - If the response is successful or not
- data PersonItem[]? - The array of Persons
- additional_data Fieldsresponse200AdditionalData? - The additional data of the list
- related_objects Listpersonsresponse200RelatedObjects? -
pipedrive: Listpersonsresponse200RelatedObjects
Fields
- organization Addactivityresponse200RelatedObjectsOrganization? -
pipedrive: ListProductsResponse200
Fields
- success boolean? - If the response is successful or not
- data Listproductsresponse200Data? -
- additional_data record {}? -
- related_objects Listproductsresponse200RelatedObjects? -
pipedrive: Listproductsresponse200Data
Fields
- items Product[]? - The array of Products
pipedrive: Listproductsresponse200RelatedObjects
Fields
pipedrive: MailMessageResponse200
Fields
- success boolean? - If the response is successful or not
- statusCode int? - The email service specific status code and it is returned through the response body.
- statusText string? - The status text of the response.
- 'service string? - The service name of the response.
- data Mailmessageresponse200Data? -
pipedrive: Mailmessageresponse200Data
Fields
- id int? - ID of the mail message.
- 'from Mailmessageresponse200DataFrom[]? - The array of mail message sender (object)
- to Mailmessageresponse200DataFrom[]? - The array of mail message receiver (object)
- cc Mailmessageresponse200DataFrom[]? - The array of mail message copies (object)
- bcc Mailmessageresponse200DataFrom[]? - The array of mail message blind copies (object)
- body_url string? - The mail message body URL
- account_id string? - The connection account ID
- user_id int? - ID of the user whom mail message will be assigned to
- mail_thread_id int? - ID of the mail message thread
- subject string? - The subject of mail message
- snippet string? - The snippet of mail message. Snippet length is up to 225 characters.
- mail_tracking_status string? - The status of tracking mail message. Value is
null
if tracking is not enabled.
- mail_link_tracking_enabled_flag record {}? - Whether the link tracking in mail message body is enabled.
- read_flag record {}? - Whether the mail message is read or not by the user
- draft string? - If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise
null
.
- draft_flag record {}? - Whether the mail message is a draft or not
- synced_flag record {}? - Whether the mail message is synced with the provider or not
- deleted_flag record {}? - Whether the mail message is deleted or not
- has_body_flag record {}? - Whether the mail message has a body or not
- sent_flag record {}? - Whether the mail message has been sent or not
- sent_from_pipedrive_flag record {}? - Whether the mail message has been sent from Pipedrive app or not
- smart_bcc_flag record {}? - Whether the mail message has been created by Smart Email BCC feature or not
- message_time string? - Creation or receival time of the mail message
- add_time string? - The insertion into the database time of the mail message
- update_time string? - The updating time in the database of the mail message
- has_attachments_flag record {}? - Whether the mail message has an attachment or not
- has_inline_attachments_flag record {}? - Whether the mail message has an inline attachment or not
- has_real_attachments_flag record {}? - Whether the mail message has an attachment (which is not inline) or not
- write_flag boolean? - We strongly advise you to avoid the use of this property. We will soon deprecate this property.
pipedrive: Mailmessageresponse200DataFrom
Fields
- id int? - ID of the mail participant
- email_address string? - Mail address of the mail participant
- name string? - Name of the mail participant
- linked_person_id int? - ID of the linked person to the mail message
- linked_person_name string? - Name of the linked person to the mail message
- mail_message_party_id int? - ID of the mail message participant
pipedrive: MailMessages
Fields
- Fields Included from *MailMessages1
- id int|()
- account_id string|()
- user_id int|()
- subject string|()
- snippet string|()
- read_flag record { anydata... }
- mail_tracking_status string|()
- has_attachments_flag record { anydata... }
- has_inline_attachments_flag record { anydata... }
- has_real_attachments_flag record { anydata... }
- deleted_flag record { anydata... }
- synced_flag record { anydata... }
- smart_bcc_flag record { anydata... }
- mail_link_tracking_enabled_flag record { anydata... }
- write_flag boolean|()
- anydata...
- Fields Included from *MailMessages2
- from Basemailthread2PartiesTo[]|()
- to Basemailthread2PartiesTo[]|()
- cc Basemailthread2PartiesTo[]|()
- bcc Basemailthread2PartiesTo[]|()
- body_url string|()
- mail_thread_id int|()
- draft string|()
- has_body_flag record { anydata... }
- sent_flag record { anydata... }
- sent_from_pipedrive_flag record { anydata... }
- message_time string|()
- add_time string|()
- update_time string|()
- anydata...
pipedrive: MailMessages1
Fields
- id int? - ID of the mail thread
- account_id string? - The connection account ID
- user_id int? - ID of the user whom mail message will be assigned to
- subject string? - The subject
- snippet string? - A snippet
- read_flag record {}? - Whether the mail thread is read
- mail_tracking_status string? - Mail tracking status
- has_attachments_flag record {}? - Whether the mail thread has an attachment
- has_inline_attachments_flag record {}? - Whether the mail thread has inline attachments
- has_real_attachments_flag record {}? - Whether the mail thread has real attachments (which are not inline)
- deleted_flag record {}? - Whether the mail thread is deleted
- synced_flag record {}? - Whether the mail thread is synced
- smart_bcc_flag record {}? - Whether one of the parties of the mail thread is Bcc
- mail_link_tracking_enabled_flag record {}? - Whether the link tracking of the mail thread is enabled
- write_flag boolean? - We strongly advise you to avoid the use of this property. We will soon deprecate this property
pipedrive: MailMessages2
Fields
- 'from Basemailthread2PartiesTo[]? - Senders of the mail thread
- to Basemailthread2PartiesTo[]? - Recipients of the mail thread
- cc Basemailthread2PartiesTo[]? - Participants of the Cc
- bcc Basemailthread2PartiesTo[]? - Participants of the Bcc
- body_url string? - A link to the mail thread message
- mail_thread_id int? - ID of the mail thread
- draft string? - If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise
null
.
- has_body_flag record {}? - Whether the mail thread message has a body
- sent_flag record {}? - Whether the mail thread message is sent
- sent_from_pipedrive_flag record {}? - Whether the mail thread message is sent from Pipedrive
- message_time string? - The time when the mail message was received or created
- add_time string? - The time when the mail message was inserted to database
- update_time string? - The time when the mail message was updated in database received
pipedrive: MergeDealsRequest
Fields
- merge_with_id int - ID of the deal that the deal will be merged with
pipedrive: MergeDealsResponse200
Fields
- success boolean? - If the response is successful or not
- data DealStrict? - The Deal object
pipedrive: MergeOrganizationsRequest
Fields
- merge_with_id int - The ID of the Organization that the Organization will be merged with
pipedrive: MergeOrganizationsResponse200
Fields
- success boolean? - If the request was successful or not
pipedrive: Mergeorganizationsresponse200Data
Fields
- id int? - The ID of the merged Organization
pipedrive: MergePersonsRequest
Fields
- merge_with_id int - The ID of the Person that will not be overwritten. This Person’s data will be prioritized in case of conflict with the other Person.
pipedrive: MergePersonsResponse200
Fields
- success boolean? - If the response is successful or not
- data record { id int?, company_id int?, active_flag boolean?, phone record { value string?, primary boolean?, label string? }[]?, email record { value string?, primary boolean?, label string? }[]?, first_char string?, add_time string?, update_time string?, visible_to string?, picture_id record { id int?, item_type string?, item_id int?, active_flag boolean?, add_time string?, update_time string?, added_by_user_id int?, pictures record { '128 string?, '512 string? } }, label int?, org_name string?, owner_name string?, cc_email string?, owner_id int?, org_id int?, merge_what_id int?, name string?, first_name string?, last_name string?, email_messages_count int?, activities_count int?, done_activities_count int?, undone_activities_count int?, files_count int?, notes_count int?, followers_count int?, last_incoming_mail_time string?, last_outgoing_mail_time string?, open_deals_count int?, related_open_deals_count int?, closed_deals_count int?, related_closed_deals_count int?, won_deals_count int?, related_won_deals_count int?, lost_deals_count int?, related_lost_deals_count int?, next_activity_date string?, next_activity_time string?, next_activity_id int?, last_activity_id int?, last_activity_date string?, participant_open_deals_count int?, participant_closed_deals_count int? }? -
pipedrive: NewFollowerResponse200
Fields
- success boolean? - If the response is successful or not
- data Newfollowerresponse200Data? -
pipedrive: Newfollowerresponse200Data
Fields
- user_id int? - The ID of the user that was added as Follower
- id int? - The ID of the Follower
- product_id int? - The ID of the Product
- add_time string? - The Follower creation time. Format: YYYY-MM-DD HH:MM:SS
pipedrive: NoteRequest
Fields
- content string - Content of the note in HTML format. Subject to sanitization on the back-end.
- user_id int? - ID of the user who will be marked as the author of this note. Only an admin can change the author.
- lead_id string? - The ID of the lead the note will be attached to
- deal_id int? - The ID of the deal the note will be attached to
- person_id int? - The ID of the person this note will be attached to
- org_id int? - The ID of the organization this note will be attached to
- add_time string? - Optional creation date & time of the Note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
- pinned_to_lead_flag record {}? - If set, then results are filtered by note to lead pinning state (
lead_id
is also required)
- pinned_to_deal_flag record {}? - If set, then results are filtered by note to deal pinning state (
deal_id
is also required).
- pinned_to_organization_flag record {}? - If set, then results are filtered by note to organization pinning state (
org_id
is also required).
- pinned_to_person_flag record {}? - If set, then results are filtered by note to person pinning state (
person_id
is also required).
pipedrive: Noterequest1
Fields
- content string - Content of the note in HTML format. Subject to sanitization on the back-end.
- user_id int? - ID of the user who will be marked as the author of this note. Only an admin can change the author.
- lead_id string? - The ID of the lead the note will be attached to
- deal_id int? - The ID of the deal the note will be attached to
- person_id int? - The ID of the person this note will be attached to
- org_id int? - The ID of the organization this note will be attached to
- add_time string? - Optional creation date & time of the Note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
- pinned_to_lead_flag record {}? - If set, then results are filtered by note to lead pinning state (
lead_id
is also required)
- pinned_to_deal_flag record {}? - If set, then results are filtered by note to deal pinning state (
deal_id
is also required).
- pinned_to_organization_flag record {}? - If set, then results are filtered by note to organization pinning state (
org_id
is also required).
- pinned_to_person_flag record {}? - If set, then results are filtered by note to person pinning state (
person_id
is also required).
pipedrive: OneCommentResponse200
Fields
- success boolean? - If the request was successful or not
- data Getcommentsresponse200Data? -
pipedrive: OneLeadResponse200
Fields
- success boolean? -
- data Getleadsresponse200Data? -
pipedrive: OneNoteResponse200
Fields
- success boolean? - If the request was successful or not
- data Getnotesresponse200Data? -
pipedrive: OrganizationCountAndAddressInfo
Fields
- Fields Included from *OrganizationCountAndAddressInfo1
- Fields Included from *OrganizationCountAndAddressInfo2
- address string|()
- address_subpremise string|()
- address_street_number string|()
- address_route string|()
- address_sublocality string|()
- address_locality string|()
- address_admin_area_level_1 string|()
- address_admin_area_level_2 string|()
- address_country string|()
- address_postal_code string|()
- address_formatted_address string|()
- anydata...
pipedrive: OrganizationCountAndAddressInfo1
Fields
- email_messages_count int? - The count of email messages related to the Organization
- people_count int? - The count of Persons related to the Organization
- activities_count int? - The count of Activities related to the Organization
- done_activities_count int? - The count of done Activities related to the Organization
- undone_activities_count int? - The count of undone Activities related to the Organization
- files_count int? - The count of files related to the Organization
- notes_count int? - The count of notes related to the Organization
- followers_count int? - The count of followers related to the Organization
pipedrive: OrganizationCountAndAddressInfo2
Fields
- address string? - The full address of the Organization
- address_subpremise string? - The sub-premise of the Organization location
- address_street_number string? - The street number of the Organization location
- address_route string? - The route of the Organization location
- address_sublocality string? - The sub-locality of the Organization location
- address_locality string? - The locality of the Organization location
- address_admin_area_level_1 string? - The level 1 admin area of the Organization location
- address_admin_area_level_2 string? - The level 2 admin area of the Organization location
- address_country string? - The country of the Organization location
- address_postal_code string? - The postal code of the Organization location
- address_formatted_address string? - The formatted Organization location
pipedrive: OrganizationFollower
Fields
- Fields Included from *OrganizationFollower1
- org_id int|()
- anydata...
- Fields Included from *OrganizationFollower2
pipedrive: OrganizationFollower1
Fields
- org_id int? - The ID of the Organization
pipedrive: OrganizationFollower2
Fields
- user_id int? - The user ID of the follower related to the item
- id int? - The ID of the follower
- add_time int? - The date and time of adding the follower to the item
pipedrive: OrganizationItem
Fields
- Fields Included from *BaseOrganizationItemWithEditNameFlag
- id int|()
- company_id int|()
- owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
- name string|()
- active_flag boolean|()
- picture_id record { id int|(), item_type string|(), item_id int|(), active_flag boolean|(), add_time string|(), update_time string|(), added_by_user_id int|(), pictures Pictures|(), anydata... }
- country_code string|()
- first_char string|()
- add_time string|()
- update_time string|()
- visible_to string|()
- label int|()
- owner_name string|()
- cc_email string|()
- email_messages_count int|()
- people_count int|()
- activities_count int|()
- done_activities_count int|()
- undone_activities_count int|()
- files_count int|()
- notes_count int|()
- followers_count int|()
- address string|()
- address_subpremise string|()
- address_street_number string|()
- address_route string|()
- address_sublocality string|()
- address_locality string|()
- address_admin_area_level_1 string|()
- address_admin_area_level_2 string|()
- address_country string|()
- address_postal_code string|()
- address_formatted_address string|()
- open_deals_count int|()
- related_open_deals_count int|()
- closed_deals_count int|()
- related_closed_deals_count int|()
- won_deals_count int|()
- related_won_deals_count int|()
- lost_deals_count int|()
- related_lost_deals_count int|()
- next_activity_date string|()
- next_activity_time string|()
- next_activity_id int|()
- last_activity_id int|()
- last_activity_date string|()
- edit_name boolean|()
- anydata...
- Fields Included from *OrganizationItem1
- last_activity record { anydata... }
- next_activity record { anydata... }
- anydata...
pipedrive: OrganizationItem1
Fields
- last_activity record {}? - Please refer to response schema of <a href="https://developers.pipedrive.com/docs/api/v1/Activities#getActivity">Activity</a>
- next_activity record {}? - Please refer to response schema of <a href="https://developers.pipedrive.com/docs/api/v1/Activities#getActivity">Activity</a>
pipedrive: OrganizationRelationshipDetails
Fields
- Fields Included from *OrganizationRelationshipWithCalculatedFields
- id int|()
- type string|()
- rel_owner_org_id record { name string|(), people_count int|(), owner_id int|(), address string|(), cc_email string|(), value int|(), anydata... }
- rel_linked_org_id record { name string|(), people_count int|(), owner_id int|(), address string|(), cc_email string|(), value int|(), anydata... }
- add_time string|()
- update_time string|()
- active_flag string|()
- calculated_type string|()
- calculated_related_org_id int|()
- anydata...
- Fields Included from *OrganizationRelationshipDetails1
- related_organization_name string|()
- anydata...
pipedrive: OrganizationRelationshipDetails1
Fields
- related_organization_name string? - The name of the linked Organization
pipedrive: OrganizationRelationshipRequest
Fields
- org_id int? - ID of the base organization for the returned calculated values
- 'type string? - The type of organization relationship
- rel_owner_org_id int? - The owner of this relationship. If type is
parent
, then the owner is the parent and the linked organization is the daughter.
- rel_linked_org_id int? - The linked organization in this relationship. If type is
parent
, then the linked organization is the daughter.
pipedrive: OrganizationRelationshipWithCalculatedFields
Fields
- Fields Included from *OrganizationRelationshipWithCalculatedFields1
- id int|()
- type string|()
- rel_owner_org_id record { name string|(), people_count int|(), owner_id int|(), address string|(), cc_email string|(), value int|(), anydata... }
- rel_linked_org_id record { name string|(), people_count int|(), owner_id int|(), address string|(), cc_email string|(), value int|(), anydata... }
- add_time string|()
- update_time string|()
- active_flag string|()
- anydata...
- Fields Included from *OrganizationRelationshipWithCalculatedFields2
pipedrive: OrganizationRelationshipWithCalculatedFields1
Fields
- id int? - The ID of the Organization Relationship
- 'type string? - The type of the Relationship
- rel_owner_org_id record {}? -
- rel_linked_org_id record {}? -
- add_time string? - The creation date and time of the Relationship
- update_time string? - The last updated date and time of the Relationship
- active_flag string? - If the Relationship is active or not
pipedrive: OrganizationRelationshipWithCalculatedFields2
Fields
- calculated_type string? - The calculated type of the Relationship with the linked Organization
- calculated_related_org_id int? - The ID of the linked Organization
pipedrive: Owner1
Fields
- id int? - The ID of the User
- name string? - The name of the User
- email string? - The email of the User
- has_pic int? - Whether the User has picture or not. 0 = No picture, 1 = Has picture.
- pic_hash string? - The User picture hash
- active_flag boolean? - If the User is activated or not
pipedrive: Owner2
Fields
- value int? - The ID of the owner
pipedrive: PaymentResponse200
Fields
- success boolean? - If the response is successful or not
- data Paymentresponse200Data? -
pipedrive: Paymentresponse200Data
Fields
- items Paymentresponse200DataItems[]? -
pipedrive: Paymentresponse200DataItems
Fields
- id int? - The ID of the Payment
- subscription_id int? - The ID of the Subscription this Payment is associated with
- deal_id int? - The ID of the Deal this Payment is associated with
- is_active boolean? - The Payment status
- amount float? - The Payment amount
- currency string? - The currency of the Payment
- change_amount float? - Difference between the amount of the current Payment and the previous Payment. The value can be either positive or negative.
- due_at string? - Date when Payment occurs
- revenue_movement_type string? - Represents the movement of revenue in comparison with the previous Payment. Possible values are:
New
- first Payment of the subscription.Recurring
- no movement.Expansion
- current Payment amount > previous Payment amount.Contraction
- current Payment amount < previous Payment amount.Churn
- last Payment of the subscription.
- payment_type string? - The type of the Payment. Possible values are:
Recurring
- payments occur over fixed intervals of time,Additional
- extra payment not the recurring payment of the recurring subscription,Installment
- payment of the installment subscription.
- description string? - The description of the Payment
- add_time string? - The creation time of the Payment
- update_time string? - The update time of the Payment
pipedrive: PersonCountAndEmailInfo
Fields
- Fields Included from *PersonCountAndEmailInfo1
- Fields Included from *PersonCountAndEmailInfo2
pipedrive: PersonCountAndEmailInfo1
Fields
- email_messages_count int? - The count of email messages related to the Person
- activities_count int? - The count of activities related to the Person
- done_activities_count int? - The count of done activities related to the Person
- undone_activities_count int? - The count of undone activities related to the Person
- files_count int? - The count of files related to the Person
- notes_count int? - The count of notes related to the Person
- followers_count int? - The count of followers related to the Person
pipedrive: PersonCountAndEmailInfo2
Fields
- last_incoming_mail_time string? - The date and time of the last incoming email associated with the Person
- last_outgoing_mail_time string? - The date and time of the last outgoing email associated with the Person
pipedrive: PersonCountEmailDealAndActivityInfo
Fields
- Fields Included from *PersonCountAndEmailInfo
- Fields Included from *DealCountAndActivityInfo
- open_deals_count int|()
- related_open_deals_count int|()
- closed_deals_count int|()
- related_closed_deals_count int|()
- won_deals_count int|()
- related_won_deals_count int|()
- lost_deals_count int|()
- related_lost_deals_count int|()
- next_activity_date string|()
- next_activity_time string|()
- next_activity_id int|()
- last_activity_id int|()
- last_activity_date string|()
- anydata...
pipedrive: PersonItem
The object of Participant
Fields
- Fields Included from *PersonItem1
- Fields Included from *AdditionalPersonInfo
- owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
- org_id record { name string|(), people_count int|(), owner_id int|(), address string|(), cc_email string|(), value int|(), active_flag boolean|(), anydata... }
- name string|()
- first_name string|()
- last_name string|()
- email_messages_count int|()
- activities_count int|()
- done_activities_count int|()
- undone_activities_count int|()
- files_count int|()
- notes_count int|()
- followers_count int|()
- last_incoming_mail_time string|()
- last_outgoing_mail_time string|()
- open_deals_count int|()
- related_open_deals_count int|()
- closed_deals_count int|()
- related_closed_deals_count int|()
- won_deals_count int|()
- related_won_deals_count int|()
- lost_deals_count int|()
- related_lost_deals_count int|()
- next_activity_date string|()
- next_activity_time string|()
- next_activity_id int|()
- last_activity_id int|()
- last_activity_date string|()
- anydata...
pipedrive: PersonItem1
Fields
- id int? - The ID of the Person
- company_id int? - The ID of the Company related to the Person
- active_flag boolean? - If the Person is activated or not
- phone Phone[]? - List of phone data related to the Person
- email Email[]? - List of email data related to the Person
- first_char string? - The first letter of the name of the Person
- add_time string? - The date and time when the Person was added/created. Format: YYYY-MM-DD HH:MM:SS
- update_time string? - The last updated date and time of the Person. Format: YYYY-MM-DD HH:MM:SS
- visible_to string? - The visibility group ID of who can see the Person
- picture_id PictureId? - Picture ID
- label int? - The label assigned to the Person
- org_name string? - The name of the Organization associated with the Person
- owner_name string? - The name of the owner associated with the Person
- cc_email string? - The CC email associated with the Person
pipedrive: PersonNameInfoWithOrgAndOwnerId
Fields
- Fields Included from *PersonNameInfoWithOrgAndOwnerId1
- owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
- org_id record { name string|(), people_count int|(), owner_id int|(), address string|(), cc_email string|(), value int|(), active_flag boolean|(), anydata... }
- anydata...
- Fields Included from *PersonNameInfoWithOrgAndOwnerId2
pipedrive: PersonNameInfoWithOrgAndOwnerId1
Fields
- owner_id record {}? -
- org_id record {}? -
pipedrive: PersonNameInfoWithOrgAndOwnerId2
Fields
- name string? - The name of the Person
- first_name string? - The first name of the Person
- last_name string? - The last name of the Person
pipedrive: Phone
Fields
- value string? - Phone number
- primary boolean? - Boolean that indicates if phone number is primary for the Person or not
- label string? - Label that indicates the type of the phone number. (Possible values - work, home, mobile or other)
pipedrive: PictureId
Picture ID
Fields
- Fields Included from *PictureId1
- id int|()
- anydata...
- Fields Included from *PictureId2
pipedrive: PictureId1
Fields
- id int? - The ID of the picture associated with the item
pipedrive: PictureId2
Fields
- item_type string? - The type of item the picture is related to
- item_id int? - The ID of related item
- active_flag boolean? - If the associated picture is activated or not
- add_time string? - The add time of the picture
- update_time string? - The update time of the picture
- added_by_user_id int? - The ID of the User who added the picture
- pictures Pictures? -
pipedrive: Pictures
Fields
- '128 string? - The URL of the 128*128 picture
- '512 string? - The URL of the 512*512 picture
pipedrive: Pipeline1
Fields
- id int? - The ID of the Pipeline
- name string? - The name of the Pipeline
- url_title string? - The Pipeline title displayed in the URL
- order_nr int? - Defines the order of Pipelines. First order (
order_nr=0
) is the default Pipeline.
- active boolean? - Whether this Pipeline will be made inactive (hidden) or active
- deal_probability boolean? - Whether Deal probability is disabled or enabled for this Pipeline
- add_time string? - The Pipeline creation time. Format: YYYY-MM-DD HH:MM:SS.
- update_time string? - The Pipeline update time. Format: YYYY-MM-DD HH:MM:SS.
pipedrive: Pipeline2
Fields
- selected boolean? - A boolean that shows if the Pipeline is selected from a filter or not
pipedrive: PipelineRequest
Fields
- name string - The name of the Pipeline
- deal_probability record {}? - Whether Deal probability is disabled or enabled for this Pipeline
- order_nr int? - Defines the order of Pipelines. First order (
order_nr=0
) is the default Pipeline.
- active record {}? - Whether this Pipeline will be made inactive (hidden) or active
pipedrive: Pipelinerequest1
Fields
- name string? - The name of the Pipeline
- deal_probability record {}? - Whether Deal probability is disabled or enabled for this Pipeline
- order_nr int? - Defines the order of Pipelines. First order (
order_nr=0
) is the default Pipeline.
- active record {}? - Whether this Pipeline will be made inactive (hidden) or active
pipedrive: PostFilterResponse200
Fields
- success boolean? - If the response is successful or not
- data Postfilterresponse200Data? -
pipedrive: Postfilterresponse200Data
Fields
- id int? - The ID of the created filter
- name string? - The name of the created filter
- active_flag boolean? - The activity flag of the created filter
- 'type string? -
- temporary_flag boolean? - If the created filter is temporary or not
- user_id int? - The User ID of the created filter
- add_time string? - The add time of the created filter
- update_time string? - The update time of the created filter
- visible_to int? - The visibility group ID of the created filter
- custom_view_id int? - The custom view ID of the created filter
- conditions record {}? - The created filter conditions object
pipedrive: Product
Fields
- id int? - The ID of the deal-product (the ID of the Product attached to the Deal)
- deal_id int? - The ID of the Deal
- order_nr int? - Order number of the Product
- product_id int? - The ID of the Product
- product_variation_id int? - The ID of the Product variation
- item_price int? - Price value of the Product
- discount_percentage int? - Discount percentage of the Product
- duration int? - Duration of the Product
- duration_unit string? - The type of the duration. (For example hourly, daily, etc.)
- sum_no_discount decimal? - The Product sum without the discount
- sum decimal? - The sum of all the Products attached to the Deal
- currency string? - The currency associated with the Deal Product
- enabled_flag boolean? - If Product is enabled or not
- add_time string? - The date and time when the Product was added to the Deal
- last_edit string? - The date and time when the Deal Product was last edited
- comments string? - Comments of the Product
- active_flag boolean? - Boolean indicates if the Product is activated or not
- tax decimal? - The Product tax
- name string? - The Product name
- sum_formatted string? - Formatted sum of the Product
- quantity_formatted string? - Formatted quantity of the Product
- quantity int? - Quantity of the Product
- product ProductProduct? -
pipedrive: ProductField
Fields
- Fields Included from *ProductField1
- Fields Included from *ProductField2
- id int|()
- key string|()
- order_nr int|()
- add_time string|()
- update_time string|()
- last_updated_by_user_id int|()
- active_flag boolean|()
- edit_flag boolean|()
- add_visible_flag boolean|()
- important_flag boolean|()
- bulk_edit_allowed boolean|()
- searchable_flag boolean|()
- filtering_allowed boolean|()
- sortable_flag boolean|()
- mandatory_flag boolean|()
- anydata...
pipedrive: ProductField1
Fields
- name string - Name of the field
- options record {}[]? - When
field_type
is eitherset
orenum
, possible options must be supplied as a JSON-encoded sequential array, for example:</br>[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}]
- field_type string - 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 product 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 (autocompleted by Google Maps)</dd></table>
pipedrive: ProductField2
Fields
- id int? - The ID of the Product Field
- 'key string? - The key of the Product Field
- order_nr int? - Position (index) of the Product Field in the detail view
- add_time string? - The Product Field creation time. Format: YYYY-MM-DD HH:MM:SS
- update_time string? - The Product Field last update time. Format: YYYY-MM-DD HH:MM:SS
- last_updated_by_user_id int? - The ID of the last user to update the Product Field
- active_flag boolean? - Whether or not the Product Field is currently active
- edit_flag boolean? - Whether or not the Product Field Name and metadata is editable
- add_visible_flag boolean? - Whether or not the Product Field is visible in the Add Product Modal
- important_flag boolean? - Whether or not the Product Field is marked as important
- bulk_edit_allowed boolean? - Whether or not the Product Field data can be edited
- searchable_flag boolean? - Whether or not the Product Field is searchable
- filtering_allowed boolean? - Whether or not the Product Field value can be used when filtering searches
- sortable_flag boolean? - Whether or not the Product Field is sortable
- mandatory_flag boolean? - Whether or not the Product Field is mandatory when creating products
pipedrive: ProductFieldData
Fields
- Fields Included from *ProductField1
- Fields Included from *ProductField2
- id int|()
- key string|()
- order_nr int|()
- add_time string|()
- update_time string|()
- last_updated_by_user_id int|()
- active_flag boolean|()
- edit_flag boolean|()
- add_visible_flag boolean|()
- important_flag boolean|()
- bulk_edit_allowed boolean|()
- searchable_flag boolean|()
- filtering_allowed boolean|()
- sortable_flag boolean|()
- mandatory_flag boolean|()
- anydata...
pipedrive: ProductfieldsBody
Fields
- name string - Name of the field
- options record {}[]? - When
field_type
is eitherset
orenum
, possible options must be supplied as a JSON-encoded sequential array, for example:</br>[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}]
- field_type string - 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 product 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 (autocompleted by Google Maps)</dd></table>
pipedrive: ProductProduct
Fields
- id decimal? - The ID of the product
- name string? - The name of the product
- code string? - Product code
- unit string? - The unit in which this product is sold
- tax decimal? - Tax percentage
- active_flag decimal? - Whether this product is active or not
- selectable decimal? - Whether this product is selected in Deals or not
- visible_to record {}? - Visibility of the product
- owner_id record {}? - Information about the Pipedrive User who owns the product
- prices record {}? - Object of objects, each containing: currency (string), price (number), cost (number, optional), overhead_cost (number, optional)
pipedrive: ProductRequest
Fields
- name string? - Name of the product.
- code string? - Product code.
- unit string? - Unit in which this product is sold
- tax decimal? - Tax percentage
- active_flag decimal? - Whether this product will be made active or not.
- selectable decimal? - Whether this product can be selected in Deals or not.
- visible_to record {}? - Visibility of the product. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
- owner_id int? - ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used.
- prices record {}[]? - Array of objects, each containing:
currency
(string),price
(number),cost
(number, optional),overhead_cost
(number, optional). Note that there can only be one price per product per currency. Whenprices
is omitted altogether, no prices will be set up for the product
pipedrive: RelationshipOrganizationInfoItem1
Fields
- name string? - The name of the Organization associated with the item
- people_count int? - The number of people connected with the Organization that is associated with the item
- owner_id int? - The ID of the owner of the Organization that is associated with the item
- address string? - The address of the Organization
- cc_email string? - The CC email of the Organization associated with the item
pipedrive: RelationshipOrganizationInfoItem2
Fields
- value int? - The ID of the Organization
pipedrive: RelationshipOrganizationInfoItemWithActiveFlag1
Fields
- Fields Included from *RelationshipOrganizationInfoItem1
- Fields Included from *RelationshipOrganizationInfoItem2
- value int|()
- anydata...
pipedrive: RelationshipOrganizationInfoItemWithActiveFlag2
Fields
- active_flag boolean? - If the associated Organization is active or not
pipedrive: ResponseCallLogObject
Fields
- Fields Included from *AddCallLogRequest
- Fields Included from *ResponseCallLogObject1
pipedrive: ResponseCallLogObject1
Fields
- id string? - The call log ID, generated when the call log was created
- has_recording boolean? - If the call log has an audio recording attached, the value should be true
- company_id int? - The Company ID of the owner of the call log
pipedrive: RoleAssignment
The assignment data of the Role
Fields
- Fields Included from *BaseRoleRequest
- Fields Included from *RoleAssignment1
pipedrive: RoleAssignment1
Fields
- user_id int? - The User ID
- role_id int? - The Role ID
- active_flag boolean? - Whether the Role is active or not
- 'type string? - The assignment type
pipedrive: SearchDealsResponse200
Fields
- success boolean? - If the response is successful or not
- data Searchdealsresponse200Data? -
- additional_data Getactivitiesresponse200AdditionalData? -
pipedrive: Searchdealsresponse200Data
Fields
- items Searchdealsresponse200DataItems[]? - The array of Deals
pipedrive: Searchdealsresponse200DataItem
Fields
- id int? - The ID of the Deal
- 'type string? - The type of the Item
- title string? - The title of the Deal
- value int? - The value of the Deal
- currency int? - The currency of the Deal
- status string? - The status of the Deal
- visible_to int? - The visibility of the Deal
- owner Searchdealsresponse200DataItemOwner? -
- stage Searchdealsresponse200DataItemStage? -
- person Searchdealsresponse200DataItemPerson? -
- organization Searchdealsresponse200DataItemOrganization? -
- custom_fields int? - Custom fields
- notes string[]? - An array of Notes
pipedrive: Searchdealsresponse200DataItemOrganization
Fields
- id int? - The ID of the Organization the Deal is associated with
- name string? - The name of the Organization the Deal is associated with
pipedrive: Searchdealsresponse200DataItemOwner
Fields
- id int? - The ID of the owner of the Deal
pipedrive: Searchdealsresponse200DataItemPerson
Fields
- id int? - The ID of the Person the Deal is associated with
- name string? - The name of the Person the Deal is associated with
pipedrive: Searchdealsresponse200DataItems
Fields
- result_score decimal? - Search result relevancy
- item Searchdealsresponse200DataItem? -
pipedrive: Searchdealsresponse200DataItemStage
Fields
- id int? - The ID of the stage of the Deal
- name string? - The name of the stage of the Deal
pipedrive: SearchItemByFieldResponse200
Fields
- success boolean? - If the response is successful or not
- data Searchitembyfieldresponse200Data[]? - The array of results
- additional_data Getactivitiesresponse200AdditionalData? -
pipedrive: Searchitembyfieldresponse200Data
Fields
- id int? - The ID of the item
- '\$field\_key anydata? - The value of the searched
field_key
pipedrive: SearchItemResponse200
Fields
- success boolean? - If the response is successful or not
- data Searchitemresponse200Data? -
- additional_data Getactivitiesresponse200AdditionalData? -
pipedrive: Searchitemresponse200Data
Fields
- items Searchitemresponse200DataItems[]? - The array of found items
- related_items Searchitemresponse200DataItems[]? - The array of related items if
search_for_related_items
was enabled
pipedrive: Searchitemresponse200DataItems
Fields
- result_score decimal? - Search result relevancy
- item record {}? - Item
pipedrive: SearchOrganizationResponse200
Fields
- success boolean? - If the response is successful or not
- additional_data Getactivitiesresponse200AdditionalData? -
pipedrive: Searchorganizationresponse200Data
Fields
- items Searchorganizationresponse200DataItems[]? - The array of found items
pipedrive: Searchorganizationresponse200DataItem
Fields
- id int? - The ID of the Organization
- 'type string? - The type of the item
- name string? - The name of the Organization
- address string? - The address of the Organization
- visible_to int? - The visibility of the Organization
- owner Searchdealsresponse200DataItemOwner? -
- custom_fields int? - Custom fields
- notes string[]? - An array of Notes
pipedrive: Searchorganizationresponse200DataItems
Fields
- result_score decimal? - Search result relevancy
pipedrive: SearchPersonsResponse200
Fields
- success boolean? - If the response is successful or not
- data Searchpersonsresponse200Data? -
- additional_data Getactivitiesresponse200AdditionalData? -
pipedrive: Searchpersonsresponse200Data
Fields
- items Searchpersonsresponse200DataItems[]? - The array of found items
pipedrive: Searchpersonsresponse200DataItem
Fields
- id int? - The ID of the Person
- 'type string? - The type of the item
- name string? - The name of the Person
- phones string[]? - An array of phone numbers
- emails string[]? - An array of email addresses
- visible_to int? - The visibility of the Person
- organization Searchpersonsresponse200DataItemOrganization? -
- custom_fields int? - Custom fields
- notes string[]? - An array of Notes
pipedrive: Searchpersonsresponse200DataItemOrganization
Fields
- id int? - The ID of the Organization the Person is associated with
- name string? - The name of the Organization the Person is associated with
pipedrive: Searchpersonsresponse200DataItemOwner
Fields
- id int? - The ID of the owner of the Person
pipedrive: Searchpersonsresponse200DataItems
Fields
- result_score decimal? - Search result relevancy
- item Searchpersonsresponse200DataItem? -
pipedrive: SearchProductsResponse200
Fields
- success boolean? - If the response is successful or not
- data Searchproductsresponse200Data? -
- additional_data Getactivitiesresponse200AdditionalData? -
pipedrive: Searchproductsresponse200Data
Fields
- items Searchproductsresponse200DataItems[]? - The array of found items
pipedrive: Searchproductsresponse200DataItem
Fields
- id int? - The ID of the Product
- 'type string? - The type of the item
- name string? - The name of the Product
- code int? - The code of the Product
- visible_to int? - The visibility of the Product
- custom_fields int? - Custom fields
pipedrive: Searchproductsresponse200DataItemOwner
Fields
- id int? - The ID of the owner of the Product
pipedrive: Searchproductsresponse200DataItems
Fields
- result_score decimal? - Search result relevancy
pipedrive: SinglePermissionSetResponse200
Fields
- id int? - The ID of User Permission Set
- name string? - The name of Permission Set
- assignment_count int? - The number of Users assigned to this Permission Set
- contents string[]? - A permission assigned to this Permission Set
pipedrive: StageResponse200
Fields
- success boolean? - If the request was successful or not
- data Stageresponse200Data? - Updated Stage object
pipedrive: Stageresponse200Data
Updated Stage object
Fields
- id int? - The ID of the Stage
- order_nr int? - Defines the order of the Stage
- name string? - The name of the Stage
- active_flag boolean? - If the Stage is active or deleted
- deal_probability int? - The Deal success probability percentage. Used/shown when the Deal weighted values are used.
- pipeline_id int? - The ID of the Pipeline to add the Stage to
- rotten_flag int? - Whether Deals in this Stage can become rotten
- rotten_days int? - The number of days the Deals are not updated in this Stage would become rotten. Applies only if the
rotten_flag
is set.
- add_time string? - The Stage creation time. Format: YYYY-MM-DD HH:MM:SS.
- update_time string? - The Stage update time. Format: YYYY-MM-DD HH:MM:SS.
pipedrive: Stages
Fields
- Fields Included from *Stages1
- Fields Included from *Stages2
pipedrive: Stages1
Fields
- id int? - The ID of the Stage
- order_nr int? - Defines the order of the Stage
- name string? - The name of the Stage
- active_flag boolean? - If the Stage is active or deleted
- deal_probability int? - The Deal success probability percentage. Used/shown when the Deal weighted values are used.
- pipeline_id int? - The ID of the Pipeline to add the Stage to
- rotten_flag int? - Whether Deals in this Stage can become rotten
- rotten_days int? - The number of days the Deals are not updated in this Stage would become rotten. Applies only if the
rotten_flag
is set.
- add_time string? - The Stage creation time. Format: YYYY-MM-DD HH:MM:SS.
- update_time string? - The Stage update time. Format: YYYY-MM-DD HH:MM:SS.
pipedrive: Stages2
Fields
- pipeline_name string? - The name of the Pipeline
- pipeline_deal_probability boolean? - Pipeline Deal probability. When
true
, overrides the Stage probability.
pipedrive: SubRole
The details of the sub-role
Fields
- Fields Included from *BaseRoleRequest
- Fields Included from *SubRole1
pipedrive: SubRole1
Fields
- id int? - The ID of the Role
- active_flag boolean? - If the Role is active or not
- assignment_count string? - The number of Users assigned to this Role
- sub_role_count string? - The number of sub-roles
pipedrive: SubscriptionsIdResponse200
Fields
- success boolean? - If the response is successful or not
- data Subscriptionsidresponse200Data? -
pipedrive: Subscriptionsidresponse200Data
Fields
- id int? - The ID of the Subscription
- user_id int? - The ID of the User who created Subscription
- deal_id int? - The ID of the Deal this Subscription associated with
- description string? - Description of the recurring Subscription
- is_active boolean? - The Subscription status
- cycles_count int? - Shows how many payments a Recurring Subscription has
- cycle_amount int? - Amount of each payment
- infinite boolean? - Indicates that the Recurring Subscription will last until it's manually canceled or deleted
- currency string? - The currency of the Subscription
- cadence_type string? - Interval between payments
- start_date string? - The start date of the Recurring Subscription
- end_date string? - The end date of the Subscription
- lifetime_value float? - The total value of all payments
- final_status string? - The final status of the Subscription
- add_time string? - The creation time of the Subscription
- update_time string? - The update time of the Subscription
pipedrive: TeamResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: TeamsResponse200
Fields
- success boolean? - If the response is successful or not
- data BaseTeam[]? -
pipedrive: UnathorizedResponse
Fields
- success boolean? - If the response is successful or not
- _error string? - The error message
- errorCode int? - The response error code
pipedrive: UpdateActivityRequest
Fields
- due_date string? - Due date of the Activity. Format: YYYY-MM-DD
- due_time string? - Due time of the Activity in UTC. Format: HH:MM
- duration string? - Duration of the Activity. Format: HH:MM
- deal_id int? - The ID of the Deal this Activity is associated with
- person_id int? - The ID of the Person this Activity is associated with
- org_id int? - The ID of the Organization this Activity is associated with
- note string? - Note of the Activity (HTML format)
- location string? - The address of the Activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.
- public_description string? - Additional details about the Activity that is synced to your external calendar. Unlike the note added to the Activity, the description is publicly visible to any guests added to the Activity.
- subject string? - Subject of the Activity
- 'type string? - Type of the Activity. This is in correlation with the
key_string
parameter of ActivityTypes.
- user_id int? - The ID of the User whom the Activity is assigned to
- participants record {}[]? - List of multiple Persons (participants) this Activity is associated with. It requires a structure as follows:
[{"person_id":1,"primary_flag":true}]
- busy_flag boolean? - Set the Activity as 'Busy' or 'Free'. If the flag is set to
true
, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it withnull
. When the value of the flag is unset (null
), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time.
- attendees record {}[]? - Attendees of the Activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows:
[{"email_address":"mail@example.org"}]
or[{"person_id":1, "email_address":"mail@example.org"}]
- done record {}? - Whether the Activity is done or not. 0 = Not done, 1 = Done
pipedrive: UpdateActivityResponse200
Fields
- success boolean? -
- data ActivityResponseObjectData? -
- related_objects Addactivityresponse200RelatedObjects? -
pipedrive: UpdateActivityTypeRequest
Fields
- name string? - The name of the ActivityType
- icon_key string? - Icon graphic to use for representing this activity type.
- color string? - A designated color for the ActivityType in 6-character HEX format (e.g.
FFFFFF
for white,000000
for black)
- order_nr int? - An order number for this ActivityType. Order numbers should be used to order the types in the ActivityType selections.
pipedrive: UpdateFieldRequest
Fields
- name string? - Name of the field
- options string? - When
field_type
is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example:[{"id":123,"label":"Existing Item"},{"label":"New Item"}]
- add_visible_flag boolean? - Whether the field is available in 'add new' modal or not (both in web and mobile app)
pipedrive: Updatefieldrequest1
Fields
- name string? - Name of the field
- options string? - When
field_type
is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example:[{"id":123,"label":"Existing Item"},{"label":"New Item"}]
- add_visible_flag boolean? - Whether the field is available in 'add new' modal or not (both in web and mobile app)
pipedrive: Updatefieldrequest2
Fields
- name string? - Name of the field
- options string? - When
field_type
is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example:[{"id":123,"label":"Existing Item"},{"label":"New Item"}]
- add_visible_flag boolean? - Whether the field is available in 'add new' modal or not (both in web and mobile app)
pipedrive: UpdateFileRequest
Fields
- name string? - Visible name of the file
- description string? - Description of the file
pipedrive: UpdateFileResponse200
Fields
- success boolean? - If the request was successful or not
- data Getassociatedfilesresponse200Data? - The File data
pipedrive: UpdateFilterRequest
Fields
- name string? - The name of the filter
- conditions record {} - The conditions of the filter as a JSON object. It requires a minimum structure as follows: {"glue":"and","conditions":[{"glue":"and","conditions": [CONDITION_OBJECTS]},{"glue":"or","conditions":[CONDITION_OBJECTS]}]}. Replace CONDITION_OBJECTS with JSON objects of the following structure: {"object":"","field_id":"", "operator":"","value":"", "extra_value":""} or leave the array empty. Depending on the object type you should use another API endpoint to get field_id. There are five types of objects you can choose from: "person", "deal", "organization", "product", "activity" and you can use these types of operators depending on what type of a field you have: "IS NOT NULL", "IS NULL", "<=", ">=", "<", ">", "!=", "=", "LIKE '%$%'", "NOT LIKE '%$%'", "LIKE '$%'", "NOT LIKE '$%'", "LIKE '%$'", "NOT LIKE '%$'". To get a better understanding of how filters work try creating them directly from the Pipedrive application.
pipedrive: UpdateLeadLabelRequest
Fields
- name string? - The name of the Lead Label
- color string? - The color of the label. Only a subset of colors can be used.
pipedrive: UpdateLeadRequest
Fields
- title string? - The name of the Lead
- owner_id int? - The ID of the User which will be the owner of the created Lead. If not provided, the user making the request will be used.
- label_ids string[]? - The IDs of the Lead Labels which will be associated with the Lead
- person_id int? - The ID of a Person which this Lead will be linked to. If the Person does not exist yet, it needs to be created first. A Lead always has to be linked to a Person or Organization or both.
- organization_id int? - The ID of an Organization which this Lead will be linked to. If the Organization does not exist yet, it needs to be created first. A Lead always has to be linked to a Person or Organization or both.
- is_archived boolean? - A flag indicating whether the Lead is archived or not
- value LeadsidValue? - The potential value of the Lead.
- expected_close_date string? - The date of when the Deal which will be created from the Lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.
- visible_to record {}? - Visibility of the lead. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>
1
</td><td>Owner & followers (private)</td></tr><tr><td>3
</td><td>Entire company (shared)</td></tr></table>
- was_seen boolean? - A flag indicating whether the Lead was seen by someone in the Pipedrive UI
pipedrive: UpdateMailThreadDetailsRequest
Fields
- deal_id int? - The ID of the deal this thread is associated with
- lead_id string? - The ID of the lead this thread is associated with
- shared_flag record {}? - Whether this thread is shared with other users in your company
- read_flag record {}? - Whether this thread read or unread
- archived_flag record {}? - Whether this thread is archived or not. You can only archive threads that belong to Inbox folder. Archived threads will disappear from Inbox.
pipedrive: UpdateMailThreadDetailsResponse200
Fields
- success boolean? - If the response is successful or not
- data BaseMailThread? - The mail thread object
pipedrive: UpdateOrganizationRelationshipResponse200
Fields
- success boolean? - If the response is successful or not
- related_objects Getorganizationrelationshipsresponse200RelatedObjects? -
pipedrive: UpdateOrganizationResponse200
Fields
- success boolean? - If the response is successful or not
- data record { id int?, company_id int?, owner_id record { id int?, name string?, email string?, has_pic int?, pic_hash string?, active_flag boolean?, value int? }, name string?, active_flag boolean?, picture_id record { value int?, item_type string?, item_id int?, active_flag boolean?, add_time string?, update_time string?, added_by_user_id int?, pictures record { '128 string?, '512 string? } }, country_code string?, first_char string?, add_time string?, update_time string?, visible_to string?, label int?, owner_name string?, cc_email string?, email_messages_count int?, people_count int?, activities_count int?, done_activities_count int?, undone_activities_count int?, files_count int?, notes_count int?, followers_count int?, address string?, address_subpremise string?, address_street_number string?, address_route string?, address_sublocality string?, address_locality string?, address_admin_area_level_1 string?, address_admin_area_level_2 string?, address_country string?, address_postal_code string?, address_formatted_address string?, open_deals_count int?, related_open_deals_count int?, closed_deals_count int?, related_closed_deals_count int?, won_deals_count int?, related_won_deals_count int?, lost_deals_count int?, related_lost_deals_count int?, next_activity_date string?, next_activity_time string?, next_activity_id int?, last_activity_id int?, last_activity_date string? }? -
- related_objects Getorganizationsresponse200RelatedObjects? -
pipedrive: UpdatePersonResponse200
Fields
- success boolean? - If the response is successful or not
- data record { id int?, company_id int?, active_flag boolean?, phone record { value string?, primary boolean?, label string? }[]?, email record { value string?, primary boolean?, label string? }[]?, first_char string?, add_time string?, update_time string?, visible_to string?, picture_id record { id int?, item_type string?, item_id int?, active_flag boolean?, add_time string?, update_time string?, added_by_user_id int?, pictures record { '128 string?, '512 string? } }, label int?, org_name string?, owner_name string?, cc_email string?, owner_id record { id int?, name string?, email string?, has_pic int?, pic_hash string?, active_flag boolean?, value int? }, org_id record { name string?, people_count int?, owner_id int?, address string?, cc_email string?, value int?, active_flag boolean? }, name string?, first_name string?, last_name string?, email_messages_count int?, activities_count int?, done_activities_count int?, undone_activities_count int?, files_count int?, notes_count int?, followers_count int?, last_incoming_mail_time string?, last_outgoing_mail_time string?, open_deals_count int?, related_open_deals_count int?, closed_deals_count int?, related_closed_deals_count int?, won_deals_count int?, related_won_deals_count int?, lost_deals_count int?, related_lost_deals_count int?, next_activity_date string?, next_activity_time string?, next_activity_id int?, last_activity_id int?, last_activity_date string? }? -
- related_objects Listproductsresponse200RelatedObjects? -
pipedrive: UpdatePipelineResponse200
Fields
- success boolean? - If the response is successful or not
pipedrive: UpdateProductResponse200
Fields
- success boolean? - If the response is successful or not
- data Product? -
- related_objects Getactivitiesresponse200RelatedObjects? -
pipedrive: UpdateRecurringSubscriptionRequest
Fields
- description string? - Description of the Recurring Subscription
- cycle_amount int? - Amount of each payment
- payments record {}[]? - Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
- update_deal_value boolean? - Indicates that the Deal value must be set to Recurring Subscription's MRR value
- effective_date string - All payments after that date will be affected. Format: YYYY-MM-DD
pipedrive: UpdateRoleResponse200
Fields
- success boolean? - If the response is successful or not
- data Updateroleresponse200Data? - The response data
pipedrive: Updateroleresponse200Data
The response data
Fields
- id record {}? - The ID of the updated role
pipedrive: UpdateStageRequest
Fields
- name string? - Name of the Stage
- pipeline_id int? - The ID of the Pipeline to add Stage to.
- deal_probability int? - Deal success probability percentage. Used/shown when Deal weighted values are used
- rotten_flag int? - Whether Deals in this stage can become rotten
- rotten_days int? - The number of days the Deals not updated in this Stage would become rotten. Applies only if the
rotten_flag
is set.
- order_nr int? - An order number for this stage. Order numbers should be used to order the stages in the pipeline.
pipedrive: UpdateSubscriptionInstallmentRequest
Fields
- payments record {}[] - Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with a explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
- update_deal_value boolean? - Indicates that the Deal value must be set to Installment Subscription's total value
pipedrive: UpdateTeamRequest
Fields
- name string - The Team name
- description string? - The Team description
- manager_id int - The Team manager ID
- users int[]? - List of User IDs
- active_flag record {}? - Flag that indicates if the Team is activated
- deleted_flag record {}? - Flag that indicates if the Team is deleted
pipedrive: UpdateTeamRequest1
Fields
- name string - The Team name
- description string? - The Team description
- manager_id int - The Team manager ID
- users int[]? - List of User IDs
pipedrive: UpdateTeamRequest2
Fields
- active_flag record {}? - Flag that indicates if the Team is activated
- deleted_flag record {}? - Flag that indicates if the Team is deleted
pipedrive: UpdateTeamWithAdditionalProperties
Fields
- Fields Included from *UpdateTeamRequest
- add_time string? - The Team creation time. Format: YYYY-MM-DD HH:MM:SS
- created_by_user_id int? - ID of the User who created the Team
pipedrive: UpdateUserRequest
Fields
- active_flag boolean - Whether the user is active or not.
false
= Not activated,true
= Activated
pipedrive: User
Fields
- Fields Included from *User1
- id int|()
- name string|()
- default_currency string|()
- locale string|()
- lang int|()
- email string|()
- phone string|()
- activated boolean|()
- last_login string|()
- created string|()
- modified string|()
- signup_flow_variation string|()
- has_created_company boolean|()
- is_admin record { anydata... }
- active_flag boolean|()
- timezone_name string|()
- timezone_offset string|()
- role_id int|()
- icon_url string|()
- is_you boolean|()
- anydata...
- Fields Included from *User2
pipedrive: User1
Fields
- id int? - The User ID
- name string? - The User name
- default_currency string? - The User default currency
- locale string? - The User locale
- lang int? - The User language ID
- email string? - The User email
- phone string? - The User phone
- activated boolean? - Boolean that indicates if the User is activated
- last_login string? - The User last login date and time. Format: YYYY-MM-DD HH:MM:SS
- created string? - The User creation date and time. Format: YYYY-MM-DD HH:MM:SS
- modified string? - The User last modification date and time. Format: YYYY-MM-DD HH:MM:SS
- signup_flow_variation string? - The variation of signup flow (if exists). E.g. google
- has_created_company boolean? - Boolean that indicates if the User has created a Company
- is_admin record {}? - Indication if the User is admin (1 = true, 0 = false)
- active_flag boolean? - Boolean that indicates if the User is activated
- timezone_name string? - The User timezone name
- timezone_offset string? - The User timezone offset
- role_id int? - The ID of the User role
- icon_url string? - The User icon URL
- is_you boolean? - Boolean that indicates if the requested User is the same which is logged in (in this case, always true)
pipedrive: User2
Fields
- company_id int? - The User company ID
- company_name string? - The User company name
- company_domain string? - The User company domain
- company_country string? - The User company country
- company_industry string? - The User company industry
- language User2Language? - The User language details
pipedrive: User2Language
The User language details
Fields
- language_code string? - The language code. E.g. en
- country_code string? - The country code. E.g. US
pipedrive: UserAssignmentsToPermissionSetResponse200
Fields
- success boolean? - If the response is successful or not
- data Userassignmentstopermissionsetresponse200Data[]? - An array of the assignments of the User
pipedrive: Userassignmentstopermissionsetresponse200Data
Fields
- id int? - The ID of the assignment of the Permission Set
- user_id int? - The ID of the User in the Permission Set
- permission_set_id int? - The ID of the Permission Set
- name string? - The name of the Permission Set
pipedrive: UserConnectionsResponse200
Fields
- success boolean? - If the response is successful or not
- data Userconnectionsresponse200Data? - The object of UserConnections
pipedrive: Userconnectionsresponse200Data
The object of UserConnections
Fields
- google string? - The third party ID or false in case the ID is not found
pipedrive: UserIds
Fields
- success boolean? - If the response is successful or not
- data int[]? - List of User IDs
pipedrive: UserResponse200
Fields
- success boolean? - If the response is successful or not
- data Usersresponse200Data? -
pipedrive: UsersResponse200
Fields
- success boolean? - If the response is successful or not
- data Usersresponse200Data[]? -
pipedrive: Usersresponse200Data
Fields
- id int? - The User ID
- name string? - The User name
- default_currency string? - The User default currency
- locale string? - The User locale
- lang int? - The User language ID
- email string? - The User email
- phone string? - The User phone
- activated boolean? - Boolean that indicates if the User is activated
- last_login string? - The User last login date and time. Format: YYYY-MM-DD HH:MM:SS
- created string? - The User creation date and time. Format: YYYY-MM-DD HH:MM:SS
- modified string? - The User last modification date and time. Format: YYYY-MM-DD HH:MM:SS
- signup_flow_variation string? - The variation of signup flow (if exists). E.g. google
- has_created_company boolean? - Boolean that indicates if the User has created a Company
- is_admin record {}? - Indication if the User is admin (1 = true, 0 = false)
- active_flag boolean? - Boolean that indicates if the User is activated
- timezone_name string? - The User timezone name
- timezone_offset string? - The User timezone offset
- role_id int? - The ID of the User role
- icon_url string? - The User icon URL
- is_you boolean? - Boolean that indicates if the requested User is the same which is logged in (in this case, always true)
pipedrive: WebhookResponse200
Fields
- success boolean? - If the response is successful or not
- status string? - The status of the response
- data Getwebhooksresponse200Data? -
pipedrive: WebhooksBadRequestResponse
Fields
- success boolean? - If the response is successful or not
- status string? - The status of the response
- errors record {}? - List of errors
Import
import ballerinax/pipedrive;
Metadata
Released date: over 2 years ago
Version: 1.2.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 47
Current verison: 2
Weekly downloads
Keywords
Sales & CRM/Customer Relationship Management
Cost/Paid
Contributors