openapi: 3.1.0
info:
  title: Freshworks Freshcaller Accounts Email Configs API
  description: The Freshcaller API provides access to cloud-based phone system functionality for contact center operations. It allows developers to export call data, call recordings, user information, and agent team details stored in the Freshcaller system. The API supports integration of voice and telephony workflows into broader business applications, enabling organizations to automate call center reporting, synchronize agent data, and build custom dashboards around their phone operations.
  version: '1.0'
  contact:
    name: Freshworks Support
    url: https://support.freshcaller.com/
  termsOfService: https://www.freshworks.com/terms/
servers:
- url: https://{domain}.freshcaller.com/api/v1
  description: Freshcaller Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshcaller subdomain
security:
- apiKeyAuth: []
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:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Auth
      description: API key authentication. The API key can be found in your Freshcaller admin settings.
externalDocs:
  description: Freshcaller API Documentation
  url: https://developers.freshcaller.com/api/