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/freshworks-deals-api"

All apis

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

Discovery needs no key. Ratings and market analysis are Pro.

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: Freshworks Freshsales Deals API
  description: The Freshsales API is a RESTful API that enables developers to access and manage CRM data within Freshsales. It supports operations for contacts, accounts, deals, leads, tasks, appointments, notes, and sales activities. The API uses token-based authentication and allows developers to read, modify, add, or delete CRM data, making it possible to build custom integrations, automate sales workflows, and synchronize Freshsales data with other business applications.
  version: '1.0'
  contact:
    name: Freshworks Support
    url: https://support.freshsales.io/
  termsOfService: https://www.freshworks.com/terms/
servers:
- url: https://{domain}.myfreshworks.com/crm/sales/api
  description: Freshsales Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshworks bundle alias
security:
- apiKeyAuth: []
tags:
- name: Deals
  description: Manage sales deals and their pipeline progression.
paths:
  /deals:
    get:
      operationId: listDeals
      summary: List all deals
      description: Retrieves a paginated list of all deals in the CRM pipeline.
      tags:
      - Deals
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/SortParam'
      - $ref: '#/components/parameters/SortTypeParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  deals:
                    type: array
                    items:
                      $ref: '#/components/schemas/Deal'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createDeal
      summary: Create a deal
      description: Creates a new deal in the sales pipeline.
      tags:
      - Deals
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DealCreate'
      responses:
        '200':
          description: Deal created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  deal:
                    $ref: '#/components/schemas/Deal'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /deals/{deal_id}:
    get:
      operationId: getDeal
      summary: View a deal
      description: Retrieves the details of a specific deal by its ID.
      tags:
      - Deals
      parameters:
      - $ref: '#/components/parameters/DealIdParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  deal:
                    $ref: '#/components/schemas/Deal'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateDeal
      summary: Update a deal
      description: Updates the properties of an existing deal.
      tags:
      - Deals
      parameters:
      - $ref: '#/components/parameters/DealIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DealCreate'
      responses:
        '200':
          description: Deal updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  deal:
                    $ref: '#/components/schemas/Deal'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteDeal
      summary: Delete a deal
      description: Deletes a deal from the CRM.
      tags:
      - Deals
      parameters:
      - $ref: '#/components/parameters/DealIdParam'
      responses:
        '204':
          description: Deal deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: The request body or parameters are invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        description:
          type: string
          description: Human-readable error message.
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                description: Field that caused the error.
              message:
                type: string
                description: Error message.
              code:
                type: string
                description: Error code.
    DealCreate:
      type: object
      required:
      - name
      - amount
      properties:
        name:
          type: string
          description: Name of the deal.
        amount:
          type: number
          description: Deal value amount.
        expected_close:
          type: string
          format: date
          description: Expected close date.
        deal_stage_id:
          type: integer
          description: ID of the deal stage.
        deal_pipeline_id:
          type: integer
          description: ID of the pipeline.
        probability:
          type: integer
          description: Probability of closing.
        sales_account_id:
          type: integer
          description: ID of the associated account.
        owner_id:
          type: integer
          description: ID of the owning agent.
        custom_field:
          type: object
          additionalProperties: true
          description: Custom field values.
    Deal:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the deal.
        name:
          type: string
          description: Name of the deal.
        amount:
          type: number
          description: Deal value amount.
        expected_close:
          type: string
          format: date
          description: Expected close date.
        deal_stage_id:
          type: integer
          description: ID of the current deal stage.
        deal_pipeline_id:
          type: integer
          description: ID of the deal pipeline.
        probability:
          type: integer
          description: Probability of closing (0-100).
          minimum: 0
          maximum: 100
        sales_account_id:
          type: integer
          description: ID of the associated account.
        owner_id:
          type: integer
          description: ID of the owning sales agent.
        currency_id:
          type: integer
          description: ID of the currency.
        custom_field:
          type: object
          additionalProperties: true
          description: Custom field values.
        created_at:
          type: string
          format: date-time
          description: Timestamp when created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when last updated.
    Meta:
      type: object
      properties:
        total_pages:
          type: integer
          description: Total number of pages.
        total:
          type: integer
          description: Total number of records.
  parameters:
    PageParam:
      name: page
      in: query
      description: Page number for pagination.
      schema:
        type: integer
        minimum: 1
        default: 1
    SortParam:
      name: sort
      in: query
      description: Field to sort by.
      schema:
        type: string
    DealIdParam:
      name: deal_id
      in: path
      required: true
      description: The ID of the deal.
      schema:
        type: integer
    SortTypeParam:
      name: sort_type
      in: query
      description: Sort order direction.
      schema:
        type: string
        enum:
        - asc
        - desc
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication. Use the format "Token token=your_api_key".
externalDocs:
  description: Freshsales API Documentation
  url: https://developers.freshworks.com/crm/api/