{
  "opencollection": "1.0.0",
  "info": {
    "name": "Freshworks Freshdesk API",
    "version": "2.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Tickets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all tickets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page (max 100)."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Pre-defined filter to apply. Options include new_and_my_open, watching, spam, deleted."
              },
              {
                "name": "requester_id",
                "value": "",
                "type": "query",
                "description": "Filter tickets by requester ID."
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter tickets by requester email."
              },
              {
                "name": "updated_since",
                "value": "",
                "type": "query",
                "description": "Return tickets updated after this timestamp in UTC format."
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "Field to sort by."
              },
              {
                "name": "order_type",
                "value": "",
                "type": "query",
                "description": "Sort order direction."
              }
            ]
          },
          "docs": "Retrieves a list of all tickets in the helpdesk. Results can be filtered by various criteria including status, priority, and requester. Supports pagination with a default page size of 30."
        },
        {
          "info": {
            "name": "Create a ticket",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new ticket in the helpdesk. Requires at least a subject, description, and requester identification (email, phone, or requester_id). Supports attachments and custom fields."
        },
        {
          "info": {
            "name": "View a ticket",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include additional information in the response. Comma-separated values from conversations, requester, company, stats."
              }
            ]
          },
          "docs": "Retrieves the details of a specific ticket by its ID, including all ticket properties and custom fields."
        },
        {
          "info": {
            "name": "Update a ticket",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the properties of an existing ticket. Only the fields included in the request body will be updated."
        },
        {
          "info": {
            "name": "Delete a ticket",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              }
            ]
          },
          "docs": "Soft-deletes a ticket by moving it to the trash. The ticket can be restored later using the restore endpoint."
        },
        {
          "info": {
            "name": "Restore a deleted ticket",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id/restore",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              }
            ]
          },
          "docs": "Restores a previously deleted ticket from the trash."
        }
      ]
    },
    {
      "info": {
        "name": "Conversations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all conversations of a ticket",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id/conversations",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page (max 100)."
              }
            ]
          },
          "docs": "Retrieves all conversations (replies and notes) associated with a specific ticket."
        },
        {
          "info": {
            "name": "Reply to a ticket",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id/reply",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a public reply to a ticket. The reply is sent to all recipients associated with the ticket."
        },
        {
          "info": {
            "name": "Create a note on a ticket",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id/notes",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a private or public note to a ticket. Notes are used for internal communication or additional context."
        }
      ]
    },
    {
      "info": {
        "name": "Contacts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all contacts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/contacts",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page (max 100)."
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter contacts by email address."
              },
              {
                "name": "phone",
                "value": "",
                "type": "query",
                "description": "Filter contacts by phone number."
              },
              {
                "name": "company_id",
                "value": "",
                "type": "query",
                "description": "Filter contacts by company ID."
              }
            ]
          },
          "docs": "Retrieves a paginated list of all contacts in the helpdesk. Supports filtering by email, phone, mobile, and company."
        },
        {
          "info": {
            "name": "Create a contact",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshdesk.com/api/v2/contacts",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new contact in the helpdesk. At least one of name, email, phone, or mobile is required."
        },
        {
          "info": {
            "name": "View a contact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/contacts/:contact_id",
            "params": [
              {
                "name": "contact_id",
                "value": "",
                "type": "path",
                "description": "The ID of the contact."
              }
            ]
          },
          "docs": "Retrieves the details of a specific contact by their ID."
        },
        {
          "info": {
            "name": "Update a contact",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{domain}.freshdesk.com/api/v2/contacts/:contact_id",
            "params": [
              {
                "name": "contact_id",
                "value": "",
                "type": "path",
                "description": "The ID of the contact."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the properties of an existing contact."
        },
        {
          "info": {
            "name": "Delete a contact",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{domain}.freshdesk.com/api/v2/contacts/:contact_id",
            "params": [
              {
                "name": "contact_id",
                "value": "",
                "type": "path",
                "description": "The ID of the contact."
              }
            ]
          },
          "docs": "Soft-deletes a contact from the helpdesk."
        },
        {
          "info": {
            "name": "Merge contacts",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{domain}.freshdesk.com/api/v2/contacts/:contact_id/merge",
            "params": [
              {
                "name": "contact_id",
                "value": "",
                "type": "path",
                "description": "The ID of the contact."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Merges secondary contacts into the primary contact specified by the contact_id path parameter."
        }
      ]
    },
    {
      "info": {
        "name": "Companies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all companies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/companies",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page (max 100)."
              }
            ]
          },
          "docs": "Retrieves a paginated list of all companies in the helpdesk."
        },
        {
          "info": {
            "name": "Create a company",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshdesk.com/api/v2/companies",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new company record in the helpdesk."
        },
        {
          "info": {
            "name": "View a company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/companies/:company_id",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The ID of the company."
              }
            ]
          },
          "docs": "Retrieves the details of a specific company by its ID."
        },
        {
          "info": {
            "name": "Update a company",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{domain}.freshdesk.com/api/v2/companies/:company_id",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The ID of the company."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the properties of an existing company record."
        },
        {
          "info": {
            "name": "Delete a company",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{domain}.freshdesk.com/api/v2/companies/:company_id",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The ID of the company."
              }
            ]
          },
          "docs": "Deletes a company record from the helpdesk."
        }
      ]
    },
    {
      "info": {
        "name": "Agents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all agents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/agents",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page (max 100)."
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter agents by email address."
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Filter agents by state."
              }
            ]
          },
          "docs": "Retrieves a paginated list of all agents in the helpdesk. Supports filtering by email and state."
        },
        {
          "info": {
            "name": "View an agent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path",
                "description": "The ID of the agent."
              }
            ]
          },
          "docs": "Retrieves the details of a specific agent by their ID."
        },
        {
          "info": {
            "name": "Update an agent",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{domain}.freshdesk.com/api/v2/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path",
                "description": "The ID of the agent."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the properties of an existing agent."
        }
      ]
    },
    {
      "info": {
        "name": "Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/groups",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page (max 100)."
              }
            ]
          },
          "docs": "Retrieves a list of all agent groups in the helpdesk."
        },
        {
          "info": {
            "name": "Create a group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshdesk.com/api/v2/groups",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new agent group in the helpdesk."
        },
        {
          "info": {
            "name": "View a group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/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 by its ID."
        },
        {
          "info": {
            "name": "Update a group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{domain}.freshdesk.com/api/v2/groups/:group_id",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "The ID of the group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the properties of an existing agent group."
        },
        {
          "info": {
            "name": "Delete a group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{domain}.freshdesk.com/api/v2/groups/:group_id",
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "The ID of the group."
              }
            ]
          },
          "docs": "Deletes an agent group from the helpdesk."
        }
      ]
    },
    {
      "info": {
        "name": "Roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/roles"
          },
          "docs": "Retrieves a list of all agent roles configured in the helpdesk."
        },
        {
          "info": {
            "name": "View a role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/roles/:role_id",
            "params": [
              {
                "name": "role_id",
                "value": "",
                "type": "path",
                "description": "The ID of the role to retrieve."
              }
            ]
          },
          "docs": "Retrieves the details of a specific agent role by its ID."
        }
      ]
    },
    {
      "info": {
        "name": "Products",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all products",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/products"
          },
          "docs": "Retrieves a list of all products configured in the helpdesk."
        },
        {
          "info": {
            "name": "View a product",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/products/:product_id",
            "params": [
              {
                "name": "product_id",
                "value": "",
                "type": "path",
                "description": "The ID of the product to retrieve."
              }
            ]
          },
          "docs": "Retrieves the details of a specific product by its ID."
        }
      ]
    },
    {
      "info": {
        "name": "Email Configs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all email configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/email_configs"
          },
          "docs": "Retrieves a list of all email configurations for the helpdesk."
        }
      ]
    },
    {
      "info": {
        "name": "SLA Policies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all SLA policies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/sla_policies"
          },
          "docs": "Retrieves a list of all SLA policies configured in the helpdesk."
        }
      ]
    },
    {
      "info": {
        "name": "Business Hours",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all business hours",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/business_hours"
          },
          "docs": "Retrieves a list of all business hours configurations in the helpdesk."
        }
      ]
    },
    {
      "info": {
        "name": "Surveys",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all satisfaction ratings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/surveys/satisfaction_ratings",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page (max 100)."
              },
              {
                "name": "created_since",
                "value": "",
                "type": "query",
                "description": "Filter ratings created since this timestamp."
              }
            ]
          },
          "docs": "Retrieves a list of all customer satisfaction ratings received for helpdesk tickets."
        }
      ]
    },
    {
      "info": {
        "name": "Time Entries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all time entries for a ticket",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id/time_entries",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              }
            ]
          },
          "docs": "Retrieves all time entries logged against a specific ticket."
        },
        {
          "info": {
            "name": "Create a time entry for a ticket",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id/time_entries",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Logs a new time entry against a specific ticket for tracking time spent on support activities."
        }
      ]
    }
  ],
  "bundled": true
}