How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

freshworks Deals API

Manage sales deals and their pipeline progression.

freshworks Deals API is one of 44 APIs that Freshworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deals. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{domain}.myfreshworks.com/crm/sales/api.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://domain.freshdesk.com/api/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

freshworks Deals API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Token-based authentication. Use the format "Token token=yourapikey".

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Deals 5

Manage sales deals and their pipeline progression.

GET
/deals
List all deals
listDeals 3 params → 200401
POST
/deals
Create a deal
createDeal body → 200400401
GET
/deals/{deal_id}
View a deal
getDeal 1 param → 200401404
PUT
/deals/{deal_id}
Update a deal
updateDeal 1 param body → 200400401404
DELETE
/deals/{deal_id}
Delete a deal
deleteDeal 1 param → 204401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Deal (13 properties), DealCreate (9 properties), Meta (2 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
DealCreate
object
9 properties 2 required
Deal
object
13 properties
Meta
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

freshworks-deals-api-openapi.yml Raw ↑

Other APIs Freshworks publishes across the network.

Freshworks Freshmarketer API
Freshworks App SDK
freshworks Accounts API
freshworks Agents API
freshworks Applicants API
freshworks Appointments API
freshworks Assets API
freshworks Branches API
freshworks Business Hours API
freshworks Call Metrics API
freshworks Calls API
freshworks Changes API
Where this information came from

This is an independent, third-party profile of freshworks Deals API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.