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-tasks-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 Tasks 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: Tasks
  description: Manage tasks associated with sales activities.
paths:
  /tasks:
    get:
      operationId: listTasks
      summary: List all tasks
      description: Retrieves a paginated list of all tasks in the CRM.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - name: filter
        in: query
        description: Filter tasks by status (open, due_today, due_tomorrow, overdue, completed).
        schema:
          type: string
          enum:
          - open
          - due_today
          - due_tomorrow
          - overdue
          - completed
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  tasks:
                    type: array
                    items:
                      $ref: '#/components/schemas/Task'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createTask
      summary: Create a task
      description: Creates a new task in the CRM.
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskCreate'
      responses:
        '200':
          description: Task created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  task:
                    $ref: '#/components/schemas/Task'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /tasks/{task_id}:
    get:
      operationId: getTask
      summary: View a task
      description: Retrieves the details of a specific task by its ID.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/TaskIdParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  task:
                    $ref: '#/components/schemas/Task'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateTask
      summary: Update a task
      description: Updates the properties of an existing task.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/TaskIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskCreate'
      responses:
        '200':
          description: Task updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  task:
                    $ref: '#/components/schemas/Task'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteTask
      summary: Delete a task
      description: Deletes a task from the CRM.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/TaskIdParam'
      responses:
        '204':
          description: Task 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.
    TaskCreate:
      type: object
      required:
      - title
      - due_date
      - owner_id
      properties:
        title:
          type: string
          description: Title of the task.
        description:
          type: string
          description: Description.
        due_date:
          type: string
          format: date-time
          description: Due date and time.
        owner_id:
          type: integer
          description: ID of the task owner.
        task_type_id:
          type: integer
          description: ID of the task type.
        targetable_type:
          type: string
          description: Type of associated record.
        targetable_id:
          type: integer
          description: ID of associated record.
    Task:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the task.
        title:
          type: string
          description: Title of the task.
        description:
          type: string
          description: Description of the task.
        due_date:
          type: string
          format: date-time
          description: Due date and time.
        owner_id:
          type: integer
          description: ID of the task owner.
        status:
          type: integer
          description: Status of the task. 0=Open, 1=Completed.
        task_type_id:
          type: integer
          description: ID of the task type.
        outcome_id:
          type: integer
          description: ID of the task outcome.
        targetable_type:
          type: string
          description: Type of the associated record (Contact, Deal, Lead).
        targetable_id:
          type: integer
          description: ID of the associated record.
        created_at:
          type: string
          format: date-time
          description: Timestamp when created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when last updated.
  parameters:
    PageParam:
      name: page
      in: query
      description: Page number for pagination.
      schema:
        type: integer
        minimum: 1
        default: 1
    TaskIdParam:
      name: task_id
      in: path
      required: true
      description: The ID of the task.
      schema:
        type: integer
  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/