Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Freshservice Org Config (BYOK) — connector documentation

  • MCP endpoint: https://byok-freshservice-org-config.connectorbay.com/mcp
  • REST API: POST https://byok-freshservice-org-config.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-freshservice-org-config.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Freshservice Org Config Freshservice API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-freshservice-org-config.connectorbay.com/health · Tool schemas: https://byok-freshservice-org-config.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-freshservice-org-config · agent@connectorbay.com

What Freshservice Org Config (BYOK) is for

Freshservice Org Config (BYOK) lets an AI assistant read your own Freshservice Org Config data through the Freshservice Org Config API with a key you supply (Freshservice API key). Read-only: 10 tools (list_departments, list_locations, list_agent_groups, list_roles, list_workspaces, list_announcements, list_canned_response_folders, list_ticket_form_fields, list_change_form_fields, list_problem_form_fields). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to *.freshservice.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Freshservice Org Config. Freshservice Org Config and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which departments are defined in Freshservice?"
  • "What locations are set up in Freshservice?"
  • "Which agent groups exist in Freshservice?"
  • "What agent roles does Freshservice have?"
  • "Which workspaces does my Freshservice account have?"
  • "What announcements are active in Freshservice?"

What it does

  • list_departments: List departments (companies in MSP mode) with name, description, email domains and workspace. Head and primary contact user ids are not returned.
  • list_locations: List locations with name, parent location, address (city, state, country) and workspace.
  • list_agent_groups: List agent groups with name, description, business hours id, unassigned-ticket escalation time and flags. Member, observer and leader ids are not returned.
  • list_roles: List agent roles with name, description, default flag and the access scope for tickets, problems, changes and releases.
  • list_workspaces: List workspaces (clients in MSP mode) with name, state, whether primary and the template used.
  • list_announcements: List announcements with title, state, visibility and visible-from and visible-till dates. Body text and recipients are not returned.
  • list_canned_response_folders: List canned response folders with name, type and the number of responses each holds.
  • list_ticket_form_fields: List the fields of the ticket form (default and custom) with label, type, required flags, position and choices.
  • list_change_form_fields: List the fields of the change form (default and custom) with label, type, required flags, position and choices.
  • list_problem_form_fields: List the fields of the problem form (default and custom) with label, type, required flags, position and choices.

BYOK key

You bring your own Freshservice Org Config Freshservice API key (https://api.freshservice.com/#authentication). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to *.freshservice.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Freshservice Org Config API (*.freshservice.com) with a BYOK key; documentation: https://api.freshservice.com/. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Freshservice Org Config. Freshservice Org Config and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Freshservice Org Config account.

Built for: Worldwide. Languages: English.