find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/freshdesk:freshdesk-email-configs-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Freshdesk REST Email Configs API
  description: The Freshdesk REST API (v2) provides programmatic access to helpdesk data and operations within Freshdesk, a customer support platform by Freshworks.
  version: '2.0'
  contact:
    name: Freshdesk 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, e.g. if your helpdesk URL is acme.freshdesk.com, use acme.
security:
- basicAuth: []
tags:
- name: Email Configs
  description: Manage email mailbox configurations for the helpdesk.
paths:
  /email_configs:
    get:
      operationId: listEmailConfigs
      summary: List all email configurations
      description: Retrieves a list of all email mailbox configurations.
      tags:
      - Email Configs
      responses:
        '200':
          description: Successfully retrieved email configurations.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmailConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /email_configs/{email_config_id}:
    get:
      operationId: getEmailConfig
      summary: View an email configuration
      description: Retrieves the details of a specific email configuration by ID.
      tags:
      - Email Configs
      parameters:
      - $ref: '#/components/parameters/emailConfigId'
      responses:
        '200':
          description: Successfully retrieved email configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: Authentication failed or credentials were not provided.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    emailConfigId:
      name: email_config_id
      in: path
      required: true
      description: Unique identifier of the email configuration.
      schema:
        type: integer
        format: int64
  schemas:
    EmailConfig:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the email configuration.
        name:
          type: string
          description: Display 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.
        product_id:
          type: integer
          format: int64
          nullable: true
          description: ID of the associated product.
        primary_role:
          type: boolean
          description: Whether this is the primary email configuration.
        to_email:
          type: string
          format: email
          description: Incoming email address.
        active:
          type: boolean
          description: Whether the email configuration is active.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the email configuration was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the email configuration was last updated.
    Error:
      type: object
      properties:
        description:
          type: string
          description: Human-readable error description.
        errors:
          type: array
          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.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Freshdesk uses API key-based authentication. Pass your API key as the username with any string (e.g. X) as the password using HTTP Basic Authentication.
externalDocs:
  description: Freshdesk API Documentation
  url: https://developers.freshdesk.com/api/