Pipedrive API Integration Vol.1

Suggest Edits

These are the list of integration use cases supported by Knit for Pipedrive API as part of the CRM category

Delete a call log

ID: delete_a_call_log
Operation: write
Entities: audio recording, activity, call log
Summary: This API deletes a call log from the Pipedrive system. If there is an audio recording attached to the call log, it will also be deleted. However, the related activity will not be removed by this request. To remove related activities, a different endpoint specific for activities should be used. The API requires a path parameter 'id', which is the ID received when the call log was created. The response indicates whether the deletion was successful.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a channel

ID: delete_a_channel
Operation: write
Entities: message, channel, conversation
Summary: The 'Delete a channel' API endpoint allows users to delete an existing messenger's channel and all related entities, such as conversations and messages. To use this endpoint, the user must have the Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extension. The API requires a DELETE request to the URL 'https://api.pipedrive.com/v1/channels/{id}', where '{id}' is the path parameter representing the ID of the channel to be deleted. The response will indicate success with a boolean value.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a conversation

ID: delete_a_conversation
Operation: write
Entities: channel, integration, conversation
Summary: The 'Delete a conversation' API endpoint allows users to delete an existing conversation within a specified channel. To use this endpoint, users must have the Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extension. The API requires two path parameters: 'channel-id', which is the ID of the channel provided by the integration, and 'conversation-id', which is the ID of the conversation to be deleted. The response indicates whether the deletion was successful with a boolean 'success' field.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a deal

ID: delete_a_deal
Operation: write
Entities: deal
Summary: The 'Delete a deal' API marks a deal as deleted in the Pipedrive system. The deal will be permanently deleted after 30 days. This API requires the 'id' path parameter, which is the ID of the deal to be deleted. The response includes a 'success' boolean indicating if the request was successful and a 'data' object containing the ID of the deal that was marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a deal field

ID: delete_a_deal_field
Operation: write
Entities: deal, field
Summary: The 'Delete a deal field' API marks a specified field as deleted in the Pipedrive system. It requires the ID of the field to be deleted as a path parameter. The API uses the DELETE method and the endpoint is 'https://api.pipedrive.com/v1/dealFields/{id}'. Upon successful deletion, it returns a response indicating success and the ID of the deleted field.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a file

ID: delete_a_file
Operation: write
Entities: file
Summary: The 'Delete a file' API marks a file as deleted in the Pipedrive system. The file will be permanently deleted after 30 days. The API requires a DELETE request to the endpoint 'https://api.pipedrive.com/v1/files/{id}', where '{id}' is the path parameter representing the ID of the file to be deleted. The response includes a success flag and the ID of the file that was marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a filter

ID: delete_a_filter
Operation: write
Entities: filter
Summary: This API marks a filter as deleted in the Pipedrive system. It requires the ID of the filter to be specified as a path parameter. The response indicates whether the operation was successful and returns the ID of the filter that was marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a lead

ID: delete_a_lead
Operation: write
Entities: lead
Summary: The 'Delete a lead' API allows you to delete a specific lead from the Pipedrive system. It requires the lead's ID as a path parameter, which must be a valid UUID. Upon successful deletion, the API returns a response indicating success and includes the ID of the deleted lead.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a lead label

ID: delete_a_lead_label
Operation: write
Entities: lead label
Summary: This API deletes a specific lead label identified by its ID. The request requires the 'id' path parameter, which is a UUID string representing the lead label to be deleted. Upon successful deletion, the response returns a success status and the ID of the deleted lead label.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a note

ID: delete_a_note
Operation: write
Entities: note
Summary: The 'Delete a note' API allows you to delete a specific note by providing the note's ID as a path parameter. The request method is DELETE, and the endpoint is 'https://api.pipedrive.com/v1/notes/{id}'. The path parameter 'id' is required and must be an integer representing the ID of the note to be deleted. The response includes a JSON object with a 'success' boolean indicating if the request was successful and a 'data' boolean indicating the result of the delete operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a person

ID: delete_a_person
Operation: write
Entities: person
Summary: The 'Delete a person' API marks a person as deleted in the Pipedrive system. The person will be permanently deleted after 30 days. The API requires a DELETE request to the endpoint 'https://api.pipedrive.com/v1/persons/{id}', where '{id}' is the path parameter representing the ID of the person to be deleted. The response includes a success flag and the ID of the person that was marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a pipeline

ID: delete_a_pipeline
Operation: write
Entities: pipeline
Summary: This API marks a pipeline as deleted. It requires the ID of the pipeline to be specified as a path parameter. The response indicates whether the operation was successful and returns the ID of the deleted pipeline.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a product

ID: delete_a_product
Operation: write
Entities: product
Summary: This API marks a product as deleted in the Pipedrive system. The product will be permanently deleted after 30 days. The request requires the product ID as a path parameter. The response indicates whether the operation was successful and returns the ID of the product that was marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a project

ID: delete_a_project
Operation: write
Entities: project
Summary: The 'Delete a project' API marks a project as deleted in the Pipedrive system. It requires the project ID as a path parameter. The response indicates whether the operation was successful and returns the ID of the deleted project.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a role

ID: delete_a_role
Operation: write
Entities: role
Summary: This API marks a role as deleted in the Pipedrive system. It requires the role ID as a path parameter to identify which role to delete. The response indicates whether the operation was successful and returns the ID of the deleted role.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a stage

ID: delete_a_stage
Operation: write
Entities: stage
Summary: This API marks a stage as deleted in the Pipedrive system. It requires the ID of the stage to be specified as a path parameter. The response indicates whether the operation was successful and returns the ID of the deleted stage.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a subscription

ID: delete_a_subscription
Operation: write
Entities: installment, subscription, recurring subscription
Summary: The 'Delete a subscription' API marks an installment or a recurring subscription as deleted. It requires the 'id' path parameter, which is the ID of the subscription to be deleted. The response includes a success flag and detailed information about the subscription, such as user ID, deal ID, cycle amount, currency, start and end dates, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a task

ID: delete_a_task
Operation: write
Entities: task, subtask
Summary: The 'Delete a task' API marks a task as deleted using the DELETE method. The endpoint requires a path parameter 'id', which is the integer ID of the task to be deleted. If the task has subtasks, they will also be deleted. The response includes a boolean 'success' indicating the operation's success, the 'id' of the deleted task, and 'additional_data', which is null in this case.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an activity type

ID: delete_activity_type
Operation: write
Entities: activity type
Summary: The 'Delete an activity type' API marks an activity type as deleted. It requires the ID of the activity type as a path parameter. The response includes a success flag and details of the activity type, such as its ID, order number, name, key string, icon key, active status, color, custom flag, and timestamps for when it was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an activity

ID: delete_an_activity
Operation: write
Entities: activity
Summary: The 'Delete an activity' API marks an activity as deleted in the Pipedrive system. The activity will be permanently deleted after 30 days. The API requires a DELETE request to the endpoint 'https://api.pipedrive.com/v1/activities/{id}', where '{id}' is the path parameter representing the ID of the activity to be deleted. The response includes a 'success' boolean indicating the operation's success and a 'data' object containing the 'id' of the activity that was marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an organization

ID: delete_an_organization
Operation: write
Entities: organization
Summary: The 'Delete an organization' API marks an organization as deleted in the Pipedrive system. The organization will be permanently deleted after 30 days. The API requires a DELETE request to the endpoint 'https://api.pipedrive.com/v1/organizations/{id}', where '{id}' is the path parameter representing the ID of the organization to be deleted. The response includes a success flag and the ID of the organization that was marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an attached product from a deal

ID: delete_attached_product_from_deal
Operation: write
Entities: deal, product attachment, product
Summary: This API deletes a product attachment from a deal using the specified product_attachment_id. It requires two path parameters: 'id', which is the ID of the deal, and 'product_attachment_id', which is the ID of the product attachment to be deleted. The response includes a success flag and the ID of the deleted product attachment.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a comment related to a note

ID: delete_comment_related_to_a_note
Operation: write
Entities: comment, note
Summary: This API deletes a comment related to a specific note in the Pipedrive system. It requires two path parameters: 'id', which is the integer ID of the note, and 'commentId', which is the UUID of the comment to be deleted. The response indicates whether the operation was successful with a boolean 'success' field and a 'data' field that also returns a boolean value.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a discount from a deal

ID: delete_discount_from_deal
Operation: write
Entities: discount, deal, product
Summary: This API endpoint removes a discount from a specified deal in Pipedrive. It requires the deal ID and the discount ID as path parameters. Upon successful deletion, it returns a success status and the ID of the discount that was removed. This operation may change the deal value if the deal has one-time products attached.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Existing Goal

ID: delete_existing_goal
Operation: write
Entities: goal
Summary: This API marks a goal as deleted. It requires the ID of the goal as a path parameter. The response includes a success flag, a status code, a status text, and the name of the service that processed the request.
Input Fields: Input Fields
Output Fields: Output Fields

Delete existing Webhook

ID: delete_existing_webhook
Operation: write
Entities: webhook
Summary: This API deletes the specified Webhook. It requires the ID of the Webhook to be provided as a path parameter. The response indicates whether the deletion was successful with a status and success flag.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a follower from a deal

ID: delete_follower_from_deal
Operation: write
Entities: follower, deal
Summary: This API deletes a follower from a specific deal in Pipedrive. It requires two path parameters: 'id', which is the ID of the deal, and 'follower_id', which is the ID of the follower to be removed. The response indicates whether the operation was successful and includes the ID of the deleted follower.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a follower from an organization

ID: delete_follower_from_organization
Operation: write
Entities: follower, organization
Summary: This API deletes a follower from an organization. It requires the organization ID and the follower ID as path parameters. The response indicates whether the operation was successful and returns the ID of the deleted follower.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a follower from a person

ID: delete_follower_from_person
Operation: write
Entities: follower, person
Summary: This API deletes a follower from a person in the Pipedrive system. It requires the ID of the person and the ID of the follower as path parameters. The response indicates whether the operation was successful and returns the ID of the deleted follower.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a follower from a product

ID: delete_follower_from_product
Operation: write
Entities: follower, relationship, product
Summary: This API deletes a follower from a product in the Pipedrive system. It requires two path parameters: 'id', which is the ID of the product, and 'follower_id', which is the ID of the relationship between the follower and the product. The API returns a success status and the ID of the deleted follower relationship.
Input Fields: Input Fields
Output Fields: Output Fields

Delete the link between a user and the installed video call integration

ID: delete_link_between_user_and_installed_video_call_integration
Operation: write
Entities: user, link, video calling provider
Summary: This API endpoint is used by a video calling provider to remove the link between a user and the installed video calling app. The request requires a path parameter 'id', which is a unique identifier linking a user to the installed integration. The response returns a success status and a message indicating the result of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Mail Thread

ID: delete_mail_thread
Operation: write
Entities: mail thread
Summary: The Delete Mail Thread API marks a mail thread as deleted. It requires the ID of the mail thread as a path parameter. The response includes a success flag, status code, status text, the service that processed the request, and the ID of the deleted mail thread.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple activities in bulk

ID: delete_multiple_activities_in_bulk
Operation: write
Entities: activity
Summary: The 'Delete multiple activities in bulk' API marks multiple activities as deleted. It requires the 'ids' query parameter, which is a comma-separated string of activity IDs to be deleted. The request must include an 'Authorization' header with a valid API token. The response indicates success and returns the IDs of the activities that were marked as deleted. After 30 days, these activities will be permanently deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple activity types in bulk

