Freshworks Freshdesk API — Contacts

naftiko: 1.0.0-alpha2
info:
  label: Freshworks Freshdesk API — Contacts
  description: 'Freshworks Freshdesk API — Contacts. 6 operations. Lead operation: List all contacts. Self-contained Naftiko
    capability covering one Freshworks business surface.'
  tags:
  - Freshworks
  - Contacts
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHWORKS_API_KEY: FRESHWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: freshdesk-contacts
    baseUri: https://{domain}.freshdesk.com/api/v2
    description: Freshworks Freshdesk API — Contacts business capability. Self-contained, no shared references.
    resources:
    - name: contacts
      path: /contacts
      operations:
      - name: listcontacts
        method: GET
        description: List all contacts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: email
          in: query
          type: string
          description: Filter contacts by email address.
        - name: phone
          in: query
          type: string
          description: Filter contacts by phone number.
        - name: company_id
          in: query
          type: integer
          description: Filter contacts by company ID.
      - name: createcontact
        method: POST
        description: Create a contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: contacts-contact_id
      path: /contacts/{contact_id}
      operations:
      - name: getcontact
        method: GET
        description: View a contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecontact
        method: PUT
        description: Update a contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecontact
        method: DELETE
        description: Delete a contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: contacts-contact_id-merge
      path: /contacts/{contact_id}/merge
      operations:
      - name: mergecontacts
        method: PUT
        description: Merge contacts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.FRESHWORKS_USER}}'
      password: '{{env.FRESHWORKS_PASS}}'
  exposes:
  - type: rest
    namespace: freshdesk-contacts-rest
    port: 8080
    description: REST adapter for Freshworks Freshdesk API — Contacts. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/contacts
      name: contacts
      description: REST surface for contacts.
      operations:
      - method: GET
        name: listcontacts
        description: List all contacts
        call: freshdesk-contacts.listcontacts
        with:
          email: rest.email
          phone: rest.phone
          company_id: rest.company_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcontact
        description: Create a contact
        call: freshdesk-contacts.createcontact
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/contacts/{contact-id}
      name: contacts-contact-id
      description: REST surface for contacts-contact_id.
      operations:
      - method: GET
        name: getcontact
        description: View a contact
        call: freshdesk-contacts.getcontact
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecontact
        description: Update a contact
        call: freshdesk-contacts.updatecontact
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecontact
        description: Delete a contact
        call: freshdesk-contacts.deletecontact
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/contacts/{contact-id}/merge
      name: contacts-contact-id-merge
      description: REST surface for contacts-contact_id-merge.
      operations:
      - method: PUT
        name: mergecontacts
        description: Merge contacts
        call: freshdesk-contacts.mergecontacts
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: freshdesk-contacts-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshworks Freshdesk API — Contacts. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-contacts
      description: List all contacts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshdesk-contacts.listcontacts
      with:
        email: tools.email
        phone: tools.phone
        company_id: tools.company_id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-contact
      description: Create a contact
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: freshdesk-contacts.createcontact
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-contact
      description: View a contact
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshdesk-contacts.getcontact
      outputParameters:
      - type: object
        mapping: $.
    - name: update-contact
      description: Update a contact
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: freshdesk-contacts.updatecontact
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-contact
      description: Delete a contact
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: freshdesk-contacts.deletecontact
      outputParameters:
      - type: object
        mapping: $.
    - name: merge-contacts
      description: Merge contacts
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: freshdesk-contacts.mergecontacts
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.