Pipedrive API v2 — PersonFields

naftiko: 1.0.0-alpha2
info:
  label: Pipedrive API v2 — PersonFields
  description: 'Pipedrive API v2 — PersonFields. 8 operations. Lead operation: Get all person fields. Self-contained Naftiko
    capability covering one Pipedrive business surface.'
  tags:
  - Pipedrive
  - PersonFields
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PIPEDRIVE_API_KEY: PIPEDRIVE_API_KEY
capability:
  consumes:
  - type: http
    namespace: v2-personfields
    baseUri: https://api.pipedrive.com/api/v2
    description: Pipedrive API v2 — PersonFields business capability. Self-contained, no shared references.
    resources:
    - name: personFields
      path: /personFields
      operations:
      - name: getpersonfields
        method: GET
        description: Get all person fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: include_fields
          in: query
          type: string
          description: Optional comma separated string array of additional data namespaces to include in response
        - name: limit
          in: query
          type: integer
          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.
        - name: cursor
          in: query
          type: string
          description: For pagination, the marker (an opaque string value) representing the first item on the next page
      - name: addpersonfield
        method: POST
        description: Create one person field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: personFields-field_code
      path: /personFields/{field_code}
      operations:
      - name: getpersonfield
        method: GET
        description: Get one person field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: field_code
          in: path
          type: string
          description: The unique code identifying the field
          required: true
        - name: include_fields
          in: query
          type: string
          description: Optional comma separated string array of additional data namespaces to include in response
      - name: updatepersonfield
        method: PATCH
        description: Update one person field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: field_code
          in: path
          type: string
          description: The unique code identifying the field
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletepersonfield
        method: DELETE
        description: Delete one person field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: field_code
          in: path
          type: string
          description: The unique code identifying the field
          required: true
    - name: personFields-field_code-options
      path: /personFields/{field_code}/options
      operations:
      - name: addpersonfieldoptions
        method: POST
        description: Add person field options in bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: field_code
          in: path
          type: string
          description: The unique code identifying the field
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletepersonfieldoptions
        method: DELETE
        description: Delete person field options in bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: field_code
          in: path
          type: string
          description: The unique code identifying the field
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updatepersonfieldoptions
        method: PATCH
        description: Update person field options in bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: field_code
          in: path
          type: string
          description: The unique code identifying the field
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.PIPEDRIVE_API_KEY}}'
  exposes:
  - type: rest
    namespace: v2-personfields-rest
    port: 8080
    description: REST adapter for Pipedrive API v2 — PersonFields. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/personfields
      name: personfields
      description: REST surface for personFields.
      operations:
      - method: GET
        name: getpersonfields
        description: Get all person fields
        call: v2-personfields.getpersonfields
        with:
          include_fields: rest.include_fields
          limit: rest.limit
          cursor: rest.cursor
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addpersonfield
        description: Create one person field
        call: v2-personfields.addpersonfield
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/personfields/{field-code}
      name: personfields-field-code
      description: REST surface for personFields-field_code.
      operations:
      - method: GET
        name: getpersonfield
        description: Get one person field
        call: v2-personfields.getpersonfield
        with:
          field_code: rest.field_code
          include_fields: rest.include_fields
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatepersonfield
        description: Update one person field
        call: v2-personfields.updatepersonfield
        with:
          field_code: rest.field_code
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletepersonfield
        description: Delete one person field
        call: v2-personfields.deletepersonfield
        with:
          field_code: rest.field_code
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/personfields/{field-code}/options
      name: personfields-field-code-options
      description: REST surface for personFields-field_code-options.
      operations:
      - method: POST
        name: addpersonfieldoptions
        description: Add person field options in bulk
        call: v2-personfields.addpersonfieldoptions
        with:
          field_code: rest.field_code
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletepersonfieldoptions
        description: Delete person field options in bulk
        call: v2-personfields.deletepersonfieldoptions
        with:
          field_code: rest.field_code
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatepersonfieldoptions
        description: Update person field options in bulk
        call: v2-personfields.updatepersonfieldoptions
        with:
          field_code: rest.field_code
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v2-personfields-mcp
    port: 9090
    transport: http
    description: MCP adapter for Pipedrive API v2 — PersonFields. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-all-person-fields
      description: Get all person fields
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v2-personfields.getpersonfields
      with:
        include_fields: tools.include_fields
        limit: tools.limit
        cursor: tools.cursor
      outputParameters:
      - type: object
        mapping: $.
    - name: create-one-person-field
      description: Create one person field
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v2-personfields.addpersonfield
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-one-person-field
      description: Get one person field
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v2-personfields.getpersonfield
      with:
        field_code: tools.field_code
        include_fields: tools.include_fields
      outputParameters:
      - type: object
        mapping: $.
    - name: update-one-person-field
      description: Update one person field
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v2-personfields.updatepersonfield
      with:
        field_code: tools.field_code
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-one-person-field
      description: Delete one person field
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v2-personfields.deletepersonfield
      with:
        field_code: tools.field_code
      outputParameters:
      - type: object
        mapping: $.
    - name: add-person-field-options-bulk
      description: Add person field options in bulk
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v2-personfields.addpersonfieldoptions
      with:
        field_code: tools.field_code
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-person-field-options-bulk
      description: Delete person field options in bulk
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v2-personfields.deletepersonfieldoptions
      with:
        field_code: tools.field_code
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-person-field-options-bulk
      description: Update person field options in bulk
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v2-personfields.updatepersonfieldoptions
      with:
        field_code: tools.field_code
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.