Pipedrive
Pipedrive Beta API

Beta endpoints are endpoints that may have changes without a regular 60-90 day notice period.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.1
info:
  title: Pipedrive API v1 Activities Beta 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: Beta
  description: 'Beta endpoints are endpoints that may have changes without a regular 60-90 day notice period.

    '
paths:
  /projectFields:
    get:
      summary: Get all project fields
      description: Returns metadata about all project fields in the company.
      x-token-cost: 10
      operationId: getProjectFields
      tags:
      - Beta
      security:
      - api_key: []
      - oauth2:
        - projects:read
        - projects:full
        - project-fields:full
      parameters:
      - in: query
        name: limit
        description: For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
        schema:
          type: integer
          example: 100
      - in: query
        name: cursor
        required: false
        schema:
          type: string
        description: For pagination, the marker (an opaque string value) representing the first item on the next page
      responses:
        '200':
          description: Get all project fields
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether the request was successful
                  data:
                    type: array
                    items:
                      type: object
                      required:
                      - field_name
                      - field_code
                      - field_type
                      - is_custom_field
                      - is_optional_response_field
                      properties:
                        field_name:
                          type: string
                          description: The display name/label of the field
                        field_code:
                          type: string
                          description: The unique identifier for the field (40-character hash for custom fields)
                        field_type:
                          type: string
                          description: The type of the field
                          enum:
                          - int
                          - double
                          - boolean
                          - varchar
                          - text
                          - phone
                          - varchar_options
                          - varchar_auto
                          - date
                          - daterange
                          - time
                          - timerange
                          - enum
                          - set
                          - address
                          - monetary
                          - deal
                          - deals
                          - lead
                          - org
                          - people
                          - project
                          - stage
                          - user
                          - activity
                          - json
                          - picture
                          - status
                          - visible_to
                          - price_list
                          - billing_frequency
                          - projects_board
                          - projects_phase
                        options:
                          type: array
                          nullable: true
                          description: Array of available options for enum/set fields, null for other field types
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                description: The option ID
                              label:
                                type: string
                                description: The option display label
                              color:
                                type: string
                                nullable: true
                                description: Optional color code for the option
                              update_time:
                                type: string
                                format: date-time
                                nullable: true
                                description: When the option was last updated
                              add_time:
                                type: string
                                format: date-time
                                nullable: true
                                description: When the option was created
                        subfields:
                          type: array
                          nullable: true
                          description: Array of subfields for complex field types (address, monetary), null for simple field types
                          items:
                            type: object
                            properties:
                              field_code:
                                type: string
                                description: The subfield identifier
                              field_name:
                                type: string
                                description: The subfield display name
                              field_type:
                                type: string
                                description: The subfield type
                        is_custom_field:
                          type: boolean
                          description: Whether this is a user-created custom field
                        is_optional_response_field:
                          type: boolean
                          description: Whether this field is not returned by default in entity responses
                        ui_visibility:
                          type: object
                          description: UI visibility settings (only included when requested via include_fields parameter)
                          properties:
                            add_visible_flag:
                              type: boolean
                              description: Whether the field is shown in the add modal
                            details_visible_flag:
                              type: boolean
                              description: Whether the field is shown in the details view
                        important_fields:
                          type: object
                          description: Important fields configuration
                          properties:
                            enabled:
                              type: boolean
                              description: Whether the field is marked as important
                            stage_ids:
                              type: array
                              items:
                                type: integer
                              description: Array of deal stage IDs where the field is important
                        required_fields:
                          type: object
                          description: Required fields configuration
                          properties:
                            enabled:
                              type: boolean
                              description: Whether the field is required
                  additional_data:
                    type: object
                    properties:
                      next_cursor:
                        type: string
                        nullable: true
                        description: Base64url-encoded cursor for fetching the next page of results, null if no more pages
              example:
                success: true
                data:
                - field_name: Project Name
                  field_code: name
                  field_type: varchar
                  options: null
                  subfields: null
                  is_custom_field: false
                  is_optional_response_field: false
                  ui_visibility:
                    add_visible_flag: true
                    details_visible_flag: true
                  important_fields:
                    enabled: false
                    stage_ids: []
                  required_fields:
                    enabled: true
                - field_name: Category
                  field_code: 40characterhashforcustomfieldidentifier
                  field_type: enum
                  options:
                  - id: 1
                    label: Internal
                  - id: 2
                    label: External
                  - id: 3
                    label: Research
                  subfields: null
                  is_custom_field: true
                  is_optional_response_field: false
                  ui_visibility:
                    add_visible_flag: true
                    details_visible_flag: true
                  important_fields:
                    enabled: false
                    stage_ids: []
                  required_fields:
                    enabled: false
                additional_data:
                  next_cursor: eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ
    post:
      summary: Create one project field
      description: Creates a new project custom field.
      x-token-cost: 5
      operationId: addProjectField
      tags:
      - Beta
      security:
      - api_key: []
      - oauth2:
        - project-fields:full
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - field_name
              - field_type
              properties:
                field_name:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: Field name
                field_type:
                  type: string
                  description: The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field</dd></table>
                  enum:
                  - varchar
                  - text
                  - double
                  - phone
                  - date
                  - daterange
                  - time
                  - timerange
                  - set
                  - enum
                  - varchar_auto
                  - address
                  - monetary
                  - org
                  - people
                  - user
                options:
                  type: array
                  description: Field options (required for enum and set field types)
                  items:
                    type: object
                    required:
                    - label
                    properties:
                      label:
                        type: string
                        description: The option label
                ui_visibility:
                  type: object
                  description: UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.
                  additionalProperties: true
                  properties:
                    add_visible_flag:
                      type: boolean
                      description: Whether the field is shown in the add project modal. Default is false.
                      default: false
                    details_visible_flag:
                      type: boolean
                      description: Whether the field is shown in the project details view. Default is true.
                      default: true
                important_fields:
                  type: object
                  description: Configuration for highlighting the field at specific stages.
                  additionalProperties: true
                  properties:
                    enabled:
                      type: boolean
                      description: Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false.
                      default: false
                    stage_ids:
                      type: array
                      items:
                        type: integer
                      description: Array of deal stage IDs where this project field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false.
                      default: []
                required_fields:
                  type: object
                  description: Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.
                  additionalProperties: true
                  properties:
                    enabled:
                      type: boolean
                      description: Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating projects. Default is false.
                      default: false
      responses:
        '200':
          description: Create one project field
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether the request was successful
                  data:
                    type: object
                    required:
                    - field_name
                    - field_code
                    - field_type
                    - is_custom_field
                    - is_optional_response_field
                    properties:
                      field_name:
                        type: string
                        description: The display name/label of the field
                      field_code:
                        type: string
                        description: The unique identifier for the field (40-character hash for custom fields)
                      field_type:
                        type: string
                        description: The type of the field
                        enum:
                        - int
                        - double
                        - boolean
                        - varchar
                        - text
                        - phone
                        - varchar_options
                        - varchar_auto
                        - date
                        - daterange
                        - time
                        - timerange
                        - enum
                        - set
                        - address
                        - monetary
                        - deal
                        - deals
                        - lead
                        - org
                        - people
                        - project
                        - stage
                        - user
                        - activity
                        - json
                        - picture
                        - status
                        - visible_to
                        - price_list
                        - billing_frequency
                        - projects_board
                        - projects_phase
                      options:
                        type: array
                        nullable: true
                        description: Array of available options for enum/set fields, null for other field types
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: The option ID
                            label:
                              type: string
                              description: The option display label
                            color:
                              type: string
                              nullable: true
                              description: Optional color code for the option
                            update_time:
                              type: string
                              format: date-time
                              nullable: true
                              description: When the option was last updated
                            add_time:
                              type: string
                              format: date-time
                              nullable: true
                              description: When the option was created
                      subfields:
                        type: array
                        nullable: true
                        description: Array of subfields for complex field types (address, monetary), null for simple field types
                        items:
                          type: object
                          properties:
                            field_code:
                              type: string
                              description: The subfield identifier
                            field_name:
                              type: string
                              description: The subfield display name
                            field_type:
                              type: string
                              description: The subfield type
                      is_custom_field:
                        type: boolean
                        description: Whether this is a user-created custom field
                      is_optional_response_field:
                        type: boolean
                        description: Whether this field is not returned by default in entity responses
                      ui_visibility:
                        type: object
                        description: UI visibility settings (only included when requested via include_fields parameter)
                        properties:
                          add_visible_flag:
                            type: boolean
                            description: Whether the field is shown in the add modal
                          details_visible_flag:
                            type: boolean
                            description: Whether the field is shown in the details view
                      important_fields:
                        type: object
                        description: Important fields configuration
                        properties:
                          enabled:
                            type: boolean
                            description: Whether the field is marked as important
                          stage_ids:
                            type: array
                            items:
                              type: integer
                            description: Array of deal stage IDs where the field is important
                      required_fields:
                        type: object
                        description: Required fields configuration
                        properties:
                          enabled:
                            type: boolean
                            description: Whether the field is required
              example:
                success: true
                data:
                  field_name: Category
                  field_code: 946947d1b02fd3ef20798d6112ec5d895a686a21
                  field_type: enum
                  options:
                  - id: 1
                    label: Internal
                  - id: 2
                    label: External
                  - id: 3
                    label: Research
                  subfields: null
                  is_custom_field: true
                  is_optional_response_field: false
                  ui_visibility:
                    add_visible_flag: true
                    details_visible_flag: true
                  important_fields:
                    enabled: false
                    stage_ids: []
                  required_fields:
                    enabled: false
  /projectFields/{field_code}:
    get:
      summary: Get one project field
      description: Returns metadata about a specific project field.
      x-token-cost: 1
      operationId: getProjectField
      tags:
      - Beta
      security:
      - api_key: []
      - oauth2:
        - projects:read
        - projects:full
        - project-fields:full
      parameters:
      - in: path
        name: field_code
        description: The unique code identifying the field
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Get one project field
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether the request was successful
                  data:
                    type: object
                    required:
                    - field_name
                    - field_code
                    - field_type
                    - is_custom_field
                    - is_optional_response_field
                    properties:
                      field_name:
                        type: string
                        description: The display name/label of the field
                      field_code:
                        type: string
                        description: The unique identifier for the field (40-character hash for custom fields)
                      field_type:
                        type: string
                        description: The type of the field
                        enum:
                        - int
                        - double
                        - boolean
                        - varchar
                        - text
                        - phone
                        - varchar_options
                        - varchar_auto
                        - date
                        - daterange
                        - time
                        - timerange
                        - enum
                        - set
                        - address
                        - monetary
                        - deal
                        - deals
                        - lead
                        - org
                        - people
                        - project
                        - stage
                        - user
                        - activity
                        - json
                        - picture
                        - status
                        - visible_to
                        - price_list
                        - billing_frequency
                        - projects_board
                        - projects_phase
                      options:
                        type: array
                        nullable: true
                        description: Array of available options for enum/set fields, null for other field types
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: The option ID
                            label:
                              type: string
                              description: The option display label
                            color:
                              type: string
                              nullable: true
                              description: Optional color code for the option
                            update_time:
                              type: string
                              format: date-time
                              nullable: true
                              description: When the option was last updated
                            add_time:
                              type: string
                              format: date-time
                              nullable: true
                              description: When the option was created
                      subfields:
                        type: array
                        nullable: true
                        description: Array of subfields for complex field types (address, monetary), null for simple field types
                        items:
                          type: object
                          properties:
                            field_code:
                              type: string
                              description: The subfield identifier
                            field_name:
                              type: string
                              description: The subfield display name
                            field_type:
                              type: string
                              description: The subfield type
                      is_custom_field:
                        type: boolean
                        description: Whether this is a user-created custom field
                      is_optional_response_field:
                        type: boolean
                        description: Whether this field is not returned by default in entity responses
                      ui_visibility:
                        type: object
                        description: UI visibility settings (only included when requested via include_fields parameter)
                        properties:
                          add_visible_flag:
                            type: boolean
                            description: Whether the field is shown in the add modal
                          details_visible_flag:
                            type: boolean
                            description: Whether the field is shown in the details view
                      important_fields:
                        type: object
                        description: Important fields configuration
                        properties:
                          enabled:
                            type: boolean
                            description: Whether the field is marked as important
                          stage_ids:
                            type: array
                            items:
                              type: integer
                            description: Array of deal stage IDs where the field is important
                      required_fields:
                        type: object
                        description: Required fields configuration
                        properties:
                          enabled:
                            type: boolean
                            description: Whether the field is required
              example:
                success: true
                data:
                  field_name: Project Name
                  field_code: name
                  field_type: varchar
                  options: null
                  subfields: null
                  is_custom_field: false
                  is_optional_response_field: false
                  ui_visibility:
                    add_visible_flag: true
                    details_visible_flag: true
                  important_fields:
                    enabled: false
                    stage_ids: []
                  required_fields:
                    enabled: true
    patch:
      summary: Update one project field
      description: Updates a project custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
      x-token-cost: 5
      operationId: updateProjectField
      tags:
      - Beta
      security:
      - api_key: []
      - oauth2:
        - project-fields:full
      parameters:
      - in: path
        name: field_code
        description: The unique code identifying the field
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              minProperties: 1
              properties:
                field_name:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: Field name
                ui_visibility:
                  type: object
                  description: UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.
                  additionalProperties: true
                  properties:
                    add_visible_flag:
                      type: boolean
                      description: Whether the field is shown in the add project modal. Default is false.
                      default: false
                    details_visible_flag:
                      type: boolean
                      description: Whether the field is shown in the project details view. Default is true.
                      default: true
                important_fields:
                  type: object
                  description: Configuration for highlighting the field at specific stages.
                  additionalProperties: true
                  properties:
                    enabled:
                      type: boolean
                      description: Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false.
                      default: false
                    stage_ids:
                      type: array
                      items:
                        type: integer
                      description: Array of deal stage IDs where this project field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false.
                      default: []
                required_fields:
                  type: object
                  description: Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.
                  additionalProperties: true
                  properties:
                    enabled:
                      type: boolean
                      description: Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating projects. Default is false.
                      default: false
      responses:
        '200':
          desc

# --- truncated at 32 KB (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pipedrive/refs/heads/main/openapi/pipedrive-beta-api-openapi.yml
Pipedrive Beta API

Documentation

Specifications

Other Resources

OpenAPI Specification
