freshworks Sales Activities API

openapi: 3.2.0
info:
  title: Freshworks Freshsales Sales Activities 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: Sales Activities
  description: Track and manage sales activity records.
paths:
  /sales_activities:
    get:
      operationId: listSalesActivities
      summary: List all sales activities
      description: Retrieves a paginated list of all sales activities in the CRM.
      tags:
      - Sales Activities
      parameters:
      - $ref: '#/components/parameters/PageParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  sales_activities:
                    type: array
                    items:
                      $ref: '#/components/schemas/SalesActivity'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createSalesActivity
      summary: Create a sales activity
      description: Creates a new sales activity record in the CRM.
      tags:
      - Sales Activities
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SalesActivityCreate'
      responses:
        '200':
          description: Sales activity created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  sales_activity:
                    $ref: '#/components/schemas/SalesActivity'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    BadRequest:
      description: The request body or parameters are invalid.
      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.
    SalesActivityCreate:
      type: object
      required:
      - title
      - owner_id
      - sales_activity_type_id
      - start_date
      - end_date
      properties:
        title:
          type: string
          description: Title of the activity.
        notes:
          type: string
          description: Notes.
        start_date:
          type: string
          format: date-time
          description: Start date.
        end_date:
          type: string
          format: date-time
          description: End date.
        sales_activity_type_id:
          type: integer
          description: Activity type ID.
        owner_id:
          type: integer
          description: Owner ID.
        targetable_type:
          type: string
          description: Associated record type.
        targetable_id:
          type: integer
          description: Associated record ID.
    SalesActivity:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the sales activity.
        title:
          type: string
          description: Title of the activity.
        notes:
          type: string
          description: Notes about the activity.
        start_date:
          type: string
          format: date-time
          description: Start date and time.
        end_date:
          type: string
          format: date-time
          description: End date and time.
        sales_activity_type_id:
          type: integer
          description: ID of the activity type.
        sales_activity_outcome_id:
          type: integer
          description: ID of the activity outcome.
        owner_id:
          type: integer
          description: ID of the activity owner.
        targetable_type:
          type: string
          description: Type of associated record.
        targetable_id:
          type: integer
          description: ID of 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
  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/