freshworks Sales Activities API

openapi: 3.1.0
info:
  title: Freshworks Freshcaller Accounts Sales Activities API
  description: The Freshcaller API provides access to cloud-based phone system functionality for contact center operations. It allows developers to export call data, call recordings, user information, and agent team details stored in the Freshcaller system. The API supports integration of voice and telephony workflows into broader business applications, enabling organizations to automate call center reporting, synchronize agent data, and build custom dashboards around their phone operations.
  version: '1.0'
  contact:
    name: Freshworks Support
    url: https://support.freshcaller.com/
  termsOfService: https://www.freshworks.com/terms/
servers:
- url: https://{domain}.freshcaller.com/api/v1
  description: Freshcaller Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshcaller subdomain
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:
  schemas:
    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.
    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.
  parameters:
    PageParam:
      name: page
      in: query
      description: Page number for pagination.
      schema:
        type: integer
        minimum: 1
        default: 1
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The request body or parameters are invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Auth
      description: API key authentication. The API key can be found in your Freshcaller admin settings.
externalDocs:
  description: Freshcaller API Documentation
  url: https://developers.freshcaller.com/api/