ID: delete_multiple_activity_types_in_bulk
Operation: write
Entities: activity type
Summary: This API endpoint allows users to mark multiple activity types as deleted in bulk. It requires a DELETE request to the URL 'https://api.pipedrive.com/v1/activityTypes' with a mandatory query parameter 'ids', which is a string of comma-separated activity type IDs. The response includes a 'success' boolean indicating the operation's success and a 'data' object containing the list of IDs of the activity types that were marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple deal fields in bulk

ID: delete_multiple_deal_fields_in_bulk
Operation: write
Entities: deal field
Summary: This API marks multiple deal fields as deleted in bulk. It requires a DELETE request to the endpoint 'https://api.pipedrive.com/v1/dealFields' with a query parameter 'ids', which is a comma-separated string of field IDs that need to be deleted. The response includes a success flag and a data object containing the list of IDs of the deal fields that were marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple deals in bulk

ID: delete_multiple_deals_in_bulk
Operation: write
Entities: deal
Summary: This API marks multiple deals as deleted using the DELETE method. The endpoint is 'https://api.pipedrive.com/v1/deals'. It requires a query parameter 'ids', which is a comma-separated string of deal IDs to be marked as deleted. After 30 days, these deals will be permanently deleted. The response includes a 'success' boolean indicating the operation's success and a 'data' object containing the list of IDs that were marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple filters in bulk

ID: delete_multiple_filters_in_bulk
Operation: write
Entities: filter
Summary: This API marks multiple filters as deleted in bulk. It requires a DELETE request to the endpoint 'https://api.pipedrive.com/v1/filters'. The request must include a query parameter 'ids', which is a comma-separated string of filter IDs that you want to delete. The response will indicate success and provide a list of IDs of the filters that were marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple organization fields in bulk

ID: delete_multiple_organization_fields_in_bulk
Operation: write
Entities: organization field
Summary: This API endpoint allows users to mark multiple organization fields as deleted in bulk. It requires a DELETE request to the specified URL with a query parameter 'ids', which is a comma-separated string of field IDs that need to be deleted. The response indicates whether the operation was successful and provides a list of IDs of the fields that were marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple organizations in bulk

ID: delete_multiple_organizations_in_bulk
Operation: write
Entities: organization
Summary: This API marks multiple organizations as deleted using their IDs. The organizations will be permanently deleted after 30 days. The request requires a query parameter 'ids', which is a comma-separated string of organization IDs to be deleted. The response returns a success status and the list of IDs that were marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple person fields in bulk

ID: delete_multiple_person_fields_in_bulk
Operation: write
Entities: person field
Summary: This API endpoint allows you to mark multiple person fields as deleted in bulk. It requires a DELETE request to the URL 'https://api.pipedrive.com/v1/personFields'. The request must include a query parameter 'ids', which is a required string containing the comma-separated IDs of the fields to be deleted. The response will indicate success and provide a list of the IDs of the fields that were marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple persons in bulk

ID: delete_multiple_persons_in_bulk
Operation: write
Entities: person
Summary: The 'Delete multiple persons in bulk' API marks multiple persons as deleted in the Pipedrive system. It requires a DELETE request to the endpoint 'https://api.pipedrive.com/v1/persons' with a mandatory query parameter 'ids', which is a comma-separated string of person IDs to be deleted. The response indicates success and provides the list of IDs that were marked as deleted. After 30 days, these persons will be permanently deleted from the system.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple product fields in bulk

ID: delete_multiple_product_fields_in_bulk
Operation: write
Entities: product field
Summary: This API marks multiple product fields as deleted in bulk. It requires a DELETE request to the endpoint 'https://api.pipedrive.com/v1/productFields'. The request must include a query parameter 'ids', which is a comma-separated string of field IDs that you want to delete. The response will indicate success and provide a list of IDs of the fields that were marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete multiple stages in bulk

ID: delete_multiple_stages_in_bulk
Operation: write
Entities: stage
Summary: This API marks multiple stages as deleted in bulk. It requires a DELETE request to the endpoint 'https://api.pipedrive.com/v1/stages'. The request must include a query parameter 'ids', which is a comma-separated string of stage IDs that you want to delete. The response will indicate success and provide a list of IDs of the stages that were marked as deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an organization field

ID: delete_organization_field
Operation: write
Entities: organization field, custom field
Summary: The 'Delete an organization field' API marks a specified field as deleted in the Pipedrive system. It requires the ID of the field to be deleted as a path parameter. The API uses the DELETE method and the endpoint is 'https://api.pipedrive.com/v1/organizationFields/{id}'. Upon successful deletion, it returns a response indicating success and the ID of the deleted field.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an organization relationship

ID: delete_organization_relationship
Operation: write
Entities: organization relationship
Summary: This API deletes an organization relationship identified by the given ID and returns the ID of the deleted relationship. The request requires a path parameter 'id', which is an integer representing the ID of the organization relationship to be deleted. The response includes a 'success' boolean indicating if the deletion was successful and a 'data' object containing the 'id' of the deleted organization relationship.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a participant from a deal

ID: delete_participant_from_deal
Operation: write
Entities: deal, participant
Summary: This API deletes a participant from a deal in Pipedrive. It requires two path parameters: 'id', which is the ID of the deal, and 'deal_participant_id', which is the ID of the participant to be removed from the deal. The response includes a success flag and the ID of the deleted participant.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a person field

ID: delete_person_field
Operation: write
Entities: person field
Summary: The 'Delete a person field' API marks a specified field as deleted in the Pipedrive system. It requires the ID of the field to be deleted as a path parameter. The API uses the DELETE method and the endpoint is 'https://api.pipedrive.com/v1/personFields/{id}'. Upon successful deletion, it returns a response indicating success and the ID of the deleted field.
Input Fields: Input Fields
Output Fields: Output Fields

Delete person picture

ID: delete_person_picture
Operation: write
Entities: person, picture
Summary: This API deletes a person's picture. It requires the ID of the person as a path parameter. The response indicates whether the deletion was successful and returns the ID of the person whose picture was deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a product field

ID: delete_product_field
Operation: write
Entities: product field
Summary: This API marks a product field as deleted in the Pipedrive system. It requires the ID of the product field to be specified as a path parameter. The response indicates whether the operation was successful and returns the ID of the deleted product field.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a product variation

ID: delete_product_variation
Operation: write
Entities: product variation, product
Summary: This API deletes a product variation. It requires the product ID and the product variation ID as path parameters. The response indicates whether the deletion was successful and returns the ID of the deleted product variation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a role assignment

ID: delete_role_assignment
Operation: write
Entities: user, role
Summary: The 'Delete a role assignment' API removes the assigned user from a specified role and adds them to the default role. It requires the role ID as a path parameter and the user ID as a body parameter. The response indicates whether the operation was successful and provides the ID of the role assignment that was removed.
Input Fields: Input Fields
Output Fields: Output Fields

Delete users from a team

ID: delete_users_from_a_team
Operation: write
Entities: user, team
Summary: This API deletes users from an existing team. It requires the team ID as a path parameter and a list of user IDs to be deleted as a body parameter. The response indicates whether the operation was successful and returns the list of user IDs that were deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Get a single team

ID: get_a_single_team
Operation: read
Entities: user, team, manager
Summary: This API returns data about a specific team identified by its ID. The request requires a path parameter 'id' which is the ID of the team. An optional query parameter 'skip_users' can be used to exclude the IDs of member users from the response. The response includes details such as the team's name, description, manager ID, user IDs, and status flags.
Input Fields: Input Fields
Output Fields: Output Fields

Get all activities assigned to a particular user

ID: get_all_activities_assigned_to_a_particular_user
Operation: read
Entities: user, activity, organization
Summary: This API endpoint retrieves all activities assigned to a specific user in Pipedrive. It accepts several query parameters such as user_id, filter_id, type, limit, start, start_date, end_date, and done to filter and paginate the results. The response includes a success flag, an array of activity data, related objects, and pagination details. Each activity contains details like id, company_id, user_id, type, due_date, subject, location, and attendees.
Input Fields: Input Fields
Output Fields: Output Fields

Get all activities (BETA)

ID: get_all_activities_beta
Operation: read
Entities: user, company, activity
Summary: The 'Get all activities (BETA)' API endpoint retrieves all activities from Pipedrive. It is a cursor-paginated endpoint, meaning it supports pagination through the use of a cursor. This endpoint is currently in BETA and is accessible only to global admins with global permissions. Regular users will receive a 403 response. The API accepts several query parameters such as 'cursor' for pagination, 'limit' to specify the number of entries returned, 'since' and 'until' to define the time range, 'user_id' to filter activities by user, 'done' to filter by completion status, and 'type' to filter by activity type. The response includes a success flag, a list of activity data, and additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get all activity fields

ID: get_all_activity_fields
Operation: read
Entities: option, activity field
Summary: The 'Get all activity fields' API endpoint retrieves all activity fields available in the Pipedrive system. It requires an API token for authentication, which can be provided either as a query parameter or as a Bearer token in the headers. The response includes a success flag, a list of activity fields with details such as id, key, name, field type, and various flags indicating the properties of each field. Additionally, pagination information is provided in the response to handle large datasets.
Input Fields: Input Fields
Output Fields: Output Fields

Get all activity types

ID: get_all_activity_types
Operation: read
Entities: activity type
Summary: The 'Get all activity types' API endpoint returns a list of all activity types available in the Pipedrive system. It requires an API token for authentication, which should be included in the request headers. The response includes a success flag and an array of activity type objects, each containing details such as id, order number, name, key string, icon key, active status, color, custom flag, and timestamps for when the activity type was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Get all add-ons for a single company

ID: get_all_add_ons_for_a_single_company
Operation: read
Entities: company, add-on, subscription
Summary: This API endpoint retrieves all the add-ons available for a single company in Pipedrive. It requires an API token for authentication, which should be included in the Authorization header. The response includes a success flag and a list of add-ons, each identified by a unique code.
Input Fields: Input Fields
Output Fields: Output Fields

Get all call logs assigned to a particular user

ID: get_all_call_logs_assigned_to_a_particular_user
Operation: read
Entities: user, company, call log
Summary: This API endpoint retrieves all call logs assigned to a particular user. It supports pagination through the 'start' and 'limit' query parameters. The response includes a list of call logs with details such as activity ID, person ID, organization ID, deal ID, subject, duration, outcome, phone numbers, recording status, start and end times, user ID, company ID, and notes. The response also includes additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get all comments for a note

ID: get_all_comments_for_a_note
Operation: read
Entities: pagination, comment, note
Summary: This API retrieves all comments associated with a specific note. The request requires the note ID as a path parameter. Optional query parameters include 'start' for pagination start and 'limit' for the number of items per page. The response includes a success flag, a list of comments with details such as UUID, content, and timestamps, and additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get all deal fields

ID: get_all_deal_fields
Operation: read
Entities: pagination, option, deal field
Summary: The 'Get all deal fields' API returns data about all deal fields in the Pipedrive system. It is a GET request to the endpoint 'https://api.pipedrive.com/v1/dealFields'. The API supports optional query parameters 'start' and 'limit' for pagination. The response includes a 'success' flag, an array of 'data' containing details about each deal field such as 'id', 'key', 'name', 'field_type', and other attributes. Additionally, 'options' are provided for fields of type 'enum'. The 'additional_data' section includes pagination details.
Input Fields: Input Fields
Output Fields: Output Fields

