API documentation — Freshservice

Cited by

Facts read from this source

• Rest API Report an error

  “These APIs follow the Representational State Transfer (REST) architecture and support standard CRUD (Create, Read, Update, Delete) operations. They enable seamless integration with your service desk and support Cross-Origin Resource Sharing (CORS)”

• API version Report an error

  “Note: This documentation is for the v2.0 of the APIs.”

• Http verbs Report an error

  “Freshservice, FSBT, and Freshservice for MSPs APIs are plain JSON over HTTP and use the following HTTP verbs: Command Purpose POST Create an object GET Fetch one or more objects PUT Update an object / Restore an object DELETE Remove an object”

• Https only Report an error

  “All API requests should hit the secured endpoint i.e. only HTTPS”

• Custom cname Report an error

  “Works only via Freshservice domains and not via custom CNAMEs”

• Rate limit by plan Report an error

  “Action Freshservice Rate Limit / Min Starter Growth Pro Enterprise Overall Limit 100 200 400 500”

• Rate limit scope Report an error

  “This limit is applied on an account wide basis irrespective of factors such as the number of agents or IP addresses used to make the calls.”

• Authentication Report an error

  “Freshservice/Freshservice for Business Teams supports Basic Access Authorization only with API key.”

• Oauth Report an error

  “Freshservice APIs support Oauth authentication. Refer scopes required against the respective APIs.”

• Pagination Report an error

  “By default, the number of objects returned per page is 30. This can be adjusted by adding the per_page parameter to the query string. The maximum number of objects that can be retrieved per page is 100.”

• Deprecation policy Report an error

  “Changes that break a production level API such as removing attributes or making major changes to the API’s behavior will only be done with an advance notice of 60 days.”

• Beta APIs Report an error

  “Beta APIs may be removed or modified at any time without advance notice.”

• Attachments Report an error

  “Attachments are supported for the following endpoints Create a Ticket Update a Ticket Reply to a Ticket”

• Ticket attachment size limit Report an error

  “attachments array of objects Ticket attachments. The total size of these attachments cannot exceed 40 MB.”

• Ticket sources Report an error

  “Source Type Value Email 1 Portal 2 Phone 3 Chat 4 Feedback widget 5 Yammer 6 AWS Cloudwatch 7 Pagerduty 8 Walkup 9 Slack 10 Chatbot 11 Workplace 12 Employee Onboarding 13 Alerts 14 MS Teams 15 Employee Offboarding 18”

• Rate limit headers Report an error

  “X-RateLimit-Total Total number of API calls allowed per hour. X-RateLimit-Remaining The number of requests remaining in the current rate limit window.”

• Schema timestamps utc Report an error

  “All timestamps are returned in the UTC format, YYYY-MM-DDTHH:MM:SSZ.”

• Embedding Report an error

  “Embedding additional resources will consume 1 credit if performed from a SHOW action, and 3 credits if performed from a LIST action.”

• Deep pagination warning Report an error

  “When retrieving a list of objects, avoid making calls referencing page numbers over 500 (deep pagination). These are performance intensive calls and you may suffer from extremely long response times.”

• Rate limit minute based Report an error

  “Freshservice accounts created on or after 01-Sep-2020 will use minute-level rate limiting.”

• V2 json only Report an error

  “Only JSON is supported in V2”

3 facts read from this page are not shown because they could not be confirmed on the page as captured.

Scores citing this record

• The Change & Configuration Manager Service desk, incidents & requests
• The Change & Configuration Manager Change, problem & release management
• The Change & Configuration Manager Assets, CMDB & discovery
• The Change & Configuration Manager Self-service portal & service catalog
• The Change & Configuration Manager Deployment, integrations & multi-client operation
• The Change & Configuration Manager Pricing transparency
• The MSP Owner Service desk, incidents & requests
• The MSP Owner Change, problem & release management
• The MSP Owner Assets, CMDB & discovery
• The MSP Owner Self-service portal & service catalog
• The MSP Owner Deployment, integrations & multi-client operation
• The MSP Owner European sovereignty
• The MSP Owner Pricing transparency
• The Municipal IT Lead Service desk, incidents & requests
• The Municipal IT Lead Change, problem & release management
• The Municipal IT Lead Assets, CMDB & discovery
• The Municipal IT Lead Self-service portal & service catalog
• The Municipal IT Lead Deployment, integrations & multi-client operation
• The Municipal IT Lead Pricing transparency
• The Service Desk Lead Service desk, incidents & requests
• The Service Desk Lead Change, problem & release management
• The Service Desk Lead Assets, CMDB & discovery
• The Service Desk Lead Self-service portal & service catalog
• The Service Desk Lead Deployment, integrations & multi-client operation
• The Service Desk Lead Pricing transparency
• The Skeptic Service desk, incidents & requests
• The Skeptic Change, problem & release management
• The Skeptic Assets, CMDB & discovery
• The Skeptic Self-service portal & service catalog
• The Skeptic Deployment, integrations & multi-client operation
• The Skeptic Pricing transparency
• The Solo IT Admin Service desk, incidents & requests
• The Solo IT Admin Change, problem & release management
• The Solo IT Admin Assets, CMDB & discovery
• The Solo IT Admin Self-service portal & service catalog
• The Solo IT Admin Deployment, integrations & multi-client operation
• The Solo IT Admin Pricing transparency