This article describes XML API version 8, which ships with FogBugz 8.1 and later. 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.
The FogBugz API makes it possible to programmatically do almost anything you can in the interface. 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.
Any customer willing to integrate FogBugz with other platforms, or needing to get some extra details, can use the API. Some general rules for API requests, as well as links to detailed resources, are listed below.
General rules for API requests
- In general, all requests can be either GET or POST. If you are submitting files, you must use a POST request with enctype=”multipart/form-data”.
- All API requests will have a cmd argument indicating the action you intend to take and a token argument. Parameters are passed with the request as name/value pairs.
FogBugz is going to be exclusively UTF-8.
- All dates should be in ISO 8601 UTC format, e.g. 2013-01-21T14:24:06Z. To avoid inconsistencies caused by individual user localization, we recommend using ISO for dates in search strings.
- The API will respond with an XML file in UTF-8 format containing an outer
<response>tag at the root.
- If something goes wrong, the first child node will be
- All requests should be URL encoded.
FogBugz XML API
- Checking the API Version and location
- Logging On
- General rules for API requests
- Logging Off
- Listing and Viewing Cases
- Editing Cases
- Creating Elements
- Editing a Person
- Milestone Dependencies
- Working Schedule
- Time Tracking
- Source Control
- Release Notes
- Discussion Groups
- Email Correspondents
- Mark as viewed
- Site Settings
- Evidence-Based Scheduling
- Increasing Case Numbers
- Sample XML Payloads
- Error Codes
- Event Codes
- 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.