Get all deals

ID: get_all_deals
Operation: read
Entities: person, deal, organization
Summary: The 'Get all deals' API endpoint retrieves all deals from the Pipedrive system. It supports various query parameters to filter and sort the deals, such as 'filter_id', 'person_id', 'org_id', 'pipeline_id', 'stage_id', 'status', 'sort_by', 'sort_direction', 'include_fields', 'custom_fields', 'limit', and 'cursor'. The response includes a success flag, an array of deal objects with detailed information about each deal, and additional data for pagination. The API is useful for obtaining comprehensive deal information with optional filtering and sorting capabilities.
Input Fields: Input Fields
Output Fields: Output Fields

Get all deals (BETA)

ID: get_all_deals_beta
Operation: read
Entities: user, deal, stage
Summary: The 'Get all deals (BETA)' API endpoint allows global admins to retrieve all deals from the Pipedrive system. This endpoint is cursor-paginated and currently in BETA. Users can filter the deals by various query parameters such as cursor, limit, since, until, user_id, stage_id, and status. The response includes a list of deals with detailed information such as deal ID, creator user ID, person ID, organization ID, stage ID, title, value, currency, add time, update time, status, and more. The response also includes additional data for pagination, such as the next cursor. Only users with global permissions can access this endpoint; others will receive a 403 response.
Input Fields: Input Fields
Output Fields: Output Fields

Get all files

ID: get_all_files
Operation: read
Entities: user, file, deal
Summary: The 'Get all files' API endpoint retrieves data about all files stored in the system. It supports pagination through the 'start' and 'limit' query parameters, and allows sorting of results using the 'sort' parameter. The response includes a list of files with details such as file ID, user ID, deal ID, person ID, organization ID, product ID, activity ID, lead ID, file name, file type, file size, and more. Additional pagination data is provided in the 'additional_data' field.
Input Fields: Input Fields
Output Fields: Output Fields

Get all filter helpers

ID: get_all_filter_helpers
Operation: read
Entities: helper, condition, filter
Summary: The 'Get all filter helpers' API endpoint returns all supported filter helpers available in Pipedrive. This API is useful for understanding the conditions and helpers that can be used when adding or updating filters. The request requires an authorization header with a bearer token for authentication. The response includes a success flag and a data object containing various operators for different data types, deprecated operators, relative date intervals, and address field components. This information is essential for constructing and managing filters effectively in Pipedrive.
Input Fields: Input Fields
Output Fields: Output Fields

Get all filters

ID: get_all_filters
Operation: read
Entities: user, view, filter
Summary: The 'Get all filters' API returns data about all filters available in the Pipedrive system. It supports an optional query parameter 'type' which specifies the type of filters to fetch, such as 'deals', 'leads', 'org', 'people', 'products', 'activity', or 'projects'. The response includes a success flag and an array of filter objects, each containing details like id, name, active status, type, user id, and timestamps for when the filter was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Get all lead labels

ID: get_all_lead_labels
Operation: read
Entities: lead label
Summary: The 'Get all lead labels' API endpoint retrieves details of all lead labels available in the system. This endpoint does not support pagination, meaning all labels are returned in a single response. The request requires an Authorization header with a Bearer token for authentication. The response includes a success flag and an array of lead label objects, each containing an id, name, color, add_time, and update_time.
Input Fields: Input Fields
Output Fields: Output Fields

Get all lead sources

ID: get_all_lead_sources
Operation: read
Entities: lead, lead source
Summary: This API endpoint retrieves all lead sources from Pipedrive. The list of lead sources is fixed and cannot be modified. All leads created through the Pipedrive API will have a lead source assigned from this list. The request requires an Authorization header with a Bearer token for authentication. The response includes a success flag and a data array containing the names of the lead sources.
Input Fields: Input Fields
Output Fields: Output Fields

Get all leads

ID: get_all_leads
Operation: read
Entities: deal, custom field, lead
Summary: The 'Get all leads' API endpoint allows users to retrieve multiple leads from the Pipedrive system. The leads are sorted by their creation time, from oldest to newest. Users can control pagination using the 'limit' and 'start' query parameters. Additional filtering options include 'archived_status', 'owner_id', 'person_id', 'organization_id', 'filter_id', and 'sort'. The response includes detailed information about each lead, such as 'id', 'title', 'owner_id', 'creator_id', 'label_ids', 'person_id', 'organization_id', 'source_name', 'origin', 'channel', 'is_archived', 'was_seen', 'value', 'expected_close_date', 'next_activity_id', 'add_time', 'update_time', 'visible_to', and 'cc_email'. Custom fields from deals are inherited by leads and included in the response if set.
Input Fields: Input Fields
Output Fields: Output Fields

Get all mail messages of mail thread

ID: get_all_mail_messages_of_mail_thread
Operation: read
Entities: mail message, mail thread, person
Summary: This API endpoint retrieves all the mail messages inside a specified mail thread. The request requires a path parameter 'id', which is the ID of the mail thread. The response includes a success flag and a data array containing details of each mail message, such as sender and recipient information, subject, snippet, and various flags indicating the status of the message.
Input Fields: Input Fields
Output Fields: Output Fields

Get all note fields

ID: get_all_note_fields
Operation: read
Entities: pagination, note field, option
Summary: The 'Get all note fields' API endpoint retrieves data about all note fields available in the Pipedrive system. It requires an Authorization header with a Bearer token for authentication. The response includes a success flag, an array of note fields with details such as id, key, name, field type, and flags indicating if the field is active, editable, or mandatory. Enum type fields also include options. Additional data about pagination is provided in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Get all notes

ID: get_all_notes
Operation: read
Entities: deal, note, organization
Summary: The 'Get all notes' API endpoint retrieves all notes from the Pipedrive system. It supports various query parameters to filter the notes based on user, lead, deal, person, and organization IDs. Pagination is supported through 'start' and 'limit' parameters. Sorting can be done using the 'sort' parameter. Date range filtering is available with 'start_date' and 'end_date'. The response includes a list of notes with details such as content, associated deal, lead, organization, person, and user information. Pagination details are also provided in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Get all organization fields

ID: get_all_organization_fields
Operation: read
Entities: pagination, organization field, organization
Summary: This API endpoint retrieves data about all organization fields in Pipedrive. It uses the GET method and does not require any headers or path parameters. The query parameters include 'start' for pagination start and 'limit' for the number of items shown per page. The response includes a success flag, a list of organization fields with details such as id, key, name, field type, and other attributes, and additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get all organizations

ID: get_all_organizations
Operation: read
Entities: user, picture, organization
Summary: This API endpoint retrieves all organizations from the Pipedrive system. It supports various query parameters such as user_id, filter_id, first_char, start, limit, and sort to filter and paginate the results. The response includes detailed information about each organization, such as its ID, name, owner details, deal counts, activity counts, and address information. Additionally, the response provides pagination details and related objects like users and pictures.
Input Fields: Input Fields
Output Fields: Output Fields

Get all organizations (BETA)

ID: get_all_organizations_beta
Operation: read
Entities: user, organization, global admin
Summary: The 'Get all organizations (BETA)' API endpoint retrieves a list of all organizations in a cursor-paginated format. This endpoint is currently in BETA and is accessible only to global admins with global permissions. Regular users will receive a 403 response. The API supports several query parameters for filtering and pagination, including 'cursor' for pagination, 'limit' for the number of entries, 'since' and 'until' for date range filtering, 'owner_id' for filtering by owner, and 'first_char' for filtering by the starting letter of the organization's name. The response includes a success flag, a list of organization data, and additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get all payments of a subscription

ID: get_all_payments_of_a_subscription
Operation: read
Entities: payment, deal, subscription
Summary: This API endpoint retrieves all payments associated with a specific subscription, whether it is an installment or a recurring subscription. The request requires a path parameter 'id', which is the ID of the subscription. The response includes a success flag and a data array containing details of each payment, such as payment ID, subscription ID, deal ID, active status, amount, currency, change amount, due date, revenue movement type, payment type, description, and timestamps for when the payment was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Get all permission sets

ID: get_all_permission_sets
Operation: read
Entities: assignment count, app, permission set
Summary: This API endpoint retrieves data about all permission sets available in the system. It supports filtering by the app using the 'app' query parameter, which can take values such as 'sales', 'projects', 'campaigns', 'global', and 'account_settings'. The response includes a success flag and a list of permission sets, each with details such as id, name, description, app, type, and assignment count.
Input Fields: Input Fields
Output Fields: Output Fields

Get all person fields

ID: get_all_person_fields
Operation: read
Entities: company, campaign product, person field
Summary: The 'Get all person fields' API endpoint retrieves data about all person fields available in the Pipedrive system. If the company uses the Campaigns product, the endpoint will also return the 'data.marketing_status' field. The API uses the GET method and is accessed via the URL 'https://api.pipedrive.com/v1/personFields'. It accepts optional query parameters 'start' and 'limit' for pagination purposes. The response includes a 'success' flag, an array of 'data' containing details of each person field such as 'id', 'key', 'name', 'field_type', and other attributes. Additionally, it provides 'additional_data' for pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

Get all persons

ID: get_all_persons
Operation: read
Entities: person, organization, user
Summary: The 'Get all persons' API endpoint retrieves a list of all persons from the Pipedrive system. It supports various query parameters such as 'user_id' to filter persons by owner, 'filter_id' to apply specific filters, 'first_char' to filter by the starting letter of the person's name, 'start' for pagination, 'limit' to specify the number of items per page, and 'sort' to define the sorting order. The response includes detailed information about each person, such as their ID, name, contact details, associated deals, activities, and more. Additionally, the response provides pagination details and related objects like organizations and users.
Input Fields: Input Fields
Output Fields: Output Fields

Get all persons (BETA)

ID: get_all_persons_beta
Operation: read
Entities: pagination, person, permission
Summary: The 'Get all persons (BETA)' API endpoint retrieves a list of all persons using cursor-based pagination. It is accessible only to global admins with global permissions. The API supports several query parameters for filtering results, including 'cursor' for pagination, 'limit' for the number of entries, 'since' and 'until' for date range filtering, 'owner_id' for filtering by owner, and 'first_char' for filtering by the initial character of the person's name. The response includes a success flag, a list of person objects with details such as ID, name, phone numbers, email addresses, and timestamps, as well as additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get all pipelines

ID: get_all_pipelines
Operation: read
Entities: pipeline
Summary: The 'Get all pipelines' API returns data about all pipelines in the Pipedrive system. It supports optional query parameters for sorting and pagination, including 'sort_by' to specify the field to sort by (id, update_time, add_time), 'sort_direction' to specify the sorting direction (asc, desc), 'limit' to specify the number of entries to return (default is 100, maximum is 500), and 'cursor' for pagination. The response includes a success flag, an array of pipeline objects with details such as id, name, order number, and timestamps, and additional data for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Get all product fields

ID: get_all_product_fields
Operation: read
Entities: pagination, product field
Summary: The 'Get all product fields' API endpoint returns data about all product fields in the Pipedrive system. It uses the GET method and requires an Authorization header with a Bearer token for authentication. The API supports query parameters 'start' and 'limit' for pagination, with 'start' indicating the pagination start and 'limit' specifying the number of items shown per page. The response includes a 'success' flag, an array of 'data' objects representing product fields, and 'additional_data' for pagination details. Each product field object contains various attributes such as 'id', 'key', 'name', 'field_type', and flags indicating visibility and editability.
Input Fields: Input Fields
Output Fields: Output Fields

