find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/freshworks-groups-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Freshworks Groups API
  version: '2.0'
  termsOfService: https://www.freshworks.com/terms/
  description: 'Operations tagged Groups across 2 of this provider''s published API definitions: freshworks-freshchat-api-openapi.yml, freshworks-freshdesk-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{domain}.freshchat.com/v2
  description: Freshchat Production Server (Standalone)
  variables:
    domain:
      default: yourdomain
      description: Your Freshchat account name
- url: https://{domain}.myfreshworks.com/v2
  description: Freshchat Production Server (Freshsales Suite)
  variables:
    domain:
      default: yourdomain
      description: Your Freshworks bundle alias
- url: https://{domain}.freshdesk.com/api/v2
  description: Freshdesk Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshdesk subdomain
tags:
- name: Groups
  description: Manage agent groups for conversation routing.
paths:
  /groups:
    get:
      operationId: listGroups
      summary: List all groups
      description: Retrieves a list of all agent groups configured for conversation routing.
      tags:
      - Groups
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  groups:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
      - bearerAuth: []
    post:
      operationId: createGroup
      summary: Create a group
      description: Creates a new agent group in the helpdesk.
      tags:
      - Groups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupCreate'
      responses:
        '201':
          description: Group created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group_2'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
      - bearerAuth: []
    servers:
    - url: https://{domain}.freshchat.com/v2
      description: Freshchat Production Server (Standalone)
      variables:
        domain:
          default: yourdomain
          description: Your Freshchat account name
    - url: https://{domain}.myfreshworks.com/v2
      description: Freshchat Production Server (Freshsales Suite)
      variables:
        domain:
          default: yourdomain
          description: Your Freshworks bundle alias
  /groups/{group_id}:
    get:
      operationId: getGroup
      summary: View a group
      description: Retrieves the details of a specific agent group.
      tags:
      - Groups
      parameters:
      - name: group_id
        in: path
        required: true
        description: The ID of the group.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - bearerAuth: []
    put:
      operationId: updateGroup
      summary: Update a group
      description: Updates the properties of an existing agent group.
      tags:
      - Groups
      parameters:
      - $ref: '#/components/parameters/GroupIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupCreate'
      responses:
        '200':
          description: Group updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group_2'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - bearerAuth: []
    delete:
      operationId: deleteGroup
      summary: Delete a group
      description: Deletes an agent group from the helpdesk.
      tags:
      - Groups
      parameters:
      - $ref: '#/components/parameters/GroupIdParam'
      responses:
        '204':
          description: Group deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - bearerAuth: []
    servers:
    - url: https://{domain}.freshchat.com/v2
      description: Freshchat Production Server (Standalone)
      variables:
        domain:
          default: yourdomain
          description: Your Freshchat account name
    - url: https://{domain}.myfreshworks.com/v2
      description: Freshchat Production Server (Freshsales Suite)
      variables:
        domain:
          default: yourdomain
          description: Your Freshworks bundle alias
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'
    BadRequest:
      description: The request body or parameters are invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Human-readable error message.
    Group:
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the group.
        name:
          type: string
          description: Name of the group.
        description:
          type: string
          description: Description of the group.
        routing_type:
          type: string
          description: Conversation routing type for the group.
        agents:
          type: array
          description: IDs of agents in the group.
          items:
            type: string
        created_time:
          type: string
          format: date-time
          description: Timestamp when the group was created.
    Error_2:
      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.
    Group_2:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the group.
        name:
          type: string
          description: Name of the group.
        description:
          type: string
          description: Description of the group.
        agent_ids:
          type: array
          items:
            type: integer
          description: IDs of agents in the group.
        auto_ticket_assign:
          type: boolean
          description: Whether auto ticket assignment is enabled.
        escalate_to:
          type: integer
          description: Agent ID to escalate unassigned tickets to.
        unassigned_for:
          type: string
          description: Time duration after which tickets are escalated.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the group was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the group was last updated.
    GroupCreate:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Name of the group.
        description:
          type: string
          description: Description of the group.
        agent_ids:
          type: array
          items:
            type: integer
          description: IDs of agents to include.
        auto_ticket_assign:
          type: boolean
          description: Whether to enable auto ticket assignment.
        escalate_to:
          type: integer
          description: Agent ID to escalate unassigned tickets to.
        unassigned_for:
          type: string
          description: Time duration after which tickets are escalated.
  parameters:
    PageParam:
      name: page
      in: query
      description: Page number for pagination.
      schema:
        type: integer
        minimum: 1
        default: 1
    GroupIdParam:
      name: group_id
      in: path
      required: true
      description: The ID of the group.
      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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication. Obtain the API token from the Freshchat admin settings panel.
    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.
x-refined-from:
- freshworks-freshchat-api-openapi.yml
- freshworks-freshdesk-api-openapi.yml