Overview

Using List you can get multiple relevant results from almost every area from FogBugz. Make sure you filter down your list with the specific arguments for each command.

Step-By-Step Guide

Cases

To list all cases, send cmd=listCases. The following arguments are available:

• sFilter – optional
  • Set this to filter cases.
• cols – optional
  • The columns you want to be returned about the case.
• max – optional
  • The maximum number of cases to be returned.

Projects

To list all undeleted Projects, send cmd=listProjects. The following arguments are available:

• fWrite=0 – optional
  • Set to 1 if you only want the list of projects you have permission to write to (i.e. can edit the cases in this project). If this is left off or set to 0, then the API assumes you are looking for all areas that you have permission to read.
• ixProject – optional
  • If included will always list at least this project even if it is deleted.
• fIncludeDeleted=0 – optional
  • Set to 1 to include deleted projects in the results.

Areas

To list all undeleted Areas, send cmd=listAreas. The following arguments are available:

• fWrite=0 – optional
  • Set to 1 if you only want the list of areas you have permission to write to (i.e. can edit the cases in this area). If this is left off or set to 0, then the API assumes you are looking for all projects that you have permission to read.
• ixProject  – optional
  • Only list areas from this project
• ixArea – optional
  • If included will always list at least this area even if it is deleted.

Categories

To list all Categories, send cmd=listCategories.

Priorities

To list all Priorities, send cmd=listPriorities.

People

To list all the People in the corresponding categories, send cmd=listPeople. The following arguments are available:

• fIncludeActive=1 – default 1
• fIncludeNormal=1 – default 1
• fIncludeDeleted=0 – default 0
• fIncludeCommunity=0 – default 0
• fIncludeVirtual=0 – default 0

Status

To list all the Status, send cmd=listStatus. The following arguments are available:

• ixCategory – optional
  • If included, limits results to statuses within this Category only
• fResolved=0
  • Set to 1 to have only resolved statuses in the result

Milestones

To list Milestones, send cmd=listFixFors. The following arguments are available:

• ixProject – optional
  • Only list milestones for this project, default behavior is to list all milestones
• ixFixFor – optional
  • If listing all milestones will include this milestone even if it’s unassignable (i.e. inactive),
• fIncludeDeleted=0 – default 0
  • Set to 1 to include inactive milestones (i.e. those that are marked unassignable)
• fIncludeReallyDeleted=0 – default 0
  • Set to 1 to include completely deleted milestones (i.e. no longer viewable or assignable)

Mailboxes

To list the mailboxes that you have acces to, send cmd=listMailboxes. Note the sTemplate field here will have placeholders you will need to replace ( such as {case} {subject} {ticketurl} etc). See the Mailboxes edit screen in FogBugz for more info.

Wikis

To list wikis, send cmd=listWikis.

Templates

To list wikis templates, send cmd=listTemplates.

Snippets

To list all the Snippets, send cmd=listSnippets. The following arguments are available:

• fGlobalOnly=0 – optional, default 0
  • Returns only global snippets. If this is left off or set to 0, both private and global snippets for the current user are returned.

See also the full XML API documentation.