Get all product variations

ID: get_all_product_variations
Operation: read
Entities: product variation, price, product
Summary: This API endpoint retrieves data about all variations of a specified product. The request requires a path parameter 'id' which is the ID of the product. Optional query parameters include 'cursor' for pagination and 'limit' to specify the number of entries to return, with a default of 100 and a maximum of 500. The response includes a success flag, an array of product variations with details such as ID, name, product ID, and pricing information, and additional data for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Get all products

ID: get_all_products
Operation: read
Entities: custom field, price, product
Summary: The 'Get all products' API endpoint retrieves data about all products available in the system. It supports various query parameters such as 'owner_id' to filter products by owner, 'filter_id' to apply specific filters, 'ids' to specify particular product IDs, 'cursor' for pagination, 'limit' to control the number of entries returned, 'sort_by' to determine the sorting field, and 'sort_direction' to set the sorting order. The response includes a success flag, an array of product objects with detailed information such as product ID, name, code, description, category, pricing details, and custom fields, along with additional data for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Get all project boards

ID: get_all_project_boards
Operation: read
Entities: project board
Summary: The 'Get all project boards' API endpoint retrieves all project boards that are not deleted from the Pipedrive system. It requires an API token for authentication, which should be included as a query parameter. The response includes a success flag, an array of project board objects with details such as ID, name, order number, add time, and update time, and any additional data if available.
Input Fields: Input Fields
Output Fields: Output Fields

Get all project templates

ID: get_all_project_templates
Operation: read
Entities: project, project template
Summary: This API endpoint retrieves all non-deleted project templates from Pipedrive. It supports cursor-based pagination, allowing users to navigate through large sets of data. The request can include optional query parameters 'cursor' and 'limit' to control pagination. The response includes a success flag, an array of project templates with details such as id, title, description, projects board id, owner id, add time, and update time, and additional pagination data including the next cursor.
Input Fields: Input Fields
Output Fields: Output Fields

Get all projects

ID: get_all_projects
Operation: read
Entities: person, project, deal
Summary: The 'Get all projects' API endpoint retrieves all projects from the Pipedrive system. It supports cursor-based pagination, allowing users to navigate through large sets of data. The API accepts several optional query parameters: 'cursor' for pagination, 'limit' to specify the number of entries returned, 'filter_id' to apply a specific filter, 'status' to filter projects by their status, 'phase_id' to filter by project phase, and 'include_archived' to include archived projects in the response. The response includes a success flag, a list of project details, and additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get all relationships for organization

ID: get_all_relationships_for_organization
Operation: read
Entities: relationship, organization relationship, organization
Summary: This API endpoint retrieves all relationships for a specified organization ID. The request requires a query parameter 'org_id', which is the ID of the organization for which relationships are to be fetched. The response includes a success flag, a list of relationships with details such as related organization name, relationship type, and organization details. Additional data includes pagination information, and related objects provide further details about the organizations involved.
Input Fields: Input Fields
Output Fields: Output Fields

Get all roles

ID: get_all_roles
Operation: read
Entities: pagination, company, role
Summary: This API endpoint retrieves all the roles within the company. It uses the GET method and is accessed via the URL https://api.pipedrive.com/v1/roles. The API supports optional query parameters 'start' and 'limit' for pagination. The response includes a success flag, a list of roles with details such as role ID, parent role ID, name, active status, assignment count, sub-role count, and level. Additionally, it provides pagination information in the 'additional_data' field.
Input Fields: Input Fields
Output Fields: Output Fields

Get all stages

ID: get_all_stages
Operation: read
Entities: stage, pipeline
Summary: The 'Get all stages' API endpoint retrieves data about all stages in the Pipedrive system. It supports optional query parameters such as 'pipeline_id' to filter stages by pipeline, 'sort_by' to specify the field for sorting (default is 'id'), 'sort_direction' to determine the sorting order (default is 'asc'), 'limit' to set the number of entries returned (default is 100, maximum is 500), and 'cursor' for pagination. The response includes a success flag, an array of stage objects with details like 'id', 'name', 'deal_probability', and timestamps, as well as additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get all supported currencies

ID: get_all_supported_currencies
Operation: read
Entities: account, monetary value, currency
Summary: This API endpoint returns all supported currencies in the given account, which should be used when saving monetary values with other objects. The response includes a list of currency objects, each containing details such as the currency code (according to ISO 4217 for non-custom currencies), name, symbol, and whether the currency is active or custom. An optional query parameter 'term' can be used to search for currencies by name or code.
Input Fields: Input Fields
Output Fields: Output Fields

Get all tasks

ID: get_all_tasks
Operation: read
Entities: user, task, project
Summary: The 'Get all tasks' API endpoint retrieves all tasks from the Pipedrive system. It supports cursor-based pagination, allowing users to navigate through large sets of tasks. The API accepts several optional query parameters: 'cursor' for pagination, 'limit' to specify the number of tasks returned, 'assignee_id' to filter tasks by assignee, 'project_id' to filter tasks by project, 'parent_task_id' to filter parent or sub-tasks, and 'done' to filter tasks by completion status. The response includes a success flag, a list of tasks with details such as ID, title, creator, description, status, due date, and timestamps, and additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get all teams

ID: get_all_teams
Operation: read
Entities: user, team, manager
Summary: The 'Get all teams' API returns data about teams within the company. It allows sorting of the returned teams by fields such as 'id', 'name', 'manager_id', and 'active_flag' using the 'order_by' query parameter. The 'skip_users' query parameter can be used to exclude member user IDs from the response. The response includes details such as team ID, name, description, manager ID, user IDs, active status, deletion status, addition time, and creator user ID.
Input Fields: Input Fields
Output Fields: Output Fields

Get all teams of a user

ID: get_all_teams_of_a_user
Operation: read
Entities: user, team, manager
Summary: This API returns data about all teams which have the specified user as a member. The request requires a path parameter 'id' which is the ID of the user. Optional query parameters include 'order_by' to sort the returned teams by a specific field, and 'skip_users' to exclude member user IDs from the response. The response includes a success flag and a list of teams with details such as team ID, name, description, manager ID, user IDs, active status, deletion status, addition time, and creator user ID.
Input Fields: Input Fields
Output Fields: Output Fields

Get all user connections

ID: get_all_user_connections
Operation: read
Entities: user, connection, user connection
Summary: The 'Get all user connections' API returns data about all connections for the authorized user. It requires an authorization header with a bearer token. The response includes a success flag and data containing the user's connection details, such as the Google connection ID.
Input Fields: Input Fields
Output Fields: Output Fields

Get all users

ID: get_all_users
Operation: read
Entities: user, access, company
Summary: The 'Get all users' API endpoint retrieves data about all users within the company. It requires an Authorization header with a Bearer token for authentication. The response includes a success flag and a data array containing user details such as id, name, email, phone, activation status, last login, creation and modification timestamps, access permissions, active status, timezone information, role ID, icon URL, and deletion status.
Input Fields: Input Fields
Output Fields: Output Fields

Get all users in a team

ID: get_all_users_in_a_team
Operation: read
Entities: user, team
Summary: This API returns a list of all user IDs within a specified team. The request requires a path parameter 'id', which is the ID of the team. The response includes a 'success' boolean indicating if the request was successful and a 'data' array containing the user IDs.
Input Fields: Input Fields
Output Fields: Output Fields

Get all Webhooks

ID: get_all_webhooks
Operation: read
Entities: activity type, company, webhook
Summary: The 'Get all Webhooks' API endpoint retrieves data about all the webhooks associated with a company. It requires an API token for authentication, which can be provided either as a query parameter or as a Bearer token in the headers. The response includes a status and success indicator, along with an array of webhook objects. Each webhook object contains details such as the ID, company ID, owner ID, user ID, event action, event object, subscription URL, version, active status, addition time, removal time, type, HTTP authentication details, additional data, removal reason, last delivery time, last HTTP status, and admin ID.
Input Fields: Input Fields
Output Fields: Output Fields

Get current user data

ID: get_current_user_data
Operation: read
Entities: user, access, company
Summary: The 'Get current user data' API endpoint retrieves information about the authorized user within a company, including user details such as ID, name, email, and phone number, as well as company-related data like company ID, name, domain, and industry. The request requires an authorization header with a bearer token. The response includes detailed user information, access permissions, and company data, formatted in JSON.
Input Fields: Input Fields
Output Fields: Output Fields

Get deal products of several deals

ID: get_deal_products_of_several_deals
Operation: read
Entities: deal, product
Summary: The 'Get deal products of several deals' API endpoint retrieves data about products attached to specified deals. It requires a list of deal IDs as a query parameter and supports pagination through 'cursor' and 'limit' parameters. The response includes details about each product, such as ID, sum, tax, deal ID, name, and more, along with pagination information in 'additional_data'.
Input Fields: Input Fields
Output Fields: Output Fields

Get deals conversion rates in pipeline

ID: get_deals_conversion_rates_in_pipeline
Operation: read
Entities: user, stage conversion, pipeline
Summary: The 'Get deals conversion rates in pipeline' API returns all stage-to-stage conversion and pipeline-to-close rates for a specified time period. It requires the pipeline ID as a path parameter and the start and end dates as query parameters. Optionally, a user ID can be provided to fetch statistics for a specific user. The response includes conversion rates between stages, as well as overall conversion rates for won and lost deals.
Input Fields: Input Fields
Output Fields: Output Fields

Get deals in a pipeline

ID: get_deals_in_a_pipeline
Operation: read
Entities: user, deal, pipeline
Summary: The 'Get deals in a pipeline' API endpoint allows users to list deals in a specific pipeline across all its stages. The endpoint requires the pipeline ID as a path parameter. Optional query parameters include filter_id, user_id, everyone, stage_id, start, limit, get_summary, and totals_convert_currency. The response includes a success flag, a list of deals with detailed information such as deal ID, creator user ID, person ID, organization ID, stage ID, title, value, currency, and more. Additional data includes pagination details. If no parameters are provided, open deals owned by the authorized user will be returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get deals in a stage

ID: get_deals_in_a_stage
Operation: read
Entities: user, deal, stage
Summary: This API endpoint retrieves a list of deals in a specific stage from Pipedrive. The stage is identified by the 'id' path parameter, which is required. Optional query parameters include 'filter_id' to filter deals by a specific filter, 'user_id' to filter deals by a specific user, 'everyone' to retrieve deals owned by everyone, 'start' for pagination start, and 'limit' for the number of items per page. The response includes a success flag, a list of deals with detailed information such as deal ID, creator user ID, person and organization IDs, title, value, currency, and various timestamps, as well as additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get deals summary

ID: get_deals_summary
Operation: read
Entities: summary, deal, value
Summary: The Get deals summary API returns a summary of all the deals in the Pipedrive system. It allows filtering of deals based on status, filter_id, user_id, and stage_id through query parameters. The response includes a success flag and detailed data about the total and weighted values of deals in different currencies, including their counts and formatted values. The total count of deals and their converted values in USD are also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Get deals timeline

