openapi: 3.0.1
info:
title: Pipedrive API v1 Activities UserSettings API
version: 1.0.0
description: 'Activities are appointments/tasks/events on a calendar that can be associated with a deal, a lead, a person and an organization. Activities can be of different type (such as call, meeting, lunch or a custom type - see ActivityTypes object) and can be assigned to a particular user. Note that activities can also be created without a specific date/time.
'
servers:
- url: https://api.pipedrive.com/v1
tags:
- name: UserSettings
description: 'View user settings.
'
paths:
/userSettings:
get:
summary: List settings of an authorized user
description: Lists the settings of an authorized user. Example response contains a shortened list of settings.
x-token-cost: 2
operationId: getUserSettings
tags:
- UserSettings
security:
- api_key: []
- oauth2:
- base
responses:
'200':
description: The list of user settings
content:
application/json:
schema:
title: GetUserSettingsResponse
allOf:
- title: baseResponse
type: object
properties:
success:
type: boolean
description: If the response is successful or not
- type: object
title: GetUserSettingsResponseData
properties:
data:
type: object
title: UserSettingsItem
properties:
marketplace_team:
type: boolean
description: If the vendors are allowed to be part of the Marketplace team or not
list_limit:
type: number
description: The number of results shown in list by default
beta_app:
type: boolean
description: Whether beta app is enabled
prevent_salesphone_callto_override:
type: boolean
description: Prevent salesphone call to override
file_upload_destination:
type: string
description: The destination of file upload
callto_link_syntax:
type: string
description: The call to link syntax
autofill_deal_expected_close_date:
type: boolean
description: Whether the expected close date of the deal is filled automatically or not
person_duplicate_condition:
type: string
description: Allow the vendors to duplicate a person
example:
success: true
data:
marketplace_team: false
list_limit: 100
beta_app: true
prevent_salesphone_callto_override: false
file_upload_destination: s3
callto_link_syntax: callto:[number]
autofill_deal_expected_close_date: false
person_duplicate_condition: name && (org_id || email || phone)
'401':
description: Unauthorized response
content:
application/json:
schema:
title: unathorizedResponse
type: object
properties:
success:
type: boolean
description: If the response is successful or not
error:
type: string
description: The error message
errorCode:
type: integer
description: The response error code
example:
success: false
error: unauthorized access
errorCode: 401
components:
securitySchemes:
basic_authentication:
type: http
scheme: basic
description: Base 64 encoded string containing the `client_id` and `client_secret` values. The header value should be `Basic <base64(client_id:client_secret)>`.
api_key:
type: apiKey
name: x-api-token
in: header
oauth2:
type: oauth2
description: For more information, see https://pipedrive.readme.io/docs/marketplace-oauth-authorization
flows:
authorizationCode:
authorizationUrl: https://oauth.pipedrive.com/oauth/authorize
tokenUrl: https://oauth.pipedrive.com/oauth/token
refreshUrl: https://oauth.pipedrive.com/oauth/token
scopes:
base: Read settings of the authorized user and currencies in an account
deals:read: Read most of the data about deals and related entities - deal fields, products, followers, participants; all notes, files, filters, pipelines, stages, and statistics. Does not include access to activities (except the last and next activity related to a deal)
deals:full: Create, read, update and delete deals, its participants and followers; all files, notes, and filters. It also includes read access to deal fields, pipelines, stages, and statistics. Does not include access to activities (except the last and next activity related to a deal)
mail:read: Read mail threads and messages
mail:full: Read, update and delete mail threads. Also grants read access to mail messages
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. Also includes read access to activity fields and types
contacts:read: Read the data about persons and organizations, their related fields and followers; also all notes, files, filters
contacts:full: Create, read, update and delete persons and organizations and their followers; all notes, files, filters. Also grants read access to contacts-related fields
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
deal-fields:full: Create, read, update and delete deal fields
product-fields:full: Create, read, update and delete product fields
contact-fields:full: Create, read, update and delete person and organization fields
projects:read: Read projects and its fields, tasks and project templates
projects:full: Create, read, update and delete projects and its fields; add projects templates and project related tasks
users:read: Read data about users (people with access to a Pipedrive account), their permissions, roles and followers
recents:read: Read all recent changes occurred in an account. Includes data about activities, activity types, deals, files, filters, notes, persons, organizations, pipelines, stages, products and users
search:read: Search across the account for deals, persons, organizations, files and products, and see details about the returned results
admin: Allows to do many things that an administrator can do in a Pipedrive company account - create, read, update and delete pipelines and its stages; deal, person and organization fields; activity types; users and permissions, etc. It also allows the app to create webhooks and fetch and delete webhooks that are created by the app
leads:read: Read data about leads and lead labels
leads:full: Create, read, update and delete leads and lead labels
phone-integration: Enables advanced call integration features like logging call duration and other metadata, and play call recordings inside Pipedrive
goals:read: Read data on all goals
goals:full: Create, read, update and delete goals
video-calls: Allows application to register as a video call integration provider and create conference links
messengers-integration: Allows application to register as a messengers integration provider and allows them to deliver incoming messages and their statuses