Pipedrive Users API

openapi: 3.0.1
info:
  title: Pipedrive API v1 Activities Users 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: Users
  description: 'Users are people with access to your Pipedrive account. A user may belong to one or many Pipedrive accounts, so deleting a user from one Pipedrive account will not remove the user from the data store if he/she is connected to multiple accounts. Users should not be confused with persons.

    '
paths:
  /users:
    get:
      summary: Get all users
      description: Returns data about all users within the company.
      x-token-cost: 20
      operationId: getUsers
      tags:
      - Users
      security:
      - api_key: []
      - oauth2:
        - users:read
      responses:
        '200':
          description: The list of user objects
          content:
            application/json:
              schema:
                title: GetUsersResponse
                allOf:
                - title: baseResponse
                  type: object
                  properties:
                    success:
                      type: boolean
                      description: If the response is successful or not
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        title: BaseUser
                        properties:
                          id:
                            type: integer
                            description: The user ID
                          name:
                            type: string
                            description: The user name
                          default_currency:
                            type: string
                            description: The user default currency
                          locale:
                            type: string
                            description: The user locale
                          lang:
                            type: integer
                            description: The user language ID
                          email:
                            type: string
                            description: The user email
                          phone:
                            type: string
                            nullable: true
                            description: The user phone
                          activated:
                            type: boolean
                            description: Boolean that indicates whether the user is activated
                          last_login:
                            type: string
                            description: 'The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                          created:
                            type: string
                            description: 'The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                          modified:
                            type: string
                            nullable: true
                            description: 'The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                          has_created_company:
                            type: boolean
                            description: Boolean that indicates whether the user has created a company
                          access:
                            type: array
                            items:
                              type: object
                              title: UserAccess
                              properties:
                                app:
                                  type: string
                                  enum:
                                  - global
                                  - sales
                                  - campaigns
                                  - projects
                                  - account_settings
                                  - partnership
                                  description: The granular app access level
                                admin:
                                  type: boolean
                                  description: Whether the user has admin access or not
                                permission_set_id:
                                  type: string
                                  description: The ID of the permission set
                          active_flag:
                            type: boolean
                            description: Boolean that indicates whether the user is activated
                          timezone_name:
                            type: string
                            description: The user timezone name
                          timezone_offset:
                            type: string
                            description: The user timezone offset
                          role_id:
                            type: integer
                            description: The ID of the user role
                          icon_url:
                            type: string
                            nullable: true
                            description: The user icon URL
                          is_you:
                            type: boolean
                            description: Boolean that indicates if the requested user is the same which is logged in (in this case, always true)
                          is_deleted:
                            type: boolean
                            description: Boolean that indicates whether the user is deleted from the company
              example:
                success: true
                data:
                - id: 1
                  name: John Doe
                  default_currency: EUR
                  locale: et_EE
                  lang: 1
                  email: john@pipedrive.com
                  phone: 0000-0001
                  activated: true
                  last_login: '2019-11-21 08:45:56'
                  created: '2018-11-13 09:16:26'
                  modified: '2019-11-21 08:45:56'
                  has_created_company: true
                  access:
                  - app: sales
                    admin: true
                    permission_set_id: 62cc4d7f-4038-4352-abf3-a8c1c822b631
                  - app: global
                    admin: true
                    permission_set_id: 233b7976-39bd-43a9-b305-ef3a2b0998e5
                  - app: account_settings
                    admin: true
                    permission_set_id: 982c5ce5-b8ba-4b47-b102-9da024f4b990
                  active_flag: true
                  timezone_name: Europe/Berlin
                  timezone_offset: +03:00
                  role_id: 1
                  icon_url: https://upload.wikimedia.org/wikipedia/en/thumb/e/e0/WPVG_icon_2016.svg/1024px-WPVG_icon_2016.svg.png
                  is_you: true
                  is_deleted: false
                - id: 2
                  name: Jane Doe
                  default_currency: EUR
                  locale: et_EE
                  lang: 1
                  email: jane@pipedrive.com
                  phone: 0000-0002
                  activated: true
                  last_login: '2019-09-11 11:43:54'
                  created: '2019-01-22 10:43:47'
                  modified: '2019-11-21 09:49:50'
                  has_created_company: false
                  access:
                  - app: sales
                    admin: false
                    permission_set_id: f07d229d-088a-4144-a40f-1fe64295d180
                  - app: global
                    admin: true
                    permission_set_id: 233b7976-39bd-43a9-b305-ef3a2b0998e5
                  active_flag: true
                  timezone_name: Europe/Berlin
                  timezone_offset: +03:00
                  role_id: 1
                  icon_url: null
                  is_you: false
                  is_deleted: false
    post:
      summary: Add a new user
      description: Adds a new user to the company, returns the ID upon success.
      x-token-cost: 10
      operationId: addUser
      tags:
      - Users
      security:
      - api_key: []
      - oauth2:
        - admin
      requestBody:
        content:
          application/json:
            schema:
              title: addUserRequest
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                  description: The email of the user
                access:
                  type: array
                  items:
                    type: object
                    title: UserAccess
                    properties:
                      app:
                        type: string
                        enum:
                        - global
                        - sales
                        - campaigns
                        - projects
                        - account_settings
                        - partnership
                        description: The granular app access level
                      admin:
                        type: boolean
                        description: Whether the user has admin access or not
                      permission_set_id:
                        type: string
                        description: The ID of the permission set
                    required:
                    - app
                  description: 'The access given to the user. Each item in the array represents access to a specific app. Optionally may include either admin flag or permission set ID to specify which access to give within the app. If both are omitted, the default access for the corresponding app will be used. It requires structure as follows: `[{ app: ''sales'', permission_set_id: ''62cc4d7f-4038-4352-abf3-a8c1c822b631'' }, { app: ''global'', admin: true }, { app: ''account_settings'' }]`

                    '
                  default:
                  - app: sales
                active_flag:
                  type: boolean
                  default: true
                  description: Whether the user is active or not. `false` = Not activated, `true` = Activated
      responses:
        '200':
          description: The data of the user
          content:
            application/json:
              schema:
                title: GetUserResponse
                allOf:
                - title: baseResponse
                  type: object
                  properties:
                    success:
                      type: boolean
                      description: If the response is successful or not
                - type: object
                  title: GetUserResponseData
                  properties:
                    data:
                      type: object
                      title: BaseUser
                      properties:
                        id:
                          type: integer
                          description: The user ID
                        name:
                          type: string
                          description: The user name
                        default_currency:
                          type: string
                          description: The user default currency
                        locale:
                          type: string
                          description: The user locale
                        lang:
                          type: integer
                          description: The user language ID
                        email:
                          type: string
                          description: The user email
                        phone:
                          type: string
                          nullable: true
                          description: The user phone
                        activated:
                          type: boolean
                          description: Boolean that indicates whether the user is activated
                        last_login:
                          type: string
                          description: 'The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                        created:
                          type: string
                          description: 'The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                        modified:
                          type: string
                          nullable: true
                          description: 'The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                        has_created_company:
                          type: boolean
                          description: Boolean that indicates whether the user has created a company
                        access:
                          type: array
                          items:
                            type: object
                            title: UserAccess
                            properties:
                              app:
                                type: string
                                enum:
                                - global
                                - sales
                                - campaigns
                                - projects
                                - account_settings
                                - partnership
                                description: The granular app access level
                              admin:
                                type: boolean
                                description: Whether the user has admin access or not
                              permission_set_id:
                                type: string
                                description: The ID of the permission set
                        active_flag:
                          type: boolean
                          description: Boolean that indicates whether the user is activated
                        timezone_name:
                          type: string
                          description: The user timezone name
                        timezone_offset:
                          type: string
                          description: The user timezone offset
                        role_id:
                          type: integer
                          description: The ID of the user role
                        icon_url:
                          type: string
                          nullable: true
                          description: The user icon URL
                        is_you:
                          type: boolean
                          description: Boolean that indicates if the requested user is the same which is logged in (in this case, always true)
                        is_deleted:
                          type: boolean
                          description: Boolean that indicates whether the user is deleted from the company
              example:
                success: true
                data:
                  id: 2
                  name: Jane Doe
                  default_currency: EUR
                  locale: et_EE
                  lang: 1
                  email: jane@pipedrive.com
                  phone: 0000-0002
                  activated: true
                  last_login: '2019-09-11 11:43:54'
                  created: '2019-01-22 10:43:47'
                  modified: '2019-11-21 09:49:50'
                  has_created_company: false
                  access:
                  - app: sales
                    admin: false
                    permission_set_id: f07d229d-088a-4144-a40f-1fe64295d180
                  - app: global
                    admin: true
                    permission_set_id: 233b7976-39bd-43a9-b305-ef3a2b0998e5
                  active_flag: true
                  timezone_name: Europe/Berlin
                  timezone_offset: +03:00
                  role_id: 1
                  icon_url: null
                  is_you: false
                  is_deleted: false
        '403':
          description: Forbidden response
          content:
            application/json:
              schema:
                title: failResponse
                type: object
                properties:
                  success:
                    type: boolean
                    description: If the response is successful or not
                  error:
                    type: string
                    description: The error message
              example:
                success: false
                error: You do not have permissions to do this.
                error_info: Please check developers.pipedrive.com
                data: null
                additional_data: null
  /users/find:
    get:
      summary: Find users by name
      description: Finds users by their name.
      x-token-cost: 40
      operationId: findUsersByName
      tags:
      - Users
      security:
      - api_key: []
      - oauth2:
        - users:read
      parameters:
      - in: query
        name: term
        required: true
        schema:
          type: string
        description: The search term to look for
      - in: query
        name: search_by_email
        schema:
          title: numberBooleanDefault0
          type: number
          default: 0
          enum:
          - 0
          - 1
        description: 'When enabled, the term will only be matched against email addresses of users. Default: `false`.'
      responses:
        '200':
          description: The list of user objects
          content:
            application/json:
              schema:
                title: GetUsersResponse
                allOf:
                - title: baseResponse
                  type: object
                  properties:
                    success:
                      type: boolean
                      description: If the response is successful or not
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        title: BaseUser
                        properties:
                          id:
                            type: integer
                            description: The user ID
                          name:
                            type: string
                            description: The user name
                          default_currency:
                            type: string
                            description: The user default currency
                          locale:
                            type: string
                            description: The user locale
                          lang:
                            type: integer
                            description: The user language ID
                          email:
                            type: string
                            description: The user email
                          phone:
                            type: string
                            nullable: true
                            description: The user phone
                          activated:
                            type: boolean
                            description: Boolean that indicates whether the user is activated
                          last_login:
                            type: string
                            description: 'The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                          created:
                            type: string
                            description: 'The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                          modified:
                            type: string
                            nullable: true
                            description: 'The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                          has_created_company:
                            type: boolean
                            description: Boolean that indicates whether the user has created a company
                          access:
                            type: array
                            items:
                              type: object
                              title: UserAccess
                              properties:
                                app:
                                  type: string
                                  enum:
                                  - global
                                  - sales
                                  - campaigns
                                  - projects
                                  - account_settings
                                  - partnership
                                  description: The granular app access level
                                admin:
                                  type: boolean
                                  description: Whether the user has admin access or not
                                permission_set_id:
                                  type: string
                                  description: The ID of the permission set
                          active_flag:
                            type: boolean
                            description: Boolean that indicates whether the user is activated
                          timezone_name:
                            type: string
                            description: The user timezone name
                          timezone_offset:
                            type: string
                            description: The user timezone offset
                          role_id:
                            type: integer
                            description: The ID of the user role
                          icon_url:
                            type: string
                            nullable: true
                            description: The user icon URL
                          is_you:
                            type: boolean
                            description: Boolean that indicates if the requested user is the same which is logged in (in this case, always true)
                          is_deleted:
                            type: boolean
                            description: Boolean that indicates whether the user is deleted from the company
              example:
                success: true
                data:
                - id: 1
                  name: John Doe
                  default_currency: EUR
                  locale: et_EE
                  lang: 1
                  email: john@pipedrive.com
                  phone: 0000-0001
                  activated: true
                  last_login: '2019-11-21 08:45:56'
                  created: '2018-11-13 09:16:26'
                  modified: '2019-11-21 08:45:56'
                  has_created_company: true
                  access:
                  - app: sales
                    admin: true
                    permission_set_id: 62cc4d7f-4038-4352-abf3-a8c1c822b631
                  - app: global
                    admin: true
                    permission_set_id: 233b7976-39bd-43a9-b305-ef3a2b0998e5
                  - app: account_settings
                    admin: true
                    permission_set_id: 982c5ce5-b8ba-4b47-b102-9da024f4b990
                  active_flag: true
                  timezone_name: Europe/Berlin
                  timezone_offset: +03:00
                  role_id: 1
                  icon_url: https://upload.wikimedia.org/wikipedia/en/thumb/e/e0/WPVG_icon_2016.svg/1024px-WPVG_icon_2016.svg.png
                  is_you: true
                  is_deleted: false
                - id: 2
                  name: Jane Doe
                  default_currency: EUR
                  locale: et_EE
                  lang: 1
                  email: jane@pipedrive.com
                  phone: 0000-0002
                  activated: true
                  last_login: '2019-09-11 11:43:54'
                  created: '2019-01-22 10:43:47'
                  modified: '2019-11-21 09:49:50'
                  has_created_company: false
                  access:
                  - app: sales
                    admin: false
                    permission_set_id: f07d229d-088a-4144-a40f-1fe64295d180
                  - app: global
                    admin: true
                    permission_set_id: 233b7976-39bd-43a9-b305-ef3a2b0998e5
                  active_flag: true
                  timezone_name: Europe/Berlin
                  timezone_offset: +03:00
                  role_id: 1
                  icon_url: null
                  is_you: false
                  is_deleted: false
  /users/me:
    get:
      summary: Get current user data
      description: 'Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the `locale` property means ''Date/number format'' in the Pipedrive account settings, not the chosen language.'
      x-token-cost: 2
      operationId: getCurrentUser
      tags:
      - Users
      security:
      - api_key: []
      - oauth2:
        - base
      responses:
        '200':
          description: The data of the logged in user
          content:
            application/json:
              schema:
                title: GetCurrentUserResponse
                allOf:
                - title: baseResponse
                  type: object
                  properties:
                    success:
                      type: boolean
                      description: If the response is successful or not
                - type: object
                  properties:
                    data:
                      allOf:
                      - type: object
                        title: BaseUser
                        properties:
                          id:
                            type: integer
                            description: The user ID
                          name:
                            type: string
                            description: The user name
                          default_currency:
                            type: string
                            description: The user default currency
                          locale:
                            type: string
                            description: The user locale
                          lang:
                            type: integer
                            description: The user language ID
                          email:
                            type: string
                            description: The user email
                          phone:
                            type: string
                            nullable: true
                            description: The user phone
                          activated:
                            type: boolean
                            description: Boolean that indicates whether the user is activated
                          last_login:
                            type: string
                            description: 'The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                          created:
                            type: string
                            description: 'The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                          modified:
                            type: string
                            nullable: true
                            description: 'The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS'
                          has_created_company:
                            type: boolean
                            description: Boolean that indicates whether the user has created a company
                          access:
                            type: array
                            items:
                              type: object
                              title: UserAccess
                              properties:
                                app:
                                  type: string
                                  enum:
                                  - global
                                  - sales
                                  - campaigns
                                  - projects
                                  - account_settings
                                  - partnership
                                  description: The granular app access level
                                admin:
                                  type: boolean
                                  description: Whether the user has admin access or not
                                permission_set_id:
                                  type: string
                                  description: The ID of the permission set
                          active_flag:
                            type: boolean
                            description: Boolean that indicates whether the user is activated
                          timezone_name:
                            type: string
                            description: The user timezone name
                          timezone_offset:
                            type: string
                            description: The user timezone offset
                          role_id:
                            type: integer
                            description: The ID of the user role
                          icon_url:
                            type: string
                            nullable: true
                            description: The user icon URL
                          is_you:
                            type: boolean
                            description: Boolean that indicates if the requested user is the same which is logged in (in this case, always true)
                          is_deleted:
                            type: boolean
                            description: Boolean that indicates whether the user is deleted from the company
                      - type: object
                        properties:
                          company_id:
                            type: integer
                            description: The user company ID
                          company_name:
                            type: string
                            description: The user company name
                          company_domain:
                            type: string
                            description: The user company domain
                          company_country:
                            type: string
                            description: The user company country
                          company_industry:
                            type: string
                            description: The user company industry
                          language:
                            type: object
                            description: The user language details
                            properties:
                              language_code:
                                type: string
                                description: The language code. E.g. en
                              country_code:
                                type: string
                                description: The country code. E.g. US
              example:
                success: true
                data:
                  id: 1
                  name: Me
                  default_currency: EUR
                  locale: et_EE
                  lang: 1
                  email: me@pipedrive.com
                  phone: 0000-0000
                  activated: true
                  last_login: '2019-11-21 08:45:56'
                  created: '2018-11-13 09:16:26'
                  modified: '2019-11-21 08:45:56'
                  has_created_company: true
                  access:
                  - app: sales
                    admin: true
                    permission_set_id: 62cc4d7f-4038-4352-abf3-a8c1c822b631
                  - app: global
                    admin: t

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pipedrive/refs/heads/main/openapi/pipedrive-users-api-openapi.yml