{
  "opencollection": "1.0.0",
  "info": {
    "name": "Freshworks Freshchat API",
    "version": "2.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Conversations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all conversations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/conversations",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "items_per_page",
                "value": "",
                "type": "query",
                "description": "Number of items per page."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter conversations by status (new, assigned, resolved, reopened)."
              },
              {
                "name": "assigned_agent_id",
                "value": "",
                "type": "query",
                "description": "Filter by assigned agent ID."
              },
              {
                "name": "assigned_group_id",
                "value": "",
                "type": "query",
                "description": "Filter by assigned group ID."
              }
            ]
          },
          "docs": "Retrieves a paginated list of all conversations. The response does not include messages or user details by default."
        },
        {
          "info": {
            "name": "Create a conversation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshchat.com/v2/conversations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new conversation with an initial message. Requires a user ID or user details and the message content."
        },
        {
          "info": {
            "name": "View a conversation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/conversations/:conversation_id",
            "params": [
              {
                "name": "conversation_id",
                "value": "",
                "type": "path",
                "description": "The ID of the conversation."
              }
            ]
          },
          "docs": "Retrieves the details of a specific conversation by its ID. Messages and user attributes are not included by default."
        },
        {
          "info": {
            "name": "Update a conversation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{domain}.freshchat.com/v2/conversations/:conversation_id",
            "params": [
              {
                "name": "conversation_id",
                "value": "",
                "type": "path",
                "description": "The ID of the conversation."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the properties of an existing conversation such as status and assignment."
        }
      ]
    },
    {
      "info": {
        "name": "Messages",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List messages in a conversation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/conversations/:conversation_id/messages",
            "params": [
              {
                "name": "conversation_id",
                "value": "",
                "type": "path",
                "description": "The ID of the conversation."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "items_per_page",
                "value": "",
                "type": "query",
                "description": "Number of items per page."
              }
            ]
          },
          "docs": "Retrieves all messages within a specific conversation, ordered by creation time."
        },
        {
          "info": {
            "name": "Send a message in a conversation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshchat.com/v2/conversations/:conversation_id/messages",
            "params": [
              {
                "name": "conversation_id",
                "value": "",
                "type": "path",
                "description": "The ID of the conversation."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sends a new message in an existing conversation. The message can be sent on behalf of an agent or the system."
        }
      ]
    },
    {
      "info": {
        "name": "Agents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all agents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/agents",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "items_per_page",
                "value": "",
                "type": "query",
                "description": "Number of items per page."
              }
            ]
          },
          "docs": "Retrieves a list of all agents configured for the Freshchat account, including their availability status."
        },
        {
          "info": {
            "name": "View an agent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path",
                "description": "The ID of the agent."
              }
            ]
          },
          "docs": "Retrieves the metadata and availability status of a specific agent."
        }
      ]
    },
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/users",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "items_per_page",
                "value": "",
                "type": "query",
                "description": "Number of items per page."
              }
            ]
          },
          "docs": "Retrieves a paginated list of all end-users registered in the Freshchat system."
        },
        {
          "info": {
            "name": "Create a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshchat.com/v2/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new end-user in the Freshchat system."
        },
        {
          "info": {
            "name": "View a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/users/:user_id",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "The ID of the user."
              }
            ]
          },
          "docs": "Retrieves the profile and properties of a specific user."
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{domain}.freshchat.com/v2/users/:user_id",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "The ID of the user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the profile properties of an existing user."
        }
      ]
    },
    {
      "info": {
        "name": "Channels",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all channels",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/channels"
          },
          "docs": "Retrieves a list of all messaging channels configured in the Freshchat account."
        },
        {
          "info": {
            "name": "View a channel",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/channels/:channel_id",
            "params": [
              {
                "name": "channel_id",
                "value": "",
                "type": "path",
                "description": "The ID of the channel."
              }
            ]
          },
          "docs": "Retrieves the details of a specific messaging channel."
        }
      ]
    },
    {
      "info": {
        "name": "Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/groups"
          },
          "docs": "Retrieves a list of all agent groups configured for conversation routing."
        },
        {
          "info": {
            "name": "View a group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshchat.com/v2/groups/:group_id",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "The ID of the group."
              }
            ]
          },
          "docs": "Retrieves the details of a specific agent group."
        }
      ]
    }
  ],
  "bundled": true
}