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-departments-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 Departments API
  termsOfService: https://www.freshworks.com/terms/
  version: '1.0'
  description: 'Operations tagged Departments across 2 of this provider''s published API definitions: freshworks-freshservice-api-openapi.yml, freshworks-freshteam-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{domain}.freshservice.com/api/v2
  description: Freshservice Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshservice subdomain
- url: https://{domain}.freshteam.com/api
  description: Freshteam Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshteam subdomain
tags:
- name: Departments
  description: Manage organizational department records.
paths:
  /departments:
    get:
      operationId: listDepartments
      summary: List all departments
      description: Retrieves a list of all organizational departments.
      tags:
      - Departments
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  departments:
                    type: array
                    items:
                      $ref: '#/components/schemas/Department'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
      - basicAuth: []
    servers:
    - url: https://{domain}.freshservice.com/api/v2
      description: Freshservice Production Server
      variables:
        domain:
          default: yourdomain
          description: Your Freshservice subdomain
components:
  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.
    Department:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the department.
        name:
          type: string
          description: Name of the department.
        description:
          type: string
          description: Description.
        head_user_id:
          type: integer
          description: ID of the department head.
        prime_user_id:
          type: integer
          description: ID of the primary user.
        domains:
          type: array
          items:
            type: string
          description: Email domains associated with the department.
        custom_fields:
          type: object
          additionalProperties: true
          description: Custom field values.
        created_at:
          type: string
          format: date-time
          description: Timestamp when created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when last updated.
    Error_2:
      type: object
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Human-readable error message.
    Department_2:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the department.
        name:
          type: string
          description: Name of the department.
        created_at:
          type: string
          format: date-time
          description: Timestamp when created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when last updated.
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  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 Freshservice 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-freshservice-api-openapi.yml
- freshworks-freshteam-api-openapi.yml