Freshworks Freshsales API — Contacts

naftiko: 1.0.0-alpha2
info:
  label: Freshworks Freshsales API — Contacts
  description: 'Freshworks Freshsales API — Contacts. 5 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: freshsales-contacts
    baseUri: https://{domain}.myfreshworks.com/crm/sales/api
    description: Freshworks Freshsales 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: filter
          in: query
          type: string
          description: Pre-defined view filter to apply.
      - 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: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.FRESHWORKS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: freshsales-contacts-rest
    port: 8080
    description: REST adapter for Freshworks Freshsales 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: freshsales-contacts.listcontacts
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcontact
        description: Create a contact
        call: freshsales-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: freshsales-contacts.getcontact
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecontact
        description: Update a contact
        call: freshsales-contacts.updatecontact
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecontact
        description: Delete a contact
        call: freshsales-contacts.deletecontact
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: freshsales-contacts-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshworks Freshsales 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: freshsales-contacts.listcontacts
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: create-contact
      description: Create a contact
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: freshsales-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: freshsales-contacts.getcontact
      outputParameters:
      - type: object
        mapping: $.
    - name: update-contact
      description: Update a contact
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: freshsales-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: freshsales-contacts.deletecontact
      outputParameters:
      - type: object
        mapping: $.