The Basics

Projects

cmd=listProjects

Parameters
Takes fWrite (defaults to 0), ixProject, ixArea. 
Example
https://kakapo.fogbugz.com/api.asp?cmd=listAreas&token=04t6193822pekbba09nt74ninuihk2
Returns
A list of areas and associated data.

cmd=viewProject

Parameters
Takes ixProject or sProject.
Example
https://kakapo.fogbugz.com/api.asp?cmd=viewProject&ixProject=10&token=04t6193822pekbba09nt74ninuihk2
Returns
Details of the project. 

cmd=newProject

Parameters
Takes only sProject (the title of the new projecT) ixPersonPrimaryContact, fAllowPublicSubmit, fInbox (default = 0).
Example
https://kakapo.fogbugz.com/api.asp?cmd=newProject&sProject=Cormorant&ixPersonPrimaryContact=11&token=04t6193822pekbba09nt74ninuihk2 
Returns
Data (akin to cmd=viewProject) for the newly created project.

Areas

cmd=listAreas

Parameters
Takes fWrite (defaults to 0), ixProject (defaults to 0), fIncludeDeleted (defaults to 0). 
Example
https://kakapo.fogbugz.com/api.asp?cmd=listAreas&token=04t6193822pekbba09nt74ninuihk2
Returns
A list of areas and associated data.

cmd=viewArea

Parameters
Takes ixArea or sArea AND ixProject.
Example
https://kakapo.fogbugz.com/api.asp?cmd=viewArea&ixArea=6&token=04t6193822pekbba09nt74ninuihk2
Returns
Details of the selected area.

cmd=newArea

Parameters
Takes only ixProject, sArea (the title of the new area), and ixPersonPrimaryContact (uses project's primary contact if set to -1).
Example
https://kakapo.fogbugz.com/api.asp?cmd=newArea&ixProject=10&sArea=Testing&ixPersonPrimaryContact=11&token=04t6193822pekbba09nt74ninuihk2
Returns
Data (akin to cmd=viewProject) for the newly created project.

List Projects (cmd=listProjects)

URL
https://kakapo.fogbugz.com/api.asp?cmd=listProjects&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.listProjects()

Parameters

  • 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.

Successful Response

For the sake of space, the sample below includes only one user. This command will return the details for all users between the <person> tags.

XML
<response>
  <project>
    <ixProject>10</ixProject>
    <sProject>
      <![CDATA[ Kakapo ]]>
    </sProject>
    <ixPersonOwner>15</ixPersonOwner>
    <sPersonOwner>
      <![CDATA[ Evelyn the Project Manager ]]>
    </sPersonOwner>
    <sEmail>
        <![CDATA[ evelyn@kakapo.com ]]>
    </sEmail>
    <sPhone/>
    <fInbox>false</fInbox>
    <ixWorkflow>1</ixWorkflow>
    <fDeleted>false</fDeleted>
  </project>
</response>

View Project (cmd=viewProject)

Examples

Using ixProject
URL
https://kakapo.fogbugz.com/api.asp?cmd=viewProject&ixProject=10&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.viewProject(ixProject=10)
Using sProject
URL
https://kakapo.fogbugz.com/api.asp?cmd=viewProject&sProject=Kakapo&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.viewProject(sProject="Kakapo")

Parameters

Takes ixProject or sProject.

Possible Responses

Successful Response
XML
<response>
  <project>
    <ixProject>10</ixProject>
    <sProject>
      <![CDATA[ Kakapo ]]>
    </sProject>
    <ixPersonOwner>15</ixPersonOwner>
    <fInbox>false</fInbox>
    <fDeleted>false</fDeleted>
    <sPublicSubmitEmail/>
  </project>
</response>
No Matching Project
XML
</response>

Create a New Project (cmd=newProject)

URL
https://kakapo.fogbugz.com/api.asp?cmd=newProject&sProject=Cormorant&ixPersonPrimaryContact=11&token=04t6193822pekbba09nt74ninuihk2 
fogbugz.py
fb.newProjecT(sProject="Cormorant",ixPersonPrimaryContact=11)

Parameters

  • sProject
    • The title of the new project
  • ixPersonPrimaryContact
  • fAllowPublicSubmit
  • fInbox – default 0

Possible Responses

Successful Response
XML
<response>
  <project>
    <ixProject>15</ixProject>
    <sProject>
      <![CDATA[ Cormorant ]]>
    </sProject>
    <ixPersonOwner>11</ixPersonOwner>
    <fInbox>false</fInbox>
    <fDeleted>false</fDeleted>
    <sPublicSubmitEmail/>
  </project>
</response>

List Areas (cmd=listAreas)

URL
https://kakapo.fogbugz.com/api.asp?cmd=listAreas&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.listAreas()

Parameters

  • 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
  • ixAreaoptional
    • If included will always list at least this area even if it is deleted.

Successful Response

For the sake of space, the sample below includes only one user. This command will return the details for all users between the <person> tags.

XML
<response>
  <area>
    <ixArea>6</ixArea>
    <sArea>
      <![CDATA[ Spam ]]>
    </sArea>
    <ixProject>2</ixProject>
    <ixPersonOwner/>
    <sPersonOwner/>
    <sProject>
      <![CDATA[ Inbox ]]>
    </sProject>
    <nType>3</nType>
    <cDoc>2</cDoc>
  </area>
</response>

View Area (cmd=viewArea)

URL
https://kakapo.fogbugz.com/api.asp?cmd=viewArea&ixAreas=6&token=04t6193822pekbba09nt74ninuihk2
fogbugz.py
fb.viewArea(ixArea=6)

Parameters

Takes ixArea OR (sArea and ixProject)

Possible Responses

Successful Response
XML
<response>
  <area>
    <ixArea>6</ixArea>
    <sArea>
      <![CDATA[ Spam ]]>
    </sArea>
    <ixProject>2</ixProject>
    <ixPersonOwner>-1</ixPersonOwner>
    <nType>3</nType>
    <cDoc>2</cDoc>
    <fDeleted>false</fDeleted>
  </area>
</response>
No Matching Project
XML
</response>

Create a New Area (cmd=newArea)

URL
https://kakapo.fogbugz.com/api.asp?cmd=newArea&ixProject=10&sArea=Testing&ixPersonPrimaryContact=11&token=04t6193822pekbba09nt74ninuihk2 
fogbugz.py
fb.newArea(ixProject=10,
				sArea="Testing",
				ixPersonPrimaryContact=11)

Parameters

  • ixProject
  • sArea
      The title of the new area
  • ixPersonPrimaryContact
    • If ixPersonPrimaryContact is -1, will use project’s primary contact.

Possible Responses

Successful Response
XML
<response>
  <area>
    <ixArea>25</ixArea>
    <sArea>
      <![CDATA[ Testing ]]>
    </sArea>
    <ixProject>10</ixProject>
    <ixPersonOwner>-1</ixPersonOwner>
    <nType>0</nType>
    <cDoc>0</cDoc>
    <fDeleted>false</fDeleted>
  </area>
</response>
No Such Project
XML
</response>
Duplicate Area
XML
<response>
  <error code="19">
    <![CDATA[
      An area with this name already exists in this project.
    ]]>
  </error>
</response>