ID: get_deals_timeline
Operation: read
Entities: user, deal, pipeline
Summary: The Get deals timeline API returns open and won deals, grouped by a defined interval of time set in a date-type dealField (field_key). The API requires query parameters such as start_date, interval, amount, and field_key to define the timeline and grouping of deals. Optional parameters include user_id, pipeline_id, filter_id, exclude_deals, and totals_convert_currency to filter and customize the response. The response includes a success flag and data containing the period start and end, a list of deals with detailed information, and totals with counts and values in different currencies.
Input Fields: Input Fields
Output Fields: Output Fields

Get deals where a product is attached to

ID: get_deals_where_a_product_is_attached_to
Operation: read
Entities: deal, organization, product
Summary: This API endpoint retrieves data about deals that have a specific product attached to them. The request requires a path parameter 'id', which is the ID of the product. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, and 'status' to filter deals by their status (e.g., open, won, lost, deleted, all_not_deleted). The response includes a success flag, an array of deal data, additional pagination data, and related objects such as users, organizations, persons, stages, and pipelines.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of a board

ID: get_details_of_a_board
Operation: read
Entities: project board
Summary: This API endpoint returns the details of a specific project board. It requires the 'id' path parameter, which is an integer representing the ID of the project board. The response includes a success flag, the project board's details such as its ID, name, order number, add time, and update time, and any additional data if available.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of a call log

ID: get_details_of_a_call_log
Operation: read
Entities: activity, call log, note
Summary: This API retrieves the details of a specific call log using the call log ID. The request requires a path parameter 'id', which is the ID received when the call log was created. The response includes details such as the activity ID, person ID, organization ID, deal ID, subject, duration, outcome, phone numbers, recording status, start and end times, user ID, company ID, and any notes associated with the call log.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of a deal

ID: get_details_of_a_deal
Operation: read
Entities: deal, custom field, pipeline
Summary: The 'Get details of a deal' API endpoint allows users to retrieve detailed information about a specific deal in the Pipedrive system. The API requires the deal ID as a path parameter and offers several optional query parameters to filter the results, such as filter_id, owner_id, person_id, org_id, pipeline_id, stage_id, status, include_fields, and custom_fields. The response includes comprehensive details about the deal, including its ID, title, creator, owner, value, associated person and organization, stage, pipeline, currency, timestamps, status, visibility, and various financial metrics. Custom fields are also included in the response, appearing as long hashes that can be mapped against the key value of dealFields.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of a person

ID: get_details_of_a_person
Operation: read
Entities: person, organization, user
Summary: This API endpoint retrieves the details of a specific person from the Pipedrive system using their unique ID. The request requires an authorization header with a bearer token for authentication. The path parameter 'id' is mandatory and specifies the ID of the person whose details are to be fetched. The response includes a comprehensive set of data about the person, such as their name, contact information, deal counts, activity counts, and more. It also includes additional fields like marketing status if the company uses the Campaigns product. The response is structured with a 'success' flag, the 'data' object containing the person's details, 'additional_data' for extra information, and 'related_objects' for associated entities like organizations and users.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of a phase

ID: get_details_of_a_phase
Operation: read
Entities: project, phase
Summary: This API returns the details of a specific project phase. It requires the 'id' path parameter, which is the ID of the project phase. The response includes details such as the phase ID, name, board ID, order number, and timestamps for when the phase was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of a project

ID: get_details_of_a_project
Operation: read
Entities: label, project, field
Summary: This API endpoint retrieves the details of a specific project from Pipedrive. The request requires the project ID as a path parameter. The response includes detailed information about the project such as its title, description, status, start and end dates, owner ID, associated labels, deals, person, organization, board, and phase. Custom fields in the response appear as long hashes, which can be mapped against the key value of project fields.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of a subscription

ID: get_details_of_a_subscription
Operation: read
Entities: installment, subscription, recurring subscription
Summary: This API endpoint retrieves the details of a specific subscription, which can be an installment or a recurring subscription. The request requires a path parameter 'id', which is the ID of the subscription. The response includes details such as the subscription ID, user ID, deal ID, active status, cycle amount, number of cycles, currency, start and end dates, description, add and update times, lifetime value, cadence type, and final status.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of a task

ID: get_details_of_a_task
Operation: read
Entities: project, creator, task
Summary: This API endpoint retrieves the details of a specific task using its ID. The request requires a path parameter 'id' which is the ID of the task. The response includes details such as the task's title, creator ID, description, status (done or not), due date, parent task ID, assignee ID, timestamps for when the task was added, updated, and marked as done, and the project ID. The response also indicates if the request was successful.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of a template

ID: get_details_of_a_template
Operation: read
Entities: project template
Summary: This API endpoint returns the details of a specific project template. It requires the 'id' path parameter, which is the ID of the project template. The response includes the template's ID, title, description, projects board ID, owner ID, and timestamps for when the template was added and last updated. The response also indicates whether the request was successful.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of an activity

ID: get_details_of_an_activity
Operation: read
Entities: user, activity, organization
Summary: This API endpoint retrieves the details of a specific activity from Pipedrive. It requires the activity ID as a path parameter. The response includes detailed information about the activity such as its type, due date, duration, location, and associated entities like organization, person, and deal. The response also includes related objects such as user, organization, person, and deal details.
Input Fields: Input Fields
Output Fields: Output Fields

Get details of an organization

ID: get_details_of_an_organization
Operation: read
Entities: user, picture, organization
Summary: This API endpoint retrieves the details of a specific organization from Pipedrive. The request requires the organization ID as a path parameter. The response includes detailed information about the organization, such as its ID, name, owner details, deal counts, activity counts, and address. Additional fields are returned that are not present when querying all organizations. Custom fields appear as long hashes, which can be mapped against the key value of organizationFields. The response also includes related objects such as users and pictures.
Input Fields: Input Fields
Output Fields: Output Fields

Download one file

ID: get_download_one_file
Operation: read
Entities: file
Summary: The 'Download one file' API initializes a file download from Pipedrive. It requires a GET request to the endpoint 'https://api.pipedrive.com/v1/files/{id}/download', where '{id}' is a path parameter representing the ID of the file to be downloaded. The 'id' parameter is an integer and is required. The API does not specify any response sample or additional headers, query parameters, or body content.
Input Fields: Input Fields
Output Fields: Output Fields

Find goals

ID: get_find_goals
Operation: read
Entities: type, goal, assignee
Summary: The 'Find goals' API allows users to retrieve data about goals based on specified criteria. Users can search by appending query parameters such as 'type.name', 'title', 'is_active', 'assignee.id', 'assignee.type', 'expected_outcome.target', 'expected_outcome.tracking_metric', 'expected_outcome.currency_id', 'type.params.pipeline_id', 'type.params.stage_id', 'type.params.activity_type_id', 'period.start', and 'period.end' to the URL. The response includes details about the goals such as 'id', 'owner_id', 'title', 'type', 'assignee', 'interval', 'duration', 'expected_outcome', 'is_active', and 'report_ids'.
Input Fields: Input Fields
Output Fields: Output Fields

Find users by name

ID: get_find_users_by_name
Operation: read
Entities: user, access, role
Summary: The 'Find users by name' API allows you to search for users in the Pipedrive system by their name. It requires a search term as a query parameter and optionally allows you to restrict the search to email addresses only by setting the 'search_by_email' parameter. The response includes a list of users that match the search criteria, with detailed information about each user, such as their ID, name, email, phone number, activation status, last login time, and access permissions.
Input Fields: Input Fields
Output Fields: Output Fields

List activities associated with a deal

ID: get_list_activities_associated_with_a_deal
Operation: read
Entities: deal, activity, user
Summary: This API endpoint lists all activities associated with a specific deal in Pipedrive. The request requires the deal ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, 'done' to filter activities based on their completion status, and 'exclude' to omit specific activity IDs from the results. The response includes a success flag, a list of activities with detailed information such as type, due date, location, and participants, as well as additional data on activity distribution and pagination. Related objects like organizations, persons, deals, and users are also included in the response.
Input Fields: Input Fields
Output Fields: Output Fields

List activities associated with a person

ID: get_list_activities_associated_with_a_person
Operation: read
Entities: person, activity, organization
Summary: This API endpoint lists activities associated with a specific person in Pipedrive. It requires the person ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, 'done' to filter activities based on their completion status, and 'exclude' to omit specific activity IDs from the results. The response includes a success flag, a list of activities with detailed information such as activity type, due date, location, and participants, as well as additional data for activity distribution and pagination.
Input Fields: Input Fields
Output Fields: Output Fields

List activities associated with an organization

ID: get_list_activities_associated_with_an_organization
Operation: read
Entities: user, activity, organization
Summary: This API lists activities associated with a specific organization in Pipedrive. It requires the organization ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, 'done' to filter activities based on completion status, and 'exclude' to exclude specific activity IDs. The response includes a success flag, a list of activities with detailed information such as activity type, due date, participants, and more, as well as additional data for activity distribution and pagination.
Input Fields: Input Fields
Output Fields: Output Fields

List all persons associated with a deal

ID: get_list_all_persons_associated_with_a_deal
Operation: read
Entities: person, deal, organization
Summary: This API endpoint lists all persons associated with a specific deal in Pipedrive. It returns details of each person, including their ID, name, email, phone numbers, and associated organization details. The endpoint also provides information about the person's activities, deals, and marketing status. The request requires the deal ID as a path parameter and supports optional query parameters for pagination, such as 'start' and 'limit'. The response includes a success flag, a list of persons, additional pagination data, and related objects like organizations and users.
Input Fields: Input Fields
Output Fields: Output Fields

List deals associated with a person

ID: get_list_deals_associated_with_a_person
Operation: read
Entities: person, deal, organization
Summary: This API endpoint lists all deals associated with a specific person in Pipedrive. The request requires the person's ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, 'status' to filter deals by their status (e.g., open, won, lost, deleted, all_not_deleted), and 'sort' to specify sorting order. The response includes a success flag, a list of deals with detailed information about each deal, additional pagination data, and related objects such as users, organizations, persons, stages, and pipelines.
Input Fields: Input Fields
Output Fields: Output Fields

List deals associated with an organization

ID: get_list_deals_associated_with_an_organization
Operation: read
Entities: person, deal, organization
Summary: This API endpoint lists all deals associated with a specific organization in Pipedrive. The request requires the organization ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, 'status' to filter deals by their status, 'sort' to define sorting order, and 'only_primary_association' to fetch only directly associated deals. The response includes a success flag, an array of deal objects with detailed information about each deal, additional pagination data, and related objects such as users, organizations, persons, stages, and pipelines.
Input Fields: Input Fields
Output Fields: Output Fields

List discounts added to a deal

ID: get_list_discounts_added_to_a_deal
Operation: read
Entities: discount, deal
Summary: This API endpoint lists all discounts attached to a specific deal in the Pipedrive system. The request requires the deal ID as a path parameter. The response includes a success flag and an array of discount objects, each containing details such as the discount ID, description, amount, type, associated deal ID, creation and update timestamps, and the IDs of the users who created and last updated the discount.
Input Fields: Input Fields
Output Fields: Output Fields

List files attached to a deal

ID: get_list_files_attached_to_a_deal
Operation: read
Entities: user, file, deal
Summary: This API endpoint lists all files associated with a specific deal in Pipedrive. The request requires the deal ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, and 'sort' for sorting the results by specified fields. The response includes a success flag, an array of file data associated with the deal, and additional pagination data. Each file object contains details such as file ID, user ID, deal ID, file name, file type, and a URL for downloading the file.
Input Fields: Input Fields
Output Fields: Output Fields

List files attached to a person

