Freshsales Deals API

openapi: 3.1.0
info:
  title: Freshsales CRM Appointments Deals API
  version: '2026-05-23'
  description: 'Best-effort OpenAPI 3.1 description of the Freshsales (Freshworks CRM)

    REST API. Generated from public documentation; not an official spec.

    '
  contact:
    name: Freshworks CRM Developer Portal
    url: https://developers.freshworks.com/crm/api/
servers:
- url: https://{bundleAlias}.myfreshworks.com/crm/sales/api
  description: Bundle-alias scoped base URL
  variables:
    bundleAlias:
      default: example
      description: Customer bundle alias (subdomain)
security:
- tokenAuth: []
tags:
- name: Deals
paths:
  /deals:
    post:
      tags:
      - Deals
      operationId: createDeal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Object'
      responses:
        '201':
          $ref: '#/components/responses/Ok'
  /deals/{id}:
    parameters:
    - $ref: '#/components/parameters/Id'
    get:
      tags:
      - Deals
      operationId: getDeal
      responses:
        '200':
          $ref: '#/components/responses/Ok'
    put:
      tags:
      - Deals
      operationId: updateDeal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Object'
      responses:
        '200':
          $ref: '#/components/responses/Ok'
    delete:
      tags:
      - Deals
      operationId: deleteDeal
      responses:
        '204':
          description: No Content
  /deals/view/{view_id}:
    parameters:
    - in: path
      name: view_id
      required: true
      schema:
        type: string
    get:
      tags:
      - Deals
      operationId: listDealsByView
      responses:
        '200':
          $ref: '#/components/responses/Ok'
components:
  responses:
    Ok:
      description: Successful response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Object'
  parameters:
    Id:
      in: path
      name: id
      required: true
      schema:
        type: string
  schemas:
    Object:
      type: object
      additionalProperties: true
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Token-based authentication header in the form

        "Authorization: Token token=YOUR_API_KEY".

        '