freshworks Roles API

openapi: 3.2.0
info:
  title: Freshworks Roles API
  termsOfService: https://www.freshworks.com/terms/
  version: '1.0'
  description: 'Operations tagged Roles across 2 of this provider''s published API definitions: freshworks-freshdesk-api-openapi.yml, freshworks-freshteam-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{domain}.freshdesk.com/api/v2
  description: Freshdesk Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshdesk subdomain
- url: https://{domain}.freshteam.com/api
  description: Freshteam Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshteam subdomain
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'
      security:
      - basicAuth: []
    servers:
    - url: https://{domain}.freshdesk.com/api/v2
      description: Freshdesk Production Server
      variables:
        domain:
          default: yourdomain
          description: Your Freshdesk subdomain
  /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'
      security:
      - basicAuth: []
    servers:
    - url: https://{domain}.freshdesk.com/api/v2
      description: Freshdesk Production Server
      variables:
        domain:
          default: yourdomain
          description: Your Freshdesk subdomain
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:
    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.
    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_2:
      type: object
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Human-readable error message.
    Role_2:
      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.
        default:
          type: boolean
          description: Whether this is a default system role.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Use your API key as the username and X as the password. The API key can be found in your Freshdesk profile settings.
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 Bearer token. Obtain access tokens via the Freshteam OAuth authorization flow.
x-refined-from:
- freshworks-freshdesk-api-openapi.yml
- freshworks-freshteam-api-openapi.yml