Overview
This is your starting point for the FogBugz XML API reference documentation.
The detailed and elaborated documentation and usage of FogBugz XML API is available using the links listed here: FogBugz API Reference
You can find the complete API reference, listing all the methods, objects and fields that can be read and updated using FogBugz XML API with hands-on examples is available here: api.manuscript.com.
The FogBugz API makes it possible to programmatically do almost anything you can on the UI. The API can be used alone, or in conjunction with FogBugz webhooks and third-party services such as Slack, Salesforce, TestRail, and other tools, to build powerful integrations to improve your workflow and ensure a seamless connection between FogBugz and other systems.
Introduction
This article describes XML API version 8, which ships with FogBugz 8.1 and later (including FogBugz On-Demand). The FogBugz XML API is implemented as an ASP page that accepts GET or POST parameters and returns XML payload after the user has been authenticated. As of FogBugz 7, the XML API is included within FogBugz and does not need to be installed separately. Sample code that uses the API is included within FogBugz for your server in the FogBugzAccessoriesAPI folder, or you can use the examples available online here: api.manuscript.com
If you prefer JSON to XML, take a look at this alternative API endpoint in FogBugz On Demand (currently not available in the FogBugz On-Premise versions).
NOTE: If you are not interested in writing code, check out Zapier’s FogBugz Integrations or Contact Us.
Description
General rules for API requests
Please read: FogBugz XML API: General Rules for API Requests
Complete API Reference
The complete API reference, listing all objects and fields that can be read and written using FogBugz XML API with hands-on examples is available here: api.manuscript.com
FogBugz XML API
- Checking the API Version and location
- Logging On
- General rules for API requests
- Logging Off
- Filters
- Listing and Viewing Cases
- Editing Cases
- Lists
- Creating Elements
- Editing a Person
- Views
- Milestone Dependencies
- Working Schedule
- Time Tracking
- Source Control
- Tags
- Release Notes
- Milestones
- Wikis
- Discussion Groups
- BugzScout
- Subscriptions
- Email Correspondents
- Mark as viewed
- Star/unstar
- Settings
- Site Settings
- Evidence-Based Scheduling
- Increasing Case Numbers
- Sample XML Payloads
- Error Codes
- Event Codes
Miscellaneous Notes
- All parameters starting with the letters “dt” only accept times expressed in UTC (Coordinated Universal Time). Similarly, all return values starting with those letters will be expressed in UTC.
- Several members of our community have written API wrappers and other development tools to help with using the FogBugz XML API.
- If you need inspiration on how you could use FogBugz API with Python, you can check out our legacy documentation on this topic: FogBugz XML API usage with Python.
Please note: the Python scripting documentation might be outdated, and related source codes outdated. We do not provide any support for it. It is strictly left there for Python fans to get some inspiration for using Python with FogBugz API.