freshworks Service Catalog API

openapi: 3.1.0
info:
  title: Freshworks Freshcaller Accounts Service Catalog 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: Service Catalog
  description: Manage service catalog items available for request.
paths:
  /service_catalog/items:
    get:
      operationId: listServiceCatalogItems
      summary: List all service catalog items
      description: Retrieves a list of all items available in the service catalog for requesters to browse and request.
      tags:
      - Service Catalog
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PerPageParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  service_items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ServiceItem'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /service_catalog/items/{item_id}:
    get:
      operationId: getServiceCatalogItem
      summary: View a service catalog item
      description: Retrieves the details of a specific service catalog item.
      tags:
      - Service Catalog
      parameters:
      - name: item_id
        in: path
        required: true
        description: The ID of the service catalog item.
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  service_item:
                    $ref: '#/components/schemas/ServiceItem'
        '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
    PerPageParam:
      name: per_page
      in: query
      description: Number of results per page (max 100).
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 30
  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'
  schemas:
    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.
    ServiceItem:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the service item.
        name:
          type: string
          description: Name of the service item.
        description:
          type: string
          description: Description.
        short_description:
          type: string
          description: Short description for catalog listing.
        category_id:
          type: integer
          description: ID of the service category.
        display_id:
          type: integer
          description: Display ID for the item.
        delivery_time:
          type: integer
          description: Expected delivery time in hours.
        visibility:
          type: integer
          description: Visibility setting.
        created_at:
          type: string
          format: date-time
          description: Timestamp when created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when last updated.
  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/