Accessing Axosoft Data

Once an access token is obtained, you can use it to access Axosoft data via the API by composing an HTTP request as follows:

Compose the URL

The API endpoints have the following URL form:

<BaseAxosoftURL>/api/<version>/<resource>

The resource can be e.g. projects (representing the collection of all projects), or projects/3 (representing the project with the ID 3).

A note about accessing resources such as defects or features: Axosoft allows for customization on many of the resource names within the Axosoft Suite - for example, instead of "Features" the system may be configured to use "User Stories" or some other term. Within the API however, such resources are always accessed via their internal names ("defects", "features", "incidents", and "tasks"). Here are how some of the default terminology settings in Axosoft map to resource names:

Include the Access Token

The access token can be included in the request in either of the following ways:

1. You can add a Authorization or X-Authorization header with the value Bearer <AccessToken>.
2. You can add a access_token parameter to the query part of the request URL.

Make the Request

Depending on the operation, you will need to send the resulting request as a GET, POST, or DELETE HTTP request. For example, you can retrieve an individual project (with ID 3) by issuing a GET request to:

https://youraccount.axosoft.com/api/v5/projects/3?access_token=10101010-1010-1010-1010-101010101010

If the request is successful, the response will be returned in JSON format.

{
    "data": {
        "description": "",
        "start_date": "2012-09-27T16:49:16Z",
        "is_active": true,
        "parent": {
            "id": 0,
            "name": "All Projects"
        },
        "id": 3,
        "name": "Corporate Web Site"
    }
}

For a full list of available API calls, please see the Full API Reference.