ID: get_list_files_attached_to_a_person
Operation: read
Entities: person, file, deal
Summary: This API endpoint lists files associated with a specific person in Pipedrive. It requires the person ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, and 'sort' for sorting the results by specified fields. The response includes a success flag, an array of file data with details such as file ID, user ID, deal ID, file name, type, size, and more, along with pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

List files attached to a product

ID: get_list_files_attached_to_a_product
Operation: read
Entities: pagination, file, product
Summary: This API endpoint lists all files associated with a specific product in Pipedrive. It requires the product ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, and 'sort' for sorting the results by fields such as 'update_time' or 'id'. The response includes a success flag, an array of file objects with details such as file ID, product ID, file name, type, size, and download URL, as well as pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

List files attached to an organization

ID: get_list_files_attached_to_an_organization
Operation: read
Entities: user, file, organization
Summary: This API endpoint lists files associated with a specific organization in Pipedrive. It requires the organization ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, and 'sort' for sorting the results by specified fields. The response includes a success flag, an array of file data with details such as file ID, user ID, organization ID, file name, type, size, and more, along with pagination information indicating if more items are available.
Input Fields: Input Fields
Output Fields: Output Fields

List followers of a deal

ID: get_list_followers_of_a_deal
Operation: read
Entities: follower, deal
Summary: This API endpoint lists the followers of a specific deal in Pipedrive. It requires the deal ID as a path parameter. The response includes a success flag, a list of followers with their user IDs, follower entry IDs, deal IDs, and the time they started following the deal. Additionally, it provides pagination information indicating the start index, limit of items per page, and whether there are more items in the collection.
Input Fields: Input Fields
Output Fields: Output Fields

List followers of a person

ID: get_list_followers_of_a_person
Operation: read
Entities: follower, person
Summary: This API endpoint lists the followers of a person in the Pipedrive system. It requires the ID of the person as a path parameter. The response includes a success flag, a list of followers with details such as user ID, follower ID, deal ID, and the time the follower was added. Additionally, it provides pagination information indicating the start index, limit of items per page, and whether there are more items in the collection.
Input Fields: Input Fields
Output Fields: Output Fields

List followers of a product

ID: get_list_followers_of_a_product
Operation: read
Entities: follower, user, product
Summary: This API endpoint lists the followers of a specific product. It requires the product ID as a path parameter. Optional query parameters include 'start' for pagination start and 'limit' for the number of items shown per page. The response includes a success flag, a list of followers with details such as user ID, follower entry ID, product ID, and the time the follower was added. Additional data includes pagination details.
Input Fields: Input Fields
Output Fields: Output Fields

List followers of a user

ID: get_list_followers_of_a_user
Operation: read
Entities: follower, user
Summary: This API endpoint lists the followers of a specific user in Pipedrive. It requires a GET request to the URL 'https://api.pipedrive.com/v1/users/{id}/followers' with the path parameter 'id', which is the ID of the user whose followers are to be listed. The response includes a 'success' boolean indicating the success of the request and a 'data' array containing the IDs of the followers.
Input Fields: Input Fields
Output Fields: Output Fields

List followers of an organization

ID: get_list_followers_of_an_organization
Operation: read
Entities: follower, organization, user
Summary: This API endpoint lists the followers of a specified organization. It requires the organization ID as a path parameter. The response includes a success flag, an array of follower data with user ID, follower entry ID, organization ID, and the time the follower was added. Additionally, it provides pagination information indicating the start index, limit, whether there are more items, and the next start index.
Input Fields: Input Fields
Output Fields: Output Fields

List mail messages associated with a person

ID: get_list_mail_messages_associated_with_a_person
Operation: read
Entities: mail message, mail thread, person
Summary: This API endpoint lists mail messages associated with a specific person in Pipedrive. It requires the person ID as a path parameter. Optional query parameters include 'start' for pagination start and 'limit' for the number of items shown per page. The response includes a success flag, an array of mail messages with detailed information such as sender, recipient, subject, and timestamps, and additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

List participants of a deal

ID: get_list_participants_of_a_deal
Operation: read
Entities: participant, deal, organization
Summary: The 'List participants of a deal' API endpoint allows users to retrieve a list of participants associated with a specific deal in Pipedrive. The endpoint is accessed via a GET request to 'https://api.pipedrive.com/v1/deals/{id}/participants', where '{id}' is the required path parameter representing the deal ID. Optional query parameters include 'start' for pagination start and 'limit' for the number of items per page. The response includes a 'success' flag, a 'data' array containing participant details such as 'id', 'person_id', 'add_time', and 'related_item_data', as well as 'additional_data' for pagination and 'related_objects' for user, person, and organization details. If the company uses the Campaigns product, the response will also include the 'data.marketing_status' field.
Input Fields: Input Fields
Output Fields: Output Fields

List permission set assignments

ID: get_list_permission_set_assignments
Operation: read
Entities: user, assignment, permission set
Summary: The 'List permission set assignments' API returns the list of assignments for a specified permission set. It requires the 'id' path parameter, which is the ID of the permission set. The API supports optional query parameters 'start' for pagination start and 'limit' for the number of items shown per page. The response includes a 'success' boolean and a 'data' array containing objects with 'user_id', 'permission_set_id', and 'name' of the permission set.
Input Fields: Input Fields
Output Fields: Output Fields

List permitted users

ID: get_list_permitted_users
Operation: read
Entities: person, user
Summary: This API endpoint lists the users who are permitted to access a specific person in the Pipedrive system. It requires the ID of the person as a path parameter. The response includes a success flag and an array of user IDs who have permission to access the specified person.
Input Fields: Input Fields
Output Fields: Output Fields

List permitted users for a deal

ID: get_list_permitted_users_for_a_deal
Operation: read
Entities: user, deal
Summary: This API endpoint lists the users permitted to access a specific deal in Pipedrive. It requires the deal ID as a path parameter. The response includes a success flag and an array of user IDs who have permission to access the specified deal.
Input Fields: Input Fields
Output Fields: Output Fields

List permitted users for a lead

ID: get_list_permitted_users_for_a_lead
Operation: read
Entities: lead, user
Summary: This API endpoint lists the users permitted to access a specific lead in Pipedrive. It requires the lead ID as a path parameter. The response includes a success flag and an array of user IDs who have permission to access the lead.
Input Fields: Input Fields
Output Fields: Output Fields

List permitted users for a product

ID: get_list_permitted_users_for_a_product
Operation: read
Entities: user, product
Summary: This API endpoint lists the users who are permitted to access a specific product in the Pipedrive system. The request requires a path parameter 'id', which is the integer ID of the product. The response includes a success flag and an array of user IDs who have permission to access the product.
Input Fields: Input Fields
Output Fields: Output Fields

List persons of an organization

ID: get_list_persons_of_an_organization
Operation: read
Entities: person, organization, user
Summary: This API endpoint lists all persons associated with a specific organization in Pipedrive. It requires the organization ID as a path parameter. Optionally, pagination can be controlled using 'start' and 'limit' query parameters. The response includes detailed information about each person, such as their name, contact details, deal counts, activity counts, and marketing status. If the organization uses the Campaigns product, the 'marketing_status' field will also be included. The response also provides pagination details and related objects like organization and user information.
Input Fields: Input Fields
Output Fields: Output Fields

List products associated with a person

ID: get_list_products_associated_with_a_person
Operation: read
Entities: person, deal, product
Summary: This API endpoint lists products associated with a specific person in the Pipedrive system. It requires the 'id' of the person as a path parameter. Optional query parameters include 'start' for pagination start and 'limit' for the number of items shown per page. The response includes a success flag, a list of products with associated deal details, and additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

List products attached to a deal

ID: get_list_products_attached_to_a_deal
Operation: read
Entities: deal, product
Summary: This API endpoint lists products attached to a specific deal in Pipedrive. The request requires the deal ID as a path parameter. Optional query parameters include 'cursor' for pagination, 'limit' to specify the number of entries returned (default is 100, maximum is 500), 'sort_by' to determine the field to sort by (default is 'id'), and 'sort_direction' to specify the sorting order (default is 'asc'). The response includes a success flag, an array of product details such as id, sum, tax, deal_id, name, product_id, and more, along with additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

List role assignments

ID: get_list_role_assignments
Operation: read
Entities: user, role assignment, role
Summary: This API endpoint lists role assignments for a specific user. It requires the user ID as a path parameter. Optional query parameters include 'start' for pagination start and 'limit' for the number of items shown per page. The response includes a success flag, a list of role assignments with details such as user ID, role ID, parent role ID, role name, active status, and role type. Additional pagination data is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

List role settings

ID: get_list_role_settings
Operation: read
Entities: setting, role
Summary: The 'List role settings' API returns the visibility settings of a specific role in Pipedrive. It requires the role ID as a path parameter. The response includes the default visibility settings for deals, leads, organizations, persons, and products, indicating the level of visibility assigned to each entity type for the specified role.
Input Fields: Input Fields
Output Fields: Output Fields

List settings of an authorized user

ID: get_list_settings_of_an_authorized_user
Operation: read
Entities: user, setting
Summary: This API endpoint retrieves the settings of an authorized user from Pipedrive. The request requires an authorization header with a bearer token. The response includes various settings such as marketplace team status, list limit, beta app usage, and more. The response body contains a 'success' boolean and a 'data' object with detailed settings information.
Input Fields: Input Fields
Output Fields: Output Fields

List updates about a deal

ID: get_list_updates_about_a_deal
Operation: read
Entities: deal, activity, mail message
Summary: This API endpoint lists updates about a specific deal in Pipedrive. It requires the deal ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, 'all_changes' to include custom field updates, and 'items' to filter specific updates. The response includes a success flag, a list of updates with details such as object type, timestamp, and data, additional pagination data, and related objects information.
Input Fields: Input Fields
Output Fields: Output Fields

List updates about a person

ID: get_list_updates_about_a_person
Operation: read
Entities: person, activity, organization
Summary: The 'List updates about a person' API endpoint retrieves updates related to a specific person in the Pipedrive system. It requires the person's ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, 'all_changes' to include custom field updates, and 'items' to filter specific types of updates. The response includes a success flag, a list of updates with detailed information, additional pagination data, and related objects. If the company uses the Campaigns product, updates for the marketing_status field are also included.
Input Fields: Input Fields
Output Fields: Output Fields

List updates about an organization

ID: get_list_updates_about_an_organization
Operation: read
Entities: file, activity, organization
Summary: This API endpoint lists updates about a specific organization in Pipedrive. It requires the organization ID as a path parameter. Optional query parameters include 'start' for pagination start, 'limit' for the number of items per page, 'all_changes' to include custom field updates, and 'items' to filter specific updates. The response includes a success flag, a list of updates with details such as object type, timestamp, and data, additional pagination data, and related objects information.
Input Fields: Input Fields
Output Fields: Output Fields

List User Permissions

ID: get_list_user_permissions
Operation: read
Entities: user, permission set
Summary: The 'List User Permissions' API endpoint retrieves aggregated permissions for a specified user based on all assigned permission sets. The request requires the user's ID as a path parameter. The response includes a success flag and a data object detailing the user's permissions, such as the ability to add custom fields, bulk edit items, change item visibility, and create their own workflows.
Input Fields: Input Fields
Output Fields: Output Fields

List mail messages associated with a deal

