freshworks Email Configs API

openapi: 3.2.0
info:
  title: Freshworks Freshdesk Email Configs API
  description: The Freshdesk API v2 is a RESTful API that provides programmatic access to Freshdesk helpdesk functionality. It allows developers to manage tickets, contacts, companies, agents, groups, and other helpdesk resources through standard CRUD operations. The API uses JSON for data exchange, supports API key authentication, and enables integration of Freshdesk customer support workflows into third-party applications and automation pipelines.
  version: '2.0'
  contact:
    name: Freshworks Support
    url: https://support.freshdesk.com/
  termsOfService: https://www.freshworks.com/terms/
servers:
- url: https://{domain}.freshdesk.com/api/v2
  description: Freshdesk Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshdesk subdomain
security:
- basicAuth: []
tags:
- name: Email Configs
  description: Manage email configuration settings for the helpdesk.
paths:
  /email_configs:
    get:
      operationId: listEmailConfigs
      summary: List all email configurations
      description: Retrieves a list of all email configurations for the helpdesk.
      tags:
      - Email Configs
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmailConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    EmailConfig:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the email configuration.
        name:
          type: string
          description: Friendly name of the email configuration.
        reply_email:
          type: string
          format: email
          description: Reply-to email address.
        support_email:
          type: string
          format: email
          description: Support email address for receiving tickets.
        active:
          type: boolean
          description: Whether the email configuration is active.
        product_id:
          type: integer
          description: ID of the associated product.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the configuration was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the configuration was last updated.
    Error:
      type: object
      properties:
        description:
          type: string
          description: Human-readable error message.
        errors:
          type: array
          description: List of specific validation errors.
          items:
            type: object
            properties:
              field:
                type: string
                description: Field that caused the error.
              message:
                type: string
                description: Error message for the field.
              code:
                type: string
                description: Error code.
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Use your API key as the username and X as the password. The API key can be found in your Freshdesk profile settings.
externalDocs:
  description: Freshdesk API Documentation
  url: https://developers.freshdesk.com/api/