Pipedrive API v1 — Mailbox

naftiko: 1.0.0-alpha2
info:
  label: Pipedrive API v1 — Mailbox
  description: 'Pipedrive API v1 — Mailbox. 6 operations. Lead operation: Get one mail message. Self-contained Naftiko capability
    covering one Pipedrive business surface.'
  tags:
  - Pipedrive
  - Mailbox
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PIPEDRIVE_API_KEY: PIPEDRIVE_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-mailbox
    baseUri: https://api.pipedrive.com/v1
    description: Pipedrive API v1 — Mailbox business capability. Self-contained, no shared references.
    resources:
    - name: mailbox-mailMessages-id
      path: /mailbox/mailMessages/{id}
      operations:
      - name: getmailmessage
        method: GET
        description: Get one mail message
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the mail message to fetch
          required: true
        - name: include_body
          in: query
          type: number
          description: Whether to include the full message body or not. `0` = Don't include, `1` = Include.
    - name: mailbox-mailThreads
      path: /mailbox/mailThreads
      operations:
      - name: getmailthreads
        method: GET
        description: Get mail threads
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder
          in: query
          type: string
          description: The type of folder to fetch
          required: true
        - name: start
          in: query
          type: integer
          description: Pagination start
        - name: limit
          in: query
          type: integer
          description: Items shown per page
    - name: mailbox-mailThreads-id
      path: /mailbox/mailThreads/{id}
      operations:
      - name: deletemailthread
        method: DELETE
        description: Delete mail thread
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the mail thread
          required: true
      - name: getmailthread
        method: GET
        description: Get one mail thread
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the mail thread
          required: true
      - name: updatemailthreaddetails
        method: PUT
        description: Update mail thread details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the mail thread
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: mailbox-mailThreads-id-mailMessages
      path: /mailbox/mailThreads/{id}/mailMessages
      operations:
      - name: getmailthreadmessages
        method: GET
        description: Get all mail messages of mail thread
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the mail thread
          required: true
    authentication:
      type: bearer
      token: '{{env.PIPEDRIVE_API_KEY}}'
  exposes:
  - type: rest
    namespace: v1-mailbox-rest
    port: 8080
    description: REST adapter for Pipedrive API v1 — Mailbox. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/mailbox/mailmessages/{id}
      name: mailbox-mailmessages-id
      description: REST surface for mailbox-mailMessages-id.
      operations:
      - method: GET
        name: getmailmessage
        description: Get one mail message
        call: v1-mailbox.getmailmessage
        with:
          id: rest.id
          include_body: rest.include_body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/mailbox/mailthreads
      name: mailbox-mailthreads
      description: REST surface for mailbox-mailThreads.
      operations:
      - method: GET
        name: getmailthreads
        description: Get mail threads
        call: v1-mailbox.getmailthreads
        with:
          folder: rest.folder
          start: rest.start
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/mailbox/mailthreads/{id}
      name: mailbox-mailthreads-id
      description: REST surface for mailbox-mailThreads-id.
      operations:
      - method: DELETE
        name: deletemailthread
        description: Delete mail thread
        call: v1-mailbox.deletemailthread
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getmailthread
        description: Get one mail thread
        call: v1-mailbox.getmailthread
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatemailthreaddetails
        description: Update mail thread details
        call: v1-mailbox.updatemailthreaddetails
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/mailbox/mailthreads/{id}/mailmessages
      name: mailbox-mailthreads-id-mailmessages
      description: REST surface for mailbox-mailThreads-id-mailMessages.
      operations:
      - method: GET
        name: getmailthreadmessages
        description: Get all mail messages of mail thread
        call: v1-mailbox.getmailthreadmessages
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-mailbox-mcp
    port: 9090
    transport: http
    description: MCP adapter for Pipedrive API v1 — Mailbox. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-one-mail-message
      description: Get one mail message
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-mailbox.getmailmessage
      with:
        id: tools.id
        include_body: tools.include_body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-mail-threads
      description: Get mail threads
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-mailbox.getmailthreads
      with:
        folder: tools.folder
        start: tools.start
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-mail-thread
      description: Delete mail thread
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-mailbox.deletemailthread
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-one-mail-thread
      description: Get one mail thread
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-mailbox.getmailthread
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-mail-thread-details
      description: Update mail thread details
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-mailbox.updatemailthreaddetails
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-mail-messages-mail
      description: Get all mail messages of mail thread
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-mailbox.getmailthreadmessages
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.