openapi: 3.1.0
info:
  title: Freshworks Freshcaller Accounts Roles 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: Roles
  description: Manage agent roles and permissions.
paths:
  /roles:
    get:
      operationId: listRoles
      summary: List all roles
      description: Retrieves a list of all agent roles configured in the helpdesk.
      tags:
      - Roles
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Role'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /roles/{role_id}:
    get:
      operationId: getRole
      summary: View a role
      description: Retrieves the details of a specific agent role by its ID.
      tags:
      - Roles
      parameters:
      - name: role_id
        in: path
        required: true
        description: The ID of the role to retrieve.
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  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:
    Role:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the role.
        name:
          type: string
          description: Name of the role.
        description:
          type: string
          description: Description of the role.
        default:
          type: boolean
          description: Whether this is a default system role.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the role was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the role was last updated.
    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 for the field.
              code:
                type: string
                description: Error code.
  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/