openapi: 3.1.0
info:
  title: Freshworks Freshcaller Accounts Changes 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: Changes
  description: Manage change requests for controlled modifications to IT infrastructure.
paths:
  /changes:
    get:
      operationId: listChanges
      summary: List all changes
      description: Retrieves a paginated list of all change requests in the service desk.
      tags:
      - Changes
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PerPageParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  changes:
                    type: array
                    items:
                      $ref: '#/components/schemas/Change'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createChange
      summary: Create a change request
      description: Creates a new change request for tracking controlled modifications to IT infrastructure and services.
      tags:
      - Changes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeCreate'
      responses:
        '201':
          description: Change created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  change:
                    $ref: '#/components/schemas/Change'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /changes/{change_id}:
    get:
      operationId: getChange
      summary: View a change request
      description: Retrieves the details of a specific change request by its ID.
      tags:
      - Changes
      parameters:
      - $ref: '#/components/parameters/ChangeIdParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  change:
                    $ref: '#/components/schemas/Change'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateChange
      summary: Update a change request
      description: Updates the properties of an existing change request.
      tags:
      - Changes
      parameters:
      - $ref: '#/components/parameters/ChangeIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeCreate'
      responses:
        '200':
          description: Change updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  change:
                    $ref: '#/components/schemas/Change'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteChange
      summary: Delete a change request
      description: Deletes a change request from the service desk.
      tags:
      - Changes
      parameters:
      - $ref: '#/components/parameters/ChangeIdParam'
      responses:
        '204':
          description: Change deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    PageParam:
      name: page
      in: query
      description: Page number for pagination.
      schema:
        type: integer
        minimum: 1
        default: 1
    ChangeIdParam:
      name: change_id
      in: path
      required: true
      description: The ID of the change request.
      schema:
        type: integer
    PerPageParam:
      name: per_page
      in: query
      description: Number of results per page (max 100).
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 30
  schemas:
    ChangeCreate:
      type: object
      required:
      - subject
      - description
      - status
      - priority
      - impact
      - risk
      - change_type
      properties:
        subject:
          type: string
          description: Subject of the change request.
        description:
          type: string
          description: HTML description.
        status:
          type: integer
          description: Status.
        priority:
          type: integer
          description: Priority.
        impact:
          type: integer
          description: Impact level.
        risk:
          type: integer
          description: Risk level.
        change_type:
          type: string
          description: Type of change.
        agent_id:
          type: integer
          description: ID of the agent to assign.
        group_id:
          type: integer
          description: ID of the group to assign.
        department_id:
          type: integer
          description: ID of the department.
        planned_start_date:
          type: string
          format: date-time
          description: Planned start date.
        planned_end_date:
          type: string
          format: date-time
          description: Planned end date.
    Error:
      type: object
      properties:
        description:
          type: string
          description: Human-readable error message.
        errors:
          type: array
          description: List of specific validation errors.
          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.
    Change:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the change.
        subject:
          type: string
          description: Subject of the change request.
        description:
          type: string
          description: HTML description.
        status:
          type: integer
          description: Status. 1=Open, 2=Planning, 3=Awaiting Approval, 4=Pending Release, 5=Pending Review, 6=Closed.
        priority:
          type: integer
          description: Priority. 1=Low, 2=Medium, 3=High, 4=Urgent.
        impact:
          type: integer
          description: Impact. 1=Low, 2=Medium, 3=High.
        risk:
          type: integer
          description: Risk. 1=Low, 2=Medium, 3=High, 4=Very High.
        change_type:
          type: string
          description: Type of change (Standard, Normal, Emergency, Minor).
        agent_id:
          type: integer
          description: ID of the assigned agent.
        group_id:
          type: integer
          description: ID of the assigned group.
        department_id:
          type: integer
          description: ID of the department.
        planned_start_date:
          type: string
          format: date-time
          description: Planned start date.
        planned_end_date:
          type: string
          format: date-time
          description: Planned end date.
        created_at:
          type: string
          format: date-time
          description: Timestamp when created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when last updated.
  responses:
    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'
    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/