We have had an API in Code Spaces for about a year now, but until now have neglected to tell a single soul... about 100 of you have spotted it and asked for details so finally here is a fancy guide.

We will be creating sample code for Ruby, C# and Java developers (and any other language you guys ask for) in the coming days.

Getting Started

In the Code Spaces admin section select the project you want to work with and select the API Settings tab.

You will notice a brief list of available functions and a check box to enable the API for this project.

Check the Enable API box and the functions you wish to use.

Now you have enabled the API you will need to use the API Key.

The Api is a simple RESTful service and uses the following URL conventions:

https://[your_account].codespaces.com/api/[resource].xml

When you hit this URL you will be prompted for a username and password, the username is your API key and the password is blank.

Resources

List Work Items - Retrieve a list of work items.
URL (GET) : https://[your_account].codespaces.com/api/work_items

Edit Work Items - Update existing work items.
URL (PUT) : https://[your_account].codespaces.com/api/work_items/wi_id/

Create Work Items - Create a new work items.
URL (PUT) : https://[your_account].codespaces.com/api/work_items/

Project Details - Retrieve information about the current project.
URL (PUT) : https://[your_account].codespaces.com/api/work_items/

List Project Components - Retrieve a list of Project Components.
URL (GET) : https://[your_account].codespaces.com/api/project

List Project Milestones - Retrieve a list of Project Milestones.
URL (GET) : https://[your_account].codespaces.com/api/project_milestones

List Project Users - Retrieve a list of Project Users.
URL (GET) : https://[your_account].codespaces.com/api/users

List Work Item Priorities - Retrieve a list of Work Item Priorities
URL (GET) : https://[your_account].codespaces.com/api/work_item_priorities

List Work Item Statuses - Retrieve a list of Work Item Statuses
URL (GET) : https://[your_account].codespaces.com/api/work_item_statuses

List Work Item Types - Retrieve a list of Work Item Types
URL (GET) : https://[your_account].codespaces.com/api/work_item_types