Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

pipedrive-openapi-client

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

pipedrive-openapi-client

1.0.0
Rubygems

Version published: 4 years ago

Maintainers: 1

Created: 4 years ago

Source

Pipedrive OpenAPI Ruby Client

Pipedrive - a Ruby client for Pipedrive's API v1

This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build pipedrive-openapi-client.gemspec

Then either install the gem locally:

gem install ./pipedrive-openapi-client-1.0.0.gem

(for development, run gem install --dev ./pipedrive-openapi-client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'pipedrive-openapi-client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'pipedrive-openapi-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'pipedrive-openapi-client'

# Setup authorization
Pipedrive.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['api_token'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api_token'] = 'Bearer'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = Pipedrive::ActivitiesApi.new
ids = 'ids_example' # String | Comma-separated IDs that will be deleted

begin
  #Delete multiple activities in bulk
  api_instance.activities_delete(ids)
rescue Pipedrive::ApiError => e
  puts "Exception when calling ActivitiesApi->activities_delete: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.pipedrive.com/v1

Class	Method	HTTP request	Description
Pipedrive::ActivitiesApi	activities_delete	DELETE /activities	Delete multiple activities in bulk
Pipedrive::ActivitiesApi	activities_get	GET /activities	Get all activities assigned to a particular user
Pipedrive::ActivitiesApi	activities_id_delete	DELETE /activities/{id}	Delete an activity
Pipedrive::ActivitiesApi	activities_id_get	GET /activities/{id}	Get details of an activity
Pipedrive::ActivitiesApi	activities_id_put	PUT /activities/{id}	Edit an activity
Pipedrive::ActivitiesApi	activities_post	POST /activities	Add an activity
Pipedrive::ActivityFieldsApi	activity_fields_get	GET /activityFields	Get all fields for an activity
Pipedrive::ActivityTypesApi	activity_types_delete	DELETE /activityTypes	Delete multiple activity types in bulk
Pipedrive::ActivityTypesApi	activity_types_get	GET /activityTypes	Get all activity types
Pipedrive::ActivityTypesApi	activity_types_id_delete	DELETE /activityTypes/{id}	Delete an activity type
Pipedrive::ActivityTypesApi	activity_types_id_put	PUT /activityTypes/{id}	Edit activity type
Pipedrive::ActivityTypesApi	activity_types_post	POST /activityTypes	Add new activity type
Pipedrive::CallLogsApi	call_logs_get	GET /callLogs	Get all call logs assigned to a particular user
Pipedrive::CallLogsApi	call_logs_id_delete	DELETE /callLogs/{id}	Delete a call log
Pipedrive::CallLogsApi	call_logs_id_get	GET /callLogs/{id}	Get details of a call log
Pipedrive::CallLogsApi	call_logs_id_recordings_post	POST /callLogs/{id}/recordings	Attach an audio file to the call log
Pipedrive::CallLogsApi	call_logs_post	POST /callLogs	Add a call log
Pipedrive::CurrenciesApi	currencies_get	GET /currencies	Get all supported currencies
Pipedrive::DealFieldsApi	deal_fields_delete	DELETE /dealFields	Delete multiple deal fields in bulk
Pipedrive::DealFieldsApi	deal_fields_get	GET /dealFields	Get all deal fields
Pipedrive::DealFieldsApi	deal_fields_id_delete	DELETE /dealFields/{id}	Delete a deal field
Pipedrive::DealFieldsApi	deal_fields_id_get	GET /dealFields/{id}	Get one deal field
Pipedrive::DealFieldsApi	deal_fields_id_put	PUT /dealFields/{id}	Update a deal field
Pipedrive::DealFieldsApi	deal_fields_post	POST /dealFields	Add a new deal field
Pipedrive::DealsApi	deals_delete	DELETE /deals	Delete multiple deals in bulk
Pipedrive::DealsApi	deals_find_get	GET /deals/find	Find deals by name
Pipedrive::DealsApi	deals_get	GET /deals	Get all deals
Pipedrive::DealsApi	deals_id_activities_get	GET /deals/{id}/activities	List activities associated with a deal
Pipedrive::DealsApi	deals_id_delete	DELETE /deals/{id}	Delete a deal
Pipedrive::DealsApi	deals_id_duplicate_post	POST /deals/{id}/duplicate	Duplicate deal
Pipedrive::DealsApi	deals_id_files_get	GET /deals/{id}/files	List files attached to a deal
Pipedrive::DealsApi	deals_id_flow_get	GET /deals/{id}/flow	List updates about a deal
Pipedrive::DealsApi	deals_id_followers_follower_id_delete	DELETE /deals/{id}/followers/{follower_id}	Delete a follower from a deal
Pipedrive::DealsApi	deals_id_followers_get	GET /deals/{id}/followers	List followers of a deal
Pipedrive::DealsApi	deals_id_followers_post	POST /deals/{id}/followers	Add a follower to a deal
Pipedrive::DealsApi	deals_id_get	GET /deals/{id}	Get details of a deal
Pipedrive::DealsApi	deals_id_mail_messages_get	GET /deals/{id}/mailMessages	List mail messages associated with a deal
Pipedrive::DealsApi	deals_id_merge_put	PUT /deals/{id}/merge	Merge two deals
Pipedrive::DealsApi	deals_id_participants_deal_participant_id_delete	DELETE /deals/{id}/participants/{deal_participant_id}	Delete a participant from a deal
Pipedrive::DealsApi	deals_id_participants_get	GET /deals/{id}/participants	List participants of a deal
Pipedrive::DealsApi	deals_id_participants_post	POST /deals/{id}/participants	Add a participant to a deal
Pipedrive::DealsApi	deals_id_permitted_users_get	GET /deals/{id}/permittedUsers	List permitted users
Pipedrive::DealsApi	deals_id_persons_get	GET /deals/{id}/persons	List all persons associated with a deal
Pipedrive::DealsApi	deals_id_products_get	GET /deals/{id}/products	List products attached to a deal
Pipedrive::DealsApi	deals_id_products_post	POST /deals/{id}/products	Add a product to the deal, eventually creating a new item called a deal-product
Pipedrive::DealsApi	deals_id_products_product_attachment_id_delete	DELETE /deals/{id}/products/{product_attachment_id}	Delete an attached product from a deal
Pipedrive::DealsApi	deals_id_products_product_attachment_id_put	PUT /deals/{id}/products/{product_attachment_id}	Update product attachment details of the deal-product (a product already attached to a deal)
Pipedrive::DealsApi	deals_id_put	PUT /deals/{id}	Update a deal
Pipedrive::DealsApi	deals_post	POST /deals	Add a deal
Pipedrive::DealsApi	deals_search_get	GET /deals/search	Search deals
Pipedrive::DealsApi	deals_summary_get	GET /deals/summary	Get deals summary
Pipedrive::DealsApi	deals_timeline_get	GET /deals/timeline	Get deals timeline
Pipedrive::FilesApi	files_get	GET /files	Get all files
Pipedrive::FilesApi	files_id_delete	DELETE /files/{id}	Delete a file
Pipedrive::FilesApi	files_id_download_get	GET /files/{id}/download	Download one file
Pipedrive::FilesApi	files_id_get	GET /files/{id}	Get one file
Pipedrive::FilesApi	files_id_put	PUT /files/{id}	Update file details
Pipedrive::FilesApi	files_post	POST /files	Add file
Pipedrive::FilesApi	files_remote_link_post	POST /files/remoteLink	Link a remote file to an item
Pipedrive::FilesApi	files_remote_post	POST /files/remote	Create a remote file and link it to an item
Pipedrive::FiltersApi	filters_delete	DELETE /filters	Delete multiple filters in bulk
Pipedrive::FiltersApi	filters_get	GET /filters	Get all filters
Pipedrive::FiltersApi	filters_helpers_get	GET /filters/helpers	Get all filter helpers
Pipedrive::FiltersApi	filters_id_delete	DELETE /filters/{id}	Delete a filter
Pipedrive::FiltersApi	filters_id_get	GET /filters/{id}	Get one filter
Pipedrive::FiltersApi	filters_id_put	PUT /filters/{id}	Update filter
Pipedrive::FiltersApi	filters_post	POST /filters	Add a new filter
Pipedrive::GlobalMessagesApi	global_messages_get	GET /globalMessages	Get global messages
Pipedrive::GlobalMessagesApi	global_messages_id_delete	DELETE /globalMessages/{id}	Dismiss a global message
Pipedrive::GoalsApi	goals_find_get	GET /goals/find	Find goals
Pipedrive::GoalsApi	goals_id_delete	DELETE /goals/{id}	Delete existing goal
Pipedrive::GoalsApi	goals_id_put	PUT /goals/{id}	Update existing goal
Pipedrive::GoalsApi	goals_id_results_get	GET /goals/{id}/results	Get result of a goal
Pipedrive::GoalsApi	goals_post	POST /goals	Add a new goal
Pipedrive::ItemSearchApi	item_search_field_get	GET /itemSearch/field	Perform a search using a specific field from an item type
Pipedrive::ItemSearchApi	item_search_get	GET /itemSearch	Perform a search from multiple item types
Pipedrive::LeadsApi	lead_labels_get	GET /leadLabels	Get all lead labels
Pipedrive::LeadsApi	lead_labels_id_delete	DELETE /leadLabels/{id}	Delete a lead label
Pipedrive::LeadsApi	lead_labels_id_get	GET /leadLabels/{id}	Get one lead label
Pipedrive::LeadsApi	lead_labels_id_patch	PATCH /leadLabels/{id}	Update a lead label
Pipedrive::LeadsApi	lead_labels_post	POST /leadLabels	Add a lead label
Pipedrive::LeadsApi	lead_sources_get	GET /leadSources	Get all lead sources
Pipedrive::LeadsApi	leads_get	GET /leads	Get all leads
Pipedrive::LeadsApi	leads_id_delete	DELETE /leads/{id}	Delete a lead
Pipedrive::LeadsApi	leads_id_get	GET /leads/{id}	Get one lead
Pipedrive::LeadsApi	leads_id_patch	PATCH /leads/{id}	Update a lead
Pipedrive::LeadsApi	leads_post	POST /leads	Add a lead
Pipedrive::MailMessagesApi	mailbox_mail_messages_id_get	GET /mailbox/mailMessages/{id}	Get one mail message
Pipedrive::MailThreadsApi	mailbox_mail_threads_get	GET /mailbox/mailThreads	Get mail threads
Pipedrive::MailThreadsApi	mailbox_mail_threads_id_delete	DELETE /mailbox/mailThreads/{id}	Delete mail thread
Pipedrive::MailThreadsApi	mailbox_mail_threads_id_get	GET /mailbox/mailThreads/{id}	Get one mail thread
Pipedrive::MailThreadsApi	mailbox_mail_threads_id_mail_messages_get	GET /mailbox/mailThreads/{id}/mailMessages	Get all mail messages of mail thread
Pipedrive::MailThreadsApi	mailbox_mail_threads_id_put	PUT /mailbox/mailThreads/{id}	Update mail thread details
Pipedrive::NoteFieldsApi	note_fields_get	GET /noteFields	Get all fields for a note
Pipedrive::NotesApi	notes_get	GET /notes	Get all notes
Pipedrive::NotesApi	notes_id_delete	DELETE /notes/{id}	Delete a note
Pipedrive::NotesApi	notes_id_get	GET /notes/{id}	Get one note
Pipedrive::NotesApi	notes_id_put	PUT /notes/{id}	Update a note
Pipedrive::NotesApi	notes_post	POST /notes	Add a note
Pipedrive::OrganizationFieldsApi	organization_fields_delete	DELETE /organizationFields	Delete multiple organization fields in bulk
Pipedrive::OrganizationFieldsApi	organization_fields_get	GET /organizationFields	Get all organization fields
Pipedrive::OrganizationFieldsApi	organization_fields_id_delete	DELETE /organizationFields/{id}	Delete an organization field
Pipedrive::OrganizationFieldsApi	organization_fields_id_get	GET /organizationFields/{id}	Get one organization field
Pipedrive::OrganizationFieldsApi	organization_fields_id_put	PUT /organizationFields/{id}	Update an organization field
Pipedrive::OrganizationFieldsApi	organization_fields_post	POST /organizationFields	Add a new organization field
Pipedrive::OrganizationRelationshipsApi	organization_relationships_get	GET /organizationRelationships	Get all relationships for organization
Pipedrive::OrganizationRelationshipsApi	organization_relationships_id_delete	DELETE /organizationRelationships/{id}	Delete an organization relationship
Pipedrive::OrganizationRelationshipsApi	organization_relationships_id_get	GET /organizationRelationships/{id}	Get one organization relationship
Pipedrive::OrganizationRelationshipsApi	organization_relationships_id_put	PUT /organizationRelationships/{id}	Update an organization relationship
Pipedrive::OrganizationRelationshipsApi	organization_relationships_post	POST /organizationRelationships	Create an organization relationship
Pipedrive::OrganizationsApi	organizations_delete	DELETE /organizations	Delete multiple organizations in bulk
Pipedrive::OrganizationsApi	organizations_find_get	GET /organizations/find	Find organizations by name
Pipedrive::OrganizationsApi	organizations_get	GET /organizations	Get all organizations
Pipedrive::OrganizationsApi	organizations_id_activities_get	GET /organizations/{id}/activities	List activities associated with an organization
Pipedrive::OrganizationsApi	organizations_id_deals_get	GET /organizations/{id}/deals	List deals associated with an organization
Pipedrive::OrganizationsApi	organizations_id_delete	DELETE /organizations/{id}	Delete an organization
Pipedrive::OrganizationsApi	organizations_id_files_get	GET /organizations/{id}/files	List files attached to an organization
Pipedrive::OrganizationsApi	organizations_id_flow_get	GET /organizations/{id}/flow	List updates about an organization
Pipedrive::OrganizationsApi	organizations_id_followers_follower_id_delete	DELETE /organizations/{id}/followers/{follower_id}	Delete a follower from an organization
Pipedrive::OrganizationsApi	organizations_id_followers_get	GET /organizations/{id}/followers	List followers of an organization
Pipedrive::OrganizationsApi	organizations_id_followers_post	POST /organizations/{id}/followers	Add a follower to an organization
Pipedrive::OrganizationsApi	organizations_id_get	GET /organizations/{id}	Get details of an organization
Pipedrive::OrganizationsApi	organizations_id_mail_messages_get	GET /organizations/{id}/mailMessages	List mail messages associated with an organization
Pipedrive::OrganizationsApi	organizations_id_merge_put	PUT /organizations/{id}/merge	Merge two organizations
Pipedrive::OrganizationsApi	organizations_id_permitted_users_get	GET /organizations/{id}/permittedUsers	List permitted users
Pipedrive::OrganizationsApi	organizations_id_persons_get	GET /organizations/{id}/persons	List persons of an organization
Pipedrive::OrganizationsApi	organizations_id_put	PUT /organizations/{id}	Update an organization
Pipedrive::OrganizationsApi	organizations_post	POST /organizations	Add an organization
Pipedrive::OrganizationsApi	organizations_search_get	GET /organizations/search	Search organizations
Pipedrive::PermissionSetsApi	permission_sets_get	GET /permissionSets	Get all Permission Sets
Pipedrive::PermissionSetsApi	permission_sets_id_assignments_get	GET /permissionSets/{id}/assignments	List Permission Set assignments
Pipedrive::PermissionSetsApi	permission_sets_id_get	GET /permissionSets/{id}	Get one Permission Set
Pipedrive::PersonFieldsApi	person_fields_delete	DELETE /personFields	Delete multiple person fields in bulk
Pipedrive::PersonFieldsApi	person_fields_get	GET /personFields	Get all person fields
Pipedrive::PersonFieldsApi	person_fields_id_delete	DELETE /personFields/{id}	Delete a person field
Pipedrive::PersonFieldsApi	person_fields_id_get	GET /personFields/{id}	Get one person field
Pipedrive::PersonFieldsApi	person_fields_id_put	PUT /personFields/{id}	Update a person field
Pipedrive::PersonFieldsApi	person_fields_post	POST /personFields	Add a new person field
Pipedrive::PersonsApi	persons_delete	DELETE /persons	Delete multiple persons in bulk
Pipedrive::PersonsApi	persons_find_get	GET /persons/find	Find persons by name
Pipedrive::PersonsApi	persons_get	GET /persons	Get all persons
Pipedrive::PersonsApi	persons_id_activities_get	GET /persons/{id}/activities	List activities associated with a person
Pipedrive::PersonsApi	persons_id_deals_get	GET /persons/{id}/deals	List deals associated with a person
Pipedrive::PersonsApi	persons_id_delete	DELETE /persons/{id}	Delete a person
Pipedrive::PersonsApi	persons_id_files_get	GET /persons/{id}/files	List files attached to a person
Pipedrive::PersonsApi	persons_id_flow_get	GET /persons/{id}/flow	List updates about a person
Pipedrive::PersonsApi	persons_id_followers_follower_id_delete	DELETE /persons/{id}/followers/{follower_id}	Deletes a follower from a person.
Pipedrive::PersonsApi	persons_id_followers_get	GET /persons/{id}/followers	List followers of a person
Pipedrive::PersonsApi	persons_id_followers_post	POST /persons/{id}/followers	Add a follower to a person
Pipedrive::PersonsApi	persons_id_get	GET /persons/{id}	Get details of a person
Pipedrive::PersonsApi	persons_id_mail_messages_get	GET /persons/{id}/mailMessages	List mail messages associated with a person
Pipedrive::PersonsApi	persons_id_merge_put	PUT /persons/{id}/merge	Merge two persons
Pipedrive::PersonsApi	persons_id_permitted_users_get	GET /persons/{id}/permittedUsers	List permitted users
Pipedrive::PersonsApi	persons_id_picture_delete	DELETE /persons/{id}/picture	Delete person picture
Pipedrive::PersonsApi	persons_id_picture_post	POST /persons/{id}/picture	Add person picture
Pipedrive::PersonsApi	persons_id_products_get	GET /persons/{id}/products	List products associated with a person
Pipedrive::PersonsApi	persons_id_put	PUT /persons/{id}	Update a person
Pipedrive::PersonsApi	persons_post	POST /persons	Add a person
Pipedrive::PersonsApi	persons_search_get	GET /persons/search	Search persons
Pipedrive::PipelinesApi	pipelines_get	GET /pipelines	Get all pipelines
Pipedrive::PipelinesApi	pipelines_id_conversion_statistics_get	GET /pipelines/{id}/conversion_statistics	Get deals conversion rates in pipeline
Pipedrive::PipelinesApi	pipelines_id_deals_get	GET /pipelines/{id}/deals	Get deals in a pipeline
Pipedrive::PipelinesApi	pipelines_id_delete	DELETE /pipelines/{id}	Delete a pipeline
Pipedrive::PipelinesApi	pipelines_id_get	GET /pipelines/{id}	Get one pipeline
Pipedrive::PipelinesApi	pipelines_id_movement_statistics_get	GET /pipelines/{id}/movement_statistics	Get deals movements in pipeline
Pipedrive::PipelinesApi	pipelines_id_put	PUT /pipelines/{id}	Edit a pipeline
Pipedrive::PipelinesApi	pipelines_post	POST /pipelines	Add a new pipeline
Pipedrive::ProductFieldsApi	product_fields_delete	DELETE /productFields	Delete multiple product fields in bulk
Pipedrive::ProductFieldsApi	product_fields_get	GET /productFields	Get all product fields
Pipedrive::ProductFieldsApi	product_fields_id_delete	DELETE /productFields/{id}	Delete a product field
Pipedrive::ProductFieldsApi	product_fields_id_get	GET /productFields/{id}	Get one product field
Pipedrive::ProductFieldsApi	product_fields_id_put	PUT /productFields/{id}	Update a product field
Pipedrive::ProductFieldsApi	product_fields_post	POST /productFields	Add a new product field
Pipedrive::ProductsApi	products_find_get	GET /products/find	Find products by name
Pipedrive::ProductsApi	products_get	GET /products	Get all products
Pipedrive::ProductsApi	products_id_deals_get	GET /products/{id}/deals	Get deals where a product is attached to
Pipedrive::ProductsApi	products_id_delete	DELETE /products/{id}	Delete a product
Pipedrive::ProductsApi	products_id_files_get	GET /products/{id}/files	List files attached to a product
Pipedrive::ProductsApi	products_id_followers_follower_id_delete	DELETE /products/{id}/followers/{follower_id}	Delete a follower from a product
Pipedrive::ProductsApi	products_id_followers_get	GET /products/{id}/followers	List followers of a product
Pipedrive::ProductsApi	products_id_followers_post	POST /products/{id}/followers	Add a follower to a product
Pipedrive::ProductsApi	products_id_get	GET /products/{id}	Get one product
Pipedrive::ProductsApi	products_id_permitted_users_get	GET /products/{id}/permittedUsers	List permitted users
Pipedrive::ProductsApi	products_id_put	PUT /products/{id}	Update a product
Pipedrive::ProductsApi	products_post	POST /products	Add a product
Pipedrive::ProductsApi	products_search_get	GET /products/search	Search products
Pipedrive::RecentsApi	recents_get	GET /recents	Get recents
Pipedrive::RolesApi	roles_get	GET /roles	Get all roles
Pipedrive::RolesApi	roles_id_assignments_delete	DELETE /roles/{id}/assignments	Delete a role assignment
Pipedrive::RolesApi	roles_id_assignments_get	GET /roles/{id}/assignments	List role assignments
Pipedrive::RolesApi	roles_id_assignments_post	POST /roles/{id}/assignments	Add role assignment
Pipedrive::RolesApi	roles_id_delete	DELETE /roles/{id}	Delete a role
Pipedrive::RolesApi	roles_id_get	GET /roles/{id}	Get one role
Pipedrive::RolesApi	roles_id_put	PUT /roles/{id}	Update role details
Pipedrive::RolesApi	roles_id_roles_get	GET /roles/{id}/roles	List role sub-roles
Pipedrive::RolesApi	roles_id_settings_get	GET /roles/{id}/settings	List role settings
Pipedrive::RolesApi	roles_id_settings_post	POST /roles/{id}/settings	Add or update role setting
Pipedrive::RolesApi	roles_post	POST /roles	Add a role
Pipedrive::SearchResultsApi	search_results_field_get	GET /searchResults/field	Perform a search using a specific field value
Pipedrive::SearchResultsApi	search_results_get	GET /searchResults	Perform a search
Pipedrive::StagesApi	stages_delete	DELETE /stages	Delete multiple stages in bulk
Pipedrive::StagesApi	stages_get	GET /stages	Get all stages
Pipedrive::StagesApi	stages_id_deals_get	GET /stages/{id}/deals	Get deals in a stage
Pipedrive::StagesApi	stages_id_delete	DELETE /stages/{id}	Delete a stage
Pipedrive::StagesApi	stages_id_get	GET /stages/{id}	Get one stage
Pipedrive::StagesApi	stages_id_put	PUT /stages/{id}	Update stage details
Pipedrive::StagesApi	stages_post	POST /stages	Add a new stage
Pipedrive::TeamsApi	teams_get	GET /teams	Get all teams
Pipedrive::TeamsApi	teams_id_get	GET /teams/{id}	Get a single team
Pipedrive::TeamsApi	teams_id_put	PUT /teams/{id}	Update a team
Pipedrive::TeamsApi	teams_id_users_delete	DELETE /teams/{id}/users	Delete users from a team
Pipedrive::TeamsApi	teams_id_users_get	GET /teams/{id}/users	Get all users in a team
Pipedrive::TeamsApi	teams_id_users_post	POST /teams/{id}/users	Add users to a team
Pipedrive::TeamsApi	teams_post	POST /teams	Add a new team
Pipedrive::TeamsApi	teams_user_id_get	GET /teams/user/{id}	Get all teams of a user
Pipedrive::UserConnectionsApi	user_connections_get	GET /userConnections	Get all user connections
Pipedrive::UserSettingsApi	user_settings_get	GET /userSettings	List settings of an authorized user
Pipedrive::UsersApi	users_find_get	GET /users/find	Find users by name
Pipedrive::UsersApi	users_get	GET /users	Get all users
Pipedrive::UsersApi	users_id_blacklisted_emails_get	GET /users/{id}/blacklistedEmails	List blacklisted email addresses of a user
Pipedrive::UsersApi	users_id_blacklisted_emails_post	POST /users/{id}/blacklistedEmails	Add blacklisted email address for a user
Pipedrive::UsersApi	users_id_followers_get	GET /users/{id}/followers	List followers of a user
Pipedrive::UsersApi	users_id_get	GET /users/{id}	Get one user
Pipedrive::UsersApi	users_id_permissions_get	GET /users/{id}/permissions	List user permissions
Pipedrive::UsersApi	users_id_put	PUT /users/{id}	Update user details
Pipedrive::UsersApi	users_id_role_assignments_delete	DELETE /users/{id}/roleAssignments	Delete a role assignment
Pipedrive::UsersApi	users_id_role_assignments_get	GET /users/{id}/roleAssignments	List role assignments
Pipedrive::UsersApi	users_id_role_assignments_post	POST /users/{id}/roleAssignments	Add role assignment
Pipedrive::UsersApi	users_id_role_settings_get	GET /users/{id}/roleSettings	List user role settings
Pipedrive::UsersApi	users_me_get	GET /users/me	Get current user data
Pipedrive::UsersApi	users_post	POST /users	Add a new user
Pipedrive::WebhooksApi	webhooks_get	GET /webhooks	Get all webhooks
Pipedrive::WebhooksApi	webhooks_id_delete	DELETE /webhooks/{id}	Delete existing webhook
Pipedrive::WebhooksApi	webhooks_post	POST /webhooks	Create a new webhook

Documentation for Models

Documentation for Authorization

api_key

Type: API key
API key parameter name: api_token
Location: URL query string

oauth2

Type: OAuth
Flow: accessCode
Authorization URL: https://oauth.pipedrive.com/oauth/authorize
Scopes:
- deals:read: Read most data about deals and related entities.
- deals:full: Create, read, update and delete deals, its participants and followers.
- activities:read: Read activities, its fields and types; all files and filters.
- activities:full: Create, read, update and delete activities and all files and filters.
- contacts:read: Read data about persons and organizations, their related fields and followers.
- contacts:full: Create, read, update and delete persons and organizations and their followers.
- admin: Allows to do many things that an administrator can do in a Pipedrive company account.
- recents:read: Read all recent changes occured in an account.
- search:read: Search across the account for deals, persons, organizations, files and products and see details about the returned results.
- mail:read: Read mail threads and messages.
- mail:full: Read, update and delete mail threads. Also grants read access to mail messages.
- products:read: Read products, its fields, files, followers and products connected to a deal.
- products:full: Create, read, update and delete products and its fields; add products to deals
- users:read: Read data about users (people with access to a Pipedrive account), their permissions, roles and followers, as well as about teams.
- base: Read settings of the authorized user and currencies in an account.
- phone-integration: Create, read and delete call logs and its audio recordings.

FAQs

What is pipedrive-openapi-client?

Is pipedrive-openapi-client well maintained?

Package last updated on 16 Jul 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install