API Documentation

Getting Started

You need a key to access the API. You can create an API key from your account page

You must use SSL (https instead of http) to access the API.

Include your API key in the header of each request, like this:

apikey: your-api-key-here

This is a read-only API, for now. Access the data in your projects using the requests below.

When retrieving an Item, data that's specific to the kind of item is returned in the item's Body field.

Access top-level items such as actors and use cases.

API	Description
GET v1/project/{proj_id}/items?kind={kind}	Return items for a given project. If kind isn't specified, then all items will be returned.
GET v1/item/{item_id}	Return the item with the given ID.
GET v1/project/{proj_id}/item/{cc_id}	Return the item in the project that has the given CaseComplete ID.

Access issues that are associated with items in your project.

API	Description
GET v1/project/{proj_id}/issues?status={status}	Return all issues for the given project.

Access the projects stored in your account.

API	Description
GET v1/projects	Return all projects in the account.
GET v1/project/{proj_id}	Return the given project.

Access comments that have been added by people you've shared your project with.

API	Description
GET v1/project/{proj_id}/comments	Return all comments for the given project.