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-users-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 Users API
  termsOfService: https://www.freshworks.com/terms/
  version: '1.0'
  description: 'Operations tagged Users across 2 of this provider''s published API definitions: freshworks-freshcaller-api-openapi.yml, freshworks-freshchat-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{domain}.freshcaller.com/api/v1
  description: Freshcaller Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshcaller subdomain
- 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
tags:
- name: Users
  description: Manage agent users in the Freshcaller system including creation, updates, and status management.
paths:
  /users:
    get:
      operationId: listUsers
      summary: List all users
      description: Retrieves a list of all agent users configured in the Freshcaller system, including their status and role information.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PerPageParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
      - apiKeyAuth: []
    post:
      operationId: createUser
      summary: Create a user
      description: Creates a new agent user in the Freshcaller system.
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreate'
      responses:
        '201':
          description: User created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/User'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
      - apiKeyAuth: []
    servers:
    - url: https://{domain}.freshcaller.com/api/v1
      description: Freshcaller Production Server
      variables:
        domain:
          default: yourdomain
          description: Your Freshcaller subdomain
  /users/{user_id}:
    get:
      operationId: getUser
      summary: View a user
      description: Retrieves the details of a specific user by their ID.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/User'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - apiKeyAuth: []
    put:
      operationId: updateUser
      summary: Update a user
      description: Updates the properties of an existing agent user.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreate'
      responses:
        '200':
          description: User updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/User'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - apiKeyAuth: []
    servers:
    - url: https://{domain}.freshcaller.com/api/v1
      description: Freshcaller Production Server
      variables:
        domain:
          default: yourdomain
          description: Your Freshcaller subdomain
  /user_statuses:
    get:
      operationId: listUserStatuses
      summary: List all user statuses
      description: Retrieves the current availability status of all agent users in the Freshcaller system.
      tags:
      - Users
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_statuses:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
      - apiKeyAuth: []
    servers:
    - url: https://{domain}.freshcaller.com/api/v1
      description: Freshcaller Production Server
      variables:
        domain:
          default: yourdomain
          description: Your Freshcaller subdomain
components:
  parameters:
    UserIdParam:
      name: user_id
      in: path
      required: true
      description: The ID of the user.
      schema:
        type: integer
    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.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
    UserIdParam_2:
      name: user_id
      in: path
      required: true
      description: The ID of the user.
      schema:
        type: string
    ItemsPerPageParam:
      name: items_per_page
      in: query
      description: Number of items per page.
      schema:
        type: integer
        minimum: 1
        maximum: 50
        default: 20
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Human-readable error message.
    UserCreate:
      type: object
      required:
      - name
      - email
      properties:
        name:
          type: string
          description: Full name of the user.
        email:
          type: string
          format: email
          description: Email address.
        phone:
          type: string
          description: Phone number.
        role:
          type: string
          description: Role to assign (admin, supervisor, agent).
        team_ids:
          type: array
          items:
            type: integer
          description: IDs of teams to assign.
    User:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the user.
        name:
          type: string
          description: Full name of the user.
        email:
          type: string
          format: email
          description: Email address.
        phone:
          type: string
          description: Phone number.
        role:
          type: string
          description: Role of the user (admin, supervisor, agent).
        available:
          type: boolean
          description: Whether the user is currently available.
        team_ids:
          type: array
          items:
            type: integer
          description: IDs of teams the user belongs to.
        created_at:
          type: string
          format: date-time
          description: Timestamp when created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when last updated.
    UserStatus:
      type: object
      properties:
        user_id:
          type: integer
          description: ID of the user.
        name:
          type: string
          description: Name of the user.
        available:
          type: boolean
          description: Whether the user is available.
        on_call:
          type: boolean
          description: Whether the user is currently on a call.
        status:
          type: string
          description: Current status label.
    Meta:
      type: object
      properties:
        total_pages:
          type: integer
          description: Total number of pages.
        total:
          type: integer
          description: Total number of records.
        current_page:
          type: integer
          description: Current page number.
    UserCreate_2:
      type: object
      properties:
        email:
          type: string
          format: email
          description: Email address.
        first_name:
          type: string
          description: First name.
        last_name:
          type: string
          description: Last name.
        phone:
          type: string
          description: Phone number.
        properties:
          type: array
          description: Custom user properties.
          items:
            type: object
            properties:
              name:
                type: string
                description: Property name.
              value:
                type: string
                description: Property value.
    PaginationLinks:
      type: object
      properties:
        next_page:
          type: string
          format: uri
          description: URL for the next page of results.
        prev_page:
          type: string
          format: uri
          description: URL for the previous page of results.
    User_2:
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the user.
        email:
          type: string
          format: email
          description: Email address.
        first_name:
          type: string
          description: First name.
        last_name:
          type: string
          description: Last name.
        phone:
          type: string
          description: Phone number.
        avatar:
          type: object
          description: Avatar image details.
          properties:
            url:
              type: string
              format: uri
              description: URL of the avatar image.
        properties:
          type: array
          description: Custom user properties.
          items:
            type: object
            properties:
              name:
                type: string
                description: Property name.
              value:
                type: string
                description: Property value.
        created_time:
          type: string
          format: date-time
          description: Timestamp when the user was created.
  responses:
    NotFound:
      description: The requested resource was not found.
      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'
    Unauthorized:
      description: Authentication credentials are missing or 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.
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication. Obtain the API token from the Freshchat admin settings panel.
x-refined-from:
- freshworks-freshcaller-api-openapi.yml
- freshworks-freshchat-api-openapi.yml