Freshdesk REST API — Contacts

naftiko: 1.0.0-alpha2
info:
  label: Freshdesk REST API — Contacts
  description: 'Freshdesk REST API — Contacts. 9 operations. Lead operation: List all contact fields. Self-contained Naftiko
    capability covering one Freshdesk business surface.'
  tags:
  - Freshdesk
  - Contacts
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHDESK_API_KEY: FRESHDESK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-contacts
    baseUri: https://{domain}.freshdesk.com/api/v2
    description: Freshdesk REST API — Contacts business capability. Self-contained, no shared references.
    resources:
    - name: contact_fields
      path: /contact_fields
      operations:
      - name: listcontactfields
        method: GET
        description: List all contact fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - 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: mobile
          in: query
          type: string
          description: Filter contacts by mobile number.
        - name: company_id
          in: query
          type: integer
          description: Filter contacts by company ID.
        - name: state
          in: query
          type: string
          description: Filter contacts by state.
      - 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-export
      path: /contacts/export
      operations:
      - name: exportcontacts
        method: POST
        description: Export contacts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: contacts-merge
      path: /contacts/merge
      operations:
      - name: mergecontacts
        method: POST
        description: Merge contacts
        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-restore
      path: /contacts/{contact_id}/restore
      operations:
      - name: restorecontact
        method: PUT
        description: Restore a deleted contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.FRESHDESK_USER}}'
      password: '{{env.FRESHDESK_PASS}}'
  exposes:
  - type: rest
    namespace: rest-contacts-rest
    port: 8080
    description: REST adapter for Freshdesk REST API — Contacts. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/contact-fields
      name: contact-fields
      description: REST surface for contact_fields.
      operations:
      - method: GET
        name: listcontactfields
        description: List all contact fields
        call: rest-contacts.listcontactfields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/contacts
      name: contacts
      description: REST surface for contacts.
      operations:
      - method: GET
        name: listcontacts
        description: List all contacts
        call: rest-contacts.listcontacts
        with:
          email: rest.email
          phone: rest.phone
          mobile: rest.mobile
          company_id: rest.company_id
          state: rest.state
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcontact
        description: Create a contact
        call: rest-contacts.createcontact
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/contacts/export
      name: contacts-export
      description: REST surface for contacts-export.
      operations:
      - method: POST
        name: exportcontacts
        description: Export contacts
        call: rest-contacts.exportcontacts
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/contacts/merge
      name: contacts-merge
      description: REST surface for contacts-merge.
      operations:
      - method: POST
        name: mergecontacts
        description: Merge contacts
        call: rest-contacts.mergecontacts
        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: rest-contacts.getcontact
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecontact
        description: Update a contact
        call: rest-contacts.updatecontact
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecontact
        description: Delete a contact
        call: rest-contacts.deletecontact
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/contacts/{contact-id}/restore
      name: contacts-contact-id-restore
      description: REST surface for contacts-contact_id-restore.
      operations:
      - method: PUT
        name: restorecontact
        description: Restore a deleted contact
        call: rest-contacts.restorecontact
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-contacts-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshdesk REST API — Contacts. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-all-contact-fields
      description: List all contact fields
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-contacts.listcontactfields
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-contacts
      description: List all contacts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-contacts.listcontacts
      with:
        email: tools.email
        phone: tools.phone
        mobile: tools.mobile
        company_id: tools.company_id
        state: tools.state
      outputParameters:
      - type: object
        mapping: $.
    - name: create-contact
      description: Create a contact
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-contacts.createcontact
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: export-contacts
      description: Export contacts
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-contacts.exportcontacts
      outputParameters:
      - type: object
        mapping: $.
    - name: merge-contacts
      description: Merge contacts
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-contacts.mergecontacts
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-contact
      description: View a contact
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-contacts.getcontact
      outputParameters:
      - type: object
        mapping: $.
    - name: update-contact
      description: Update a contact
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-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: rest-contacts.deletecontact
      outputParameters:
      - type: object
        mapping: $.
    - name: restore-deleted-contact
      description: Restore a deleted contact
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-contacts.restorecontact
      outputParameters:
      - type: object
        mapping: $.