ID: get_mail_messages_associated_with_a_deal
Operation: read
Entities: mail message, deal, person
Summary: This API endpoint lists mail messages associated with a specific deal in Pipedrive. The request requires the deal ID as a path parameter. Optional query parameters include 'start' for pagination start and 'limit' for the number of items shown per page. The response includes a success flag, an array of mail messages with detailed information such as sender and recipient details, subject, timestamps, and flags indicating the status of the mail message. Additional pagination data is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

List mail messages associated with an organization

ID: get_mail_messages_associated_with_organization
Operation: read
Entities: mail message, mail thread, organization
Summary: This API endpoint lists mail messages associated with a specific organization in Pipedrive. It requires the organization ID as a path parameter. Optional query parameters include 'start' for pagination start and 'limit' for the number of items shown per page. The response includes a success flag, an array of mail messages with detailed information such as sender, recipient, subject, and timestamps, and additional pagination data.
Input Fields: Input Fields
Output Fields: Output Fields

Get mail threads

ID: get_mail_threads
Operation: read
Entities: message, mail thread, folder
Summary: The 'Get mail threads' API returns mail threads in a specified folder ordered by the most recent message within. It requires a 'folder' query parameter to specify the type of folder to fetch, which can be 'inbox', 'drafts', 'sent', or 'archive'. Optional query parameters include 'start' for pagination start and 'limit' for the number of items shown per page. The response includes a success flag and an array of mail threads, each containing details such as parties involved, folder information, account and user IDs, subject, snippet, flags for attachments and drafts, timestamps, and deal information.
Input Fields: Input Fields
Output Fields: Output Fields

Get one comment

ID: get_one_comment
Operation: read
Entities: user, comment, note
Summary: The 'Get one comment' API returns the details of a specific comment associated with a note in Pipedrive. It requires two path parameters: 'id', which is the integer ID of the note, and 'commentId', which is the UUID of the comment. The response includes details such as the UUID, active status, timestamps for addition and update, company ID, content of the comment, associated object ID and type, and the IDs of the user who created and last updated the comment.
Input Fields: Input Fields
Output Fields: Output Fields

Get one deal field

ID: get_one_deal_field
Operation: read
Entities: deal field
Summary: The 'Get one deal field' API returns data about a specific deal field in Pipedrive. It requires the 'id' path parameter, which is the ID of the field to be retrieved. The response includes detailed information about the deal field, such as its ID, key, name, order number, field type, and various flags indicating its properties and permissions. The response also includes options available for the field if applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Get one file

ID: get_one_file
Operation: read
Entities: user, file, deal
Summary: The 'Get one file' API endpoint retrieves data about a specific file from Pipedrive. It requires the file ID as a path parameter. The response includes detailed information about the file, such as its ID, user ID, deal ID, person ID, organization ID, product ID, activity ID, lead ID, and other metadata like file name, type, size, and remote location. The response also indicates whether the file is active or inline and provides URLs for accessing the file.
Input Fields: Input Fields
Output Fields: Output Fields

Get one filter

ID: get_one_filter
Operation: read
Entities: condition line, filter
Summary: The 'Get one filter' API endpoint retrieves data about a specific filter identified by its ID. It returns detailed information about the filter, including its name, type, active status, associated user ID, and visibility settings. The request requires a path parameter 'id' which is the ID of the filter. The response includes a success flag and a data object containing the filter details.
Input Fields: Input Fields
Output Fields: Output Fields

Get one lead

ID: get_one_lead
Operation: read
Entities: deal, custom field, lead
Summary: The 'Get one lead' API endpoint retrieves details of a specific lead from Pipedrive. It requires the lead's ID as a path parameter, which must be a UUID. The response includes various details about the lead, such as its title, owner, creator, associated labels, person and organization IDs, source, origin, channel, and value. If the lead contains custom fields, their values will be included in the response. The response also indicates whether the lead is archived or seen, and provides timestamps for when the lead was added and last updated. The visibility and CC email associated with the lead are also returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get one mail message

ID: get_one_mail_message
Operation: read
Entities: account, mail message, user
Summary: The 'Get one mail message' API returns data about a specific mail message identified by its ID. The request requires a path parameter 'id' which is the ID of the mail message to fetch. An optional query parameter 'include_body' can be used to specify whether to include the full message body (1) or not (0). The response includes details about the mail message such as sender, recipient, subject, and various flags indicating the status of the message.
Input Fields: Input Fields
Output Fields: Output Fields

Get one mail thread

ID: get_one_mail_thread
Operation: read
Entities: mail message, party, mail thread
Summary: The 'Get one mail thread' API endpoint allows users to retrieve a specific mail thread by its ID. The request requires a path parameter 'id', which is an integer representing the mail thread's ID. The response includes detailed information about the mail thread, such as the parties involved, folders, account and user IDs, subject, snippet, and various flags indicating the state of the mail thread (e.g., whether it has attachments, is archived, or is shared). The response is structured with a 'success' boolean and a 'data' object containing all relevant mail thread details.
Input Fields: Input Fields
Output Fields: Output Fields

Get one note

ID: get_one_note
Operation: read
Entities: user, deal, note
Summary: The 'Get one note' API returns details about a specific note identified by its ID. The request requires a path parameter 'id', which is the ID of the note. The response includes a success flag and detailed information about the note, such as its content, associated deal, lead, organization, person, and user details. The response also indicates if the note is active and if it is pinned to any entities like lead, deal, organization, or person.
Input Fields: Input Fields
Output Fields: Output Fields

Get one organization field

ID: get_one_organization_field
Operation: read
Entities: organization field
Summary: This API endpoint returns data about a specific organization field in Pipedrive. It requires the field ID as a path parameter. The response includes detailed information about the field such as its ID, key, name, type, and various flags indicating its properties and permissions. The response also includes options available for the field if applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Get one organization relationship

ID: get_one_organization_relationship
Operation: read
Entities: organization relationship, organization
Summary: The 'Get one organization relationship' API retrieves details of a specific organization relationship using its ID. The API requires a path parameter 'id' which is the ID of the organization relationship. Optionally, a query parameter 'org_id' can be provided to specify the base organization for calculated values. The response includes details of the organization relationship, such as the type, owner organization details, linked organization details, and related objects. The response also indicates if the request was successful.
Input Fields: Input Fields
Output Fields: Output Fields

Get one permission set

ID: get_one_permission_set
Operation: read
Entities: user, permission set, permission
Summary: The 'Get one permission set' API returns data about a specific permission set identified by its ID. The request requires a path parameter 'id', which is the ID of the permission set. The response includes details such as the ID, name, description, associated application, assignment count, and a list of permissions included in the set.
Input Fields: Input Fields
Output Fields: Output Fields

Get one person field

ID: get_one_person_field
Operation: read
Entities: person field
Summary: The 'Get one person field' API returns data about a specific person field in the Pipedrive system. It requires the 'id' path parameter, which is an integer representing the ID of the field. The response includes detailed information about the person field, such as its ID, key, name, order number, field type, and various flags indicating its properties and permissions. The response also includes options available for the field if applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Get one pipeline

ID: get_one_pipeline
Operation: read
Entities: deal, stage, pipeline
Summary: The 'Get one pipeline' API returns data about a specific pipeline identified by its ID. It also provides a summary of the deals in this pipeline across its stages. The API requires a path parameter 'id', which is an integer representing the pipeline's ID. The response includes details such as the pipeline's name, order number, deletion status, deal probability status, addition and update times, and selection status.
Input Fields: Input Fields
Output Fields: Output Fields

Get one product

ID: get_one_product
Operation: read
Entities: custom field, price, product
Summary: The 'Get one product' API returns data about a specific product identified by its ID. The API requires a path parameter 'id' which is an integer representing the product ID. The response includes detailed information about the product such as its name, code, description, category, visibility, owner ID, and pricing details. The response also includes metadata like the time the product was added and last updated, billing frequency, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Get one product field

ID: get_one_product_field
Operation: read
Entities: product field
Summary: The 'Get one product field' API returns data about a specific product field in Pipedrive. It requires the 'id' path parameter, which is the ID of the product field to retrieve. The response includes details such as the field's ID, key, name, order number, type, and various flags indicating its properties and permissions. The response also includes options available for the field if applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Get one role

ID: get_one_role
Operation: read
Entities: setting, assignment, role
Summary: The 'Get one role' API endpoint retrieves the details of a specific role in the Pipedrive system. It requires a path parameter 'id', which is the integer ID of the role to be fetched. The response includes a success flag, the role's data such as its ID, parent role ID, name, active status, assignment count, and sub-role count. Additionally, it provides settings for default visibility of deals, leads, organizations, persons, and products.
Input Fields: Input Fields
Output Fields: Output Fields

Get one stage

ID: get_one_stage
Operation: read
Entities: deal, stage, pipeline
Summary: The 'Get one stage' API returns data about a specific stage in Pipedrive. It requires the stage ID as a path parameter. The response includes details such as the stage ID, order number, name, deletion status, deal probability, pipeline ID, deal rotation status, days to rotten, and timestamps for when the stage was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Get one user

ID: get_one_user
Operation: read
Entities: user, access, company
Summary: The 'Get one user' API returns data about a specific user within the company. It requires the user ID as a path parameter. The response includes detailed information about the user such as their name, email, phone number, activation status, last login time, and access permissions. The response also indicates if the user is active, their timezone, role ID, and whether they are the current user or deleted.
Input Fields: Input Fields
Output Fields: Output Fields

List pipeline visibility for a role

ID: get_pipeline_visibility_for_role
Operation: read
Entities: role, pipeline
Summary: This API returns the list of either visible or hidden pipeline IDs for a specific role. The request requires the role ID as a path parameter. An optional query parameter 'visible' can be used to specify whether to return visible or hidden pipelines, with the default being true. The response includes a success flag and a data object containing the list of pipeline IDs and their visibility status.
Input Fields: Input Fields
Output Fields: Output Fields

Returns project activities

ID: get_project_activities
Operation: read
Entities: user, project, activity
Summary: This API returns activities linked to a specific project. It requires the project ID as a path parameter. The response includes a list of activities with details such as activity ID, company ID, user ID, type, due date, and location, among others. The response also includes additional data like the next cursor for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Returns project groups

ID: get_project_groups
Operation: read
Entities: group, project
Summary: This API returns all active groups under a specific project. It requires the project ID as a path parameter. The response includes a success flag, a list of groups with their IDs, names, and order numbers, and any additional data if available.
Input Fields: Input Fields
Output Fields: Output Fields

Get project phases

ID: get_project_phases
Operation: read
Entities: project phase, board
Summary: The 'Get project phases' API returns all active project phases under a specific board. It requires a query parameter 'board_id' which is an integer representing the ID of the board for which phases are requested. The response includes a success flag, a list of project phases with details such as phase ID, name, board ID, order number, add time, and update time, and any additional data if available.
Input Fields: Input Fields
Output Fields: Output Fields

Returns project plan

ID: get_project_plan
Operation: read
Entities: project, activity, task
Summary: This API returns information about items in a project plan. The items consist of tasks and activities and are linked to specific project phases and groups. The API requires a path parameter 'id', which is the ID of the project. The response includes a success flag, a list of items with their IDs, types, phase IDs, and group IDs, and any additional data.
Input Fields: Input Fields
Output Fields: Output Fields

Returns project tasks

