What is it?
This document 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, or TestRail (and many others) to build powerful integrations to improve your workflow and make the connection between FogBugz and your other systems seamless.
Who will use it?
Any customer willing to integrate FogBugz with other platforms, or needing to get some extra details, can use the API.
How is it used?
Below, you’ll find some general rules for API requests as well as links to the detailed resources.
If you are not interested in writing code, Check out Zapier’s FogBugz integrations or contact us at firstname.lastname@example.org
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 <error>.
- All requests should be URL encoded.
- 1.1 Checking the API Version and location
- 1.2 Logging On
- 1.3 General rules for API requests
- 1.4 Logging Off
- 1.5 Filters
- 1.6 Listing and Viewing Cases
- 1.7 Editing Cases
- 1.8 Lists
- 1.9 Creating
- 1.10 Editing a Person
- 1.11 Views
- 1.12 Milestone Dependencies
- 1.13 Working Schedule
- 1.14 Time Tracking
- 1.15 Source Control
- 1.16 Tags
- 1.17 Release Notes
- 1.18 Milestones
- 1.19 Wikis
- 1.20 Discussion Groups
- 1.21 BugzScout
- 1.22 Subscriptions
- 1.23 Email Correspondents
- 1.24 Mark as viewed
- 1.25 Star/unstar (available with 8.2+)
- 1.26 Settings
- 1.27 Site Settings
- 1.28 Evidence-Based Scheduling
- 1.29 Increasing the case number
- 1.30 Sample XML Payloads
- 1.31 Error Codes
- 1.32 Event Codes