ID: get_project_tasks
Operation: read
Entities: task, project, assignee
Summary: This API returns tasks linked to a specific project. It requires the project ID as a path parameter. The response includes details of each task such as task ID, title, creator ID, description, status, due date, parent task ID, assignee ID, and timestamps for when the task was added, updated, and marked as done. Additionally, it provides a cursor for fetching the next set of results.
Input Fields: Input Fields
Output Fields: Output Fields

Get recents

ID: get_recents
Operation: read
Entities: deal, activity, note
Summary: The 'Get recents' API endpoint retrieves data about all recent changes that occurred after a specified timestamp. It requires a 'since_timestamp' query parameter in the format 'YYYY-MM-DD HH:MM:SS' to specify the starting point for changes. Optional query parameters include 'items' to filter the types of items to include, 'start' for pagination start, and 'limit' for the number of items per page. The response includes a 'success' flag, an array of 'data' with details of each change, and 'additional_data' for pagination and timestamp information.
Input Fields: Input Fields
Output Fields: Output Fields

Get result of a goal

ID: get_result_of_a_goal
Operation: read
Entities: progress, goal, result
Summary: The 'Get result of a goal' API retrieves the progress of a specified goal for a given period. It requires the goal ID as a path parameter and the start and end dates of the period as query parameters. The response includes details about the goal, such as its ID, owner, title, type, assignee, interval, duration, expected outcome, and progress. The API returns a success status, status code, status text, and the service that processed the request.
Input Fields: Input Fields
Output Fields: Output Fields

Search deals

ID: get_search_deals
Operation: read
Entities: person, deal, organization
Summary: The 'Search deals' API allows users to search for deals by title, notes, and custom fields. It is a wrapper of the /v1/itemSearch endpoint with a narrower OAuth scope. Users can filter the search results by person ID, organization ID, and deal status. The API supports pagination and allows specifying the fields to search from and include in the results. The response includes the search results with details of each deal, such as ID, title, value, currency, status, owner, stage, person, and organization. Additional data for pagination is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Perform a search from multiple item types

ID: get_search_from_multiple_item_types
Operation: read
Entities: search term, item, field
Summary: This API performs a search across multiple item types and fields in Pipedrive. It requires a search term and allows optional parameters such as item types, fields, and pagination controls. The response includes a list of found items and related items, along with additional data for pagination. The search term must be URL encoded and can be configured for exact matches or to include related items.
Input Fields: Input Fields
Output Fields: Output Fields

Search leads

ID: get_search_leads
Operation: read
Entities: lead, organization, person
Summary: The 'Search leads' API allows users to search for leads by title, notes, and custom fields. It is a wrapper of the /v1/itemSearch endpoint with a narrower OAuth scope. Users can filter the search results by person ID and organization ID. The API supports various query parameters such as 'term' for the search term, 'fields' to specify which fields to search, 'exact_match' for exact term matching, 'person_id' and 'organization_id' for filtering, 'include_fields' for additional fields, 'limit' for pagination, and 'cursor' for pagination markers. The response includes a success flag, data with found items, and additional data for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Search organizations

ID: get_search_organizations
Operation: read
Entities: custom field, note, organization
Summary: The Search organizations API allows users to search for organizations by name, address, notes, and custom fields. It is a GET request to the endpoint https://api.pipedrive.com/api/v2/organizations/search. The API requires a 'term' query parameter for the search term, which must be at least 2 characters long. Optional query parameters include 'fields' to specify which fields to search, 'exact_match' to enable exact matching, 'limit' to set the number of results, and 'cursor' for pagination. The response includes a success flag, a data object with search results, and additional data for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Search persons

ID: get_search_persons
Operation: read
Entities: person, custom field, organization
Summary: The 'Search persons' API allows users to search for persons by name, email, phone, notes, and custom fields. It is a GET request to the endpoint 'https://api.pipedrive.com/api/v2/persons/search'. The API accepts several query parameters: 'term' (required) for the search term, 'fields' to specify which fields to search, 'exact_match' to enable exact matching, 'organization_id' to filter by organization, 'include_fields' to include optional fields, 'limit' for pagination limit, and 'cursor' for pagination cursor. The response includes a success flag, data with search results, and additional data for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Search products

ID: get_search_products
Operation: read
Entities: product, custom field, owner
Summary: The Search products API allows users to search for products by name, code, and custom fields. It is a GET request to the endpoint https://api.pipedrive.com/api/v2/products/search. The API requires a search term as a query parameter and supports additional optional parameters such as fields, exact_match, include_fields, limit, and cursor for pagination. The response includes a success flag, a data object with search results, and additional data for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Perform a search using a specific field from an item type

ID: get_search_using_specific_field
Operation: read
Entities: search, item, field
Summary: This API performs a search from the values of a specific field. It can return either the distinct values of the field, useful for searching autocomplete field values, or the IDs of actual items such as deals, leads, persons, organizations, or products. The API requires query parameters such as 'term' for the search term, 'entity_type' for the type of field, and 'field' for the key of the field to search from. Optional parameters include 'match' for the type of match, 'limit' for pagination, and 'cursor' for the pagination marker. The response includes a success flag, a list of search results with item IDs and names, and additional data for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Find subscription by deal

ID: get_subscription_by_deal
Operation: read
Entities: user, deal, subscription
Summary: The 'Find subscription by deal' API returns details of an installment or a recurring subscription by the deal ID. It requires a path parameter 'dealId' which is an integer representing the ID of the deal. The response includes details such as the subscription ID, user ID, deal ID, active status, cycle amount, number of cycles, currency, start and end dates, description, add and update times, lifetime value, cadence type, and final status.
Input Fields: Input Fields
Output Fields: Output Fields

List updates about deal field values

ID: get_updates_about_deal_field_values
Operation: read
Entities: update, deal, field
Summary: This API endpoint lists updates about field values of a specific deal in Pipedrive. It requires the deal ID as a path parameter. Optional query parameters include 'cursor' for pagination and 'limit' to specify the number of items per page. The response includes a success flag, a list of changes detailing the field key, old and new values, the user who made the change, the time of change, the source of change, and whether it was part of a bulk update. Additional data may include a cursor for the next page of results.
Input Fields: Input Fields
Output Fields: Output Fields

List updates about organization field values

ID: get_updates_about_organization_field_values
Operation: read
Entities: update, organization, field
Summary: This API endpoint lists updates about field values of an organization. It requires the organization ID as a path parameter. Optional query parameters include 'cursor' for pagination and 'limit' to specify the number of items per page. The response includes a success flag, a list of changes with details such as field key, old and new values, actor user ID, time of change, change source, and whether it was a bulk update. Additional data for pagination is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

List updates about participants of a deal

ID: get_updates_about_participants_of_a_deal
Operation: read
Entities: user, deal, participant
Summary: This API endpoint lists updates about participants of a deal. It is a cursor-paginated endpoint, allowing users to retrieve changes made to the participants of a specific deal. The request requires the 'id' path parameter, which is the ID of the deal. Optional query parameters include 'limit' to specify the number of items per page and 'cursor' for pagination purposes. The response includes a success flag, an array of data detailing the actions performed on participants, and additional data containing the next cursor for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

List updates about person field values

ID: get_updates_about_person_field_values
Operation: read
Entities: person, update, field
Summary: This API endpoint lists updates about field values of a person in Pipedrive. It requires the ID of the person as a path parameter. Optional query parameters include 'cursor' for pagination and 'limit' for the number of items per page. The response includes a success flag, a list of updates detailing the field key, old and new values, the user who made the change, the time of change, the source of change, and whether it was part of a bulk update. Additional data for pagination is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

List User Role Settings

ID: get_user_role_settings
Operation: read
Entities: user, setting, role
Summary: The 'List User Role Settings' API endpoint retrieves the settings of a user's assigned role in Pipedrive. It requires the user ID as a path parameter. The response includes the default visibility settings for deals, leads, organizations, persons, and products, indicating the level of access the user has for each entity type. The response body contains a 'success' boolean and a 'data' object with the visibility settings.
Input Fields: Input Fields
Output Fields: Output Fields

Update a deal

ID: patch_update_a_deal
Operation: write
Entities: user, deal, organization
Summary: The 'Update a deal' API allows you to update the properties of a deal in the Pipedrive system. You need to provide the deal ID as a path parameter. The body of the request can include various optional fields such as title, owner_id, person_id, org_id, pipeline_id, stage_id, value, currency, add_time, update_time, stage_change_time, is_deleted, status, probability, lost_reason, visible_to, close_time, won_time, lost_time, expected_close_date, and label_ids. The response returns a success status and the updated deal data, including fields like id, title, creator_user_id, owner_id, value, person_id, org_id, stage_id, pipeline_id, currency, add_time, update_time, stage_change_time, status, is_deleted, probability, lost_reason, visible_to, close_time, won_time, lost_time, local_won_date, local_lost_date, local_close_date, expected_close_date, origin, origin_id, channel, channel_id, acv, arr, mrr, and custom_fields.
Input Fields: Input Fields
Output Fields: Output Fields

Update a lead

ID: patch_update_a_lead
Operation: write
Entities: lead, organization, user
Summary: The 'Update a lead' API allows users to update one or more properties of a lead in Pipedrive. The API endpoint is 'https://api.pipedrive.com/v1/leads/{id}', where 'id' is the required path parameter representing the lead's unique identifier. The request body can include optional parameters such as 'title', 'owner_id', 'label_ids', 'person_id', 'organization_id', 'is_archived', 'value', 'expected_close_date', 'visible_to', 'was_seen', 'channel', and 'channel_id'. The response returns a success status and the updated lead data, including fields like 'id', 'title', 'owner_id', 'label_ids', 'person_id', 'organization_id', 'source_name', 'origin', 'channel', 'is_archived', 'was_seen', 'value', 'expected_close_date', 'next_activity_id', 'add_time', 'update_time', 'visible_to', and 'cc_email'.
Input Fields: Input Fields
Output Fields: Output Fields

Update a discount added to a deal

ID: patch_update_discount_added_to_a_deal
Operation: write
Entities: discount, deal, product
Summary: This API endpoint allows you to edit a discount added to a deal in Pipedrive. It changes the deal value if the deal has one-time products attached. The request requires the deal ID and discount ID as path parameters. The body parameters include 'description' (the name of the discount), 'amount' (the discount amount, which must be a positive number), and 'type' (which determines if the discount is a percentage or a fixed amount). The response returns a success status and the updated discount details, including its ID, description, amount, type, associated deal ID, creation and update timestamps, and the IDs of the users who created and last updated the discount.
Input Fields: Input Fields
Output Fields: Output Fields

Update a lead label

ID: patch_update_lead_label
Operation: write
Entities: lead label
Summary: This API updates one or more properties of a lead label in Pipedrive. The endpoint requires the lead label ID as a path parameter. The request body can include optional parameters such as 'name' and 'color' to update the respective properties of the lead label. The color parameter accepts a limited set of values: green, blue, red, yellow, purple, and gray. The response includes a success flag and the updated lead label details, including its ID, name, color, and timestamps for when it was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Update a pipeline

ID: patch_update_pipeline
Operation: write
Entities: pipeline
Summary: This API updates the properties of a pipeline in Pipedrive. It requires the pipeline ID as a path parameter. The request body can include optional parameters such as 'name' to update the pipeline's name and 'is_deal_probability_enabled' to enable or disable deal probability for the pipeline. The response includes a success flag and the updated pipeline details such as ID, name, order number, and timestamps for when the pipeline was added and last updated.
Input Fields: Input Fields
Output Fields: Output Fields

Updated about 1 month ago