Page Comparison

All API requests can be made by ActivityTimeline user with Administrator permission only.

Note
ActivityTimeline REST API is turned off by default. You must turn it on before the first use.

ActivityTimeline REST API can be turned on by changing ActivityTimeline REST API settingat Dashboard → Configuration → Advanced Settings page or AT REST API page:

How to Use REST API

Create a unique AT REST API authorization token in ActivityTimeline configuration
Call API methods with specifying that auth-token as a request Header or URL parameter (or auth_token before AT v8.3.0).

Sample Java/C# code of AT REST API usage

Sample Java project that demonstrates how to call AT REST API can be downloaded here (all API methods):

Sample .NET (C#) project that demonstrates how to call AT REST API can be downloaded here (some API methods):
Note
Important Note when calling AT REST API from JavaScript/Node.js code.
ActivityTimeline uses number identifiers that could be larger than JavaScript number type supports.
As a result, some JavaScript JSON parsers replace the last few digits of an 'id' with zeros making that 'id' invalid.
Example: Actual 'id' of 1235598463805867311 becomes 1235598463805867300

Authorization

You can authorize into the REST API by specifying a unique Authorization Token in one of 4 supported ways:

Add auth-token Header with the value of your Authorization Token (preferred)
Status
colour Green
title V8.3.0+
Add auth-token URL parameter with the value of your Authorization Token
Status
colour Green
title V8.3.0+
Status
colour Yellow
title DEPRECATED
Add auth_token Header with the value of your Authorization Token
Status
colour Yellow
title DEPRECATED
Add auth_token URL parameter with the value of your Authorization Token

Authorization Token can be generated at ActivityTimeline Configuration → AT REST API page. Handle it with the same security as you would a password.

Methods:

Timeline Schedule & Workload
Status
colour Green
title v4.2.0+

Expand

title	GET /rest/api/1/timeline?auth_token=YOUR_AUTH_TOKEN

Info
Returns information about user and events (Jira issues and custom events) for specified user for specified period of time.

Request

Code Block
GET /rest/api/1/timeline?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
start *	string	Start of the period formatted in "yyyy-MM-dd" format
end *	string	End of the period formatted in "yyyy-MM-dd" format
teamId *	long	Id of a specific team
eventType	string	Optional If specified then the system will filter returned items to the specified type. supported custom event type names: BOOKING, DAY_OFF, HOLIDAY, NOTE, PLACEHOLDER, SICK_LEAVE, VACATION. ISSUE for Jira issues only, WORKLOG for Jira worklogs only, empty - return all items in a period.

* indicates required parameters

Example

Code Block

https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline?teamId=1234567890&start=2016-07-11&end=2016-07-18&auth_token=YOUR_AUTH_TOKEN

https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline?teamId=1234567890&start=2018-11-30&end=2019-01-01&eventType=HOLIDAY&auth_token=YOUR_AUTH_TOKEN

https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline?teamId=1234567890&start=2018-11-30&end=2019-01-01&eventType=BOOKING&auth_token=YOUR_AUTH_TOKEN

https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline?teamId=1234567890&start=2018-11-30&end=2019-01-01&eventType=ISSUE&auth_token=YOUR_AUTH_TOKEN

https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline?teamId=1234567890&start=2018-11-30&end=2019-01-01&eventType=WORKLOG&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Example

Code Block

{
    "id": "1107507732947945188",
    "name": "External Team",
    "members": [
        {
            "id": "3786270175247354575",
            "involvement": 8,
            "personPosition": {
                "id": "8582213406392863840",
                "positionNameLong": "QA",
                "positionDescription": "QA Engineer"
            },
            "userRealName": "Amy Kartel",
            "email": "amy.kartel@company.com",
            "enabled": true,
            "username": "amy.kartel",
            "issues": [
                {
                    "id": "273688659851364550",
                    "issueId": 20003,
                    "issueKey": "TRP-10",
                    "summary": "[TRP-10] Incorrect wording on a label",
                    "plannedStart": "2016-07-13",
                    "plannedEnd": "2016-07-13",
                    "due": "",
                    "color": "Red",
                    "issueType": "JIRA_ISSUE",
                    "originalTimeEstimate": 0,
                    "remainingTimeEstimate": 0
                },
                {
                    "id": "10913502816060634",
                    "issueId": null,
                    "issueKey": "TRPae98fee1-96c1-4b0b-ada6-dd138e12e693",
                    "summary": "[Booking] Reperi Product | potential work",
                    "plannedStart": "2016-07-14",
                    "plannedEnd": "2016-07-15",
                    "due": "",
                    "color": null,
                    "issueType": "BOOKING",
                    "originalTimeEstimate": 7200,
                    "remainingTimeEstimate": 7200,
                    "estimatePerWorkDay": "yes",
                    "extraLink": "",
                    "approvedBy": null
                },
                {
                    "id": "4960169761522796814",
                    "issueId": 16802,
                    "issueKey": "TA-8",
                    "summary": "[TA-8] Choose ISP",
                    "plannedStart": "2016-07-14",
                    "plannedEnd": "2016-07-14",
                    "due": "",
                    "color": "None",
                    "issueType": "JIRA_ISSUE",
                    "originalTimeEstimate": 0,
                    "remainingTimeEstimate": 0
                },
                {
                    "id": "4445216931731619881",
                    "issueId": null,
                    "issueKey": "_AT_2db7247c-a0f5-4e3b-bfe5-4baf1df566fa",
                    "summary": "[Day Off] out of the office",
                    "plannedStart": "2016-07-11",
                    "plannedEnd": "2016-07-12",
                    "due": "",
                    "color": "Yellow",
                    "issueType": "DAY_OFF",
                    "originalTimeEstimate": 0,
                    "remainingTimeEstimate": 0,
                    "extraLink": "",
                    "approvedBy": null
                }
            ]
        },
        {
            "id": "4759616025136811794",
            "involvement": 4,
            "personPosition": {
                "id": "3712124335976172354",
                "positionNameLong": "Consultant",
                "positionDescription": null
            },
            "userRealName": "Bob Robinson",
            "email": "bob.robinson@company.com",
            "enabled": true,
            "username": "bob.robinson",
            "issues": [
                {
                    "id": "6068295962237947803",
                    "issueId": 15103,
                    "issueKey": "TDES-1",
                    "summary": "[TDES-1] Two new graphics",
                    "plannedStart": "2016-07-11",
                    "plannedEnd": "2016-07-22",
                    "due": "",
                    "color": null,
                    "issueType": "JIRA_ISSUE",
                    "originalTimeEstimate": 57600,
                    "remainingTimeEstimate": 144000
                }
            ]
        },
        {
            "id": "2612086174493854452",
            "involvement": 8,
            "personPosition": null,
            "userRealName": "Janny Miller",
            "email": "janny.miller@company.com",
            "enabled": true,
            "username": "janny.miller",
            "issues": [
                {
                    "id": "3121097772564302182",
                    "issueId": 15106,
                    "issueKey": "TDES-4",
                    "summary": "[TDES-4] Update default layout",
                    "plannedStart": "2016-07-12",
                    "plannedEnd": "2016-07-12",
                    "due": "",
                    "color": null,
                    "issueType": "JIRA_ISSUE",
                    "originalTimeEstimate": 14400,
                    "remainingTimeEstimate": 5400
                },
                {
                    "id": "3954119684277487799",
                    "issueId": 15105,
                    "issueKey": "TDES-3",
                    "summary": "[TDES-3] Update title styles",
                    "plannedStart": "2016-07-11",
                    "plannedEnd": "2016-07-11",
                    "due": "",
                    "color": "Purple",
                    "issueType": "JIRA_ISSUE",
                    "originalTimeEstimate": 0,
                    "remainingTimeEstimate": 0
                },
                {
                    "id": "4134472451282322432",
                    "issueId": 15100,
                    "issueKey": "TRP-1",
                    "summary": "[TRP-1] Implement Data Migration Script",
                    "plannedStart": "2016-07-13",
                    "plannedEnd": "2016-07-15",
                    "due": "",
                    "color": null,
                    "issueType": "JIRA_ISSUE",
                    "originalTimeEstimate": 57600,
                    "remainingTimeEstimate": 86400
                },
                {
                    "id": "41351470354940514",
                    "issueId": null,
                    "issueKey": "TRPddc956ec-bb5b-4201-85ab-8f4f32f50e2c",
                    "summary": "[Placeholder | TRP-4] Add Print dialog",
                    "plannedStart": "2016-07-12",
                    "plannedEnd": "2016-07-12",
                    "due": "",
                    "color": null,
                    "issueType": "PLACEHOLDER",
                    "originalTimeEstimate": 7200,
                    "remainingTimeEstimate": 7200,
                    "placeholderIssueKey": "TRP-4",
                    "extraLink": "",
                    "approvedBy": null
                }
            ]
        }
    ]
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/timeline/$username?auth_token=YOUR_AUTH_TOKEN

Info
Returns information about user and events (Jira issues and custom events) for specified user for specified period of time.

Request

Code Block
GET /rest/api/1/timeline/$username?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
start *	string	Start of the period formatted in "yyyy-MM-dd" format
end *	string	End of the period formatted in "yyyy-MM-dd" format
username *	string	Username or accountId of specific user
eventType	string	Optional If specified then the system will filter returned items to the specified type. supported custom event type names: BOOKING, DAY_OFF, HOLIDAY, NOTE, PLACEHOLDER, SICK_LEAVE, VACATION. ISSUE for Jira issues only, WORKLOG for Jira worklogs only, empty - return all items in a period.

* indicates required parameters

Example

Code Block

https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline/admin?start=2016-07-11&end=2016-07-18&auth_token=YOUR_AUTH_TOKEN
 
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline/admin?start=2018-11-30&end=2019-01-01&eventType=HOLIDAY&auth_token=YOUR_AUTH_TOKEN
 
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline/admin?start=2018-11-30&end=2019-01-01&eventType=BOOKING&auth_token=YOUR_AUTH_TOKEN
 
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline/admin?start=2018-11-30&end=2019-01-01&eventType=ISSUE&auth_token=YOUR_AUTH_TOKEN
 
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline/admin?start=2018-11-30&end=2019-01-01&eventType=WORKLOG&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Example

Code Block

{
    "id": "2641502681345183593",
    "involvement": 8.0,
    "personPosition": null,
    "userRealName": "Administrator",
    "email": "admin@company.com",
    "enabled": true,
    "username": "admin",
    "issues": [{
        "id": "1800561052349910244",
        "issueId": null,
        "issueKey": "_AT_-ce48f923-bb20-47c1-8a71-95aaa2742d6f",
        "summary": "Placeholder",
        "plannedStart": "2020-07-29",
        "plannedEnd": "2020-07-29",
        "due": "",
        "color": "Green",
        "issueType": "PLACEHOLDER",
        "originalTimeEstimate": 18000,
        "remainingTimeEstimate": 18000,
        "placeholderIssueKey": null,
        "extraLink": "",
        "approvedBy": null
    }, {
        "id": "2163682457033067837",
        "issueId": null,
        "issueKey": "ADP-eb93d739-4aa7-4b1b-9b19-7b283d3b6442",
        "summary": "[Placeholder | ADP-69] Test",
        "plannedStart": "2020-07-28",
        "plannedEnd": "2020-07-28",
        "due": "",
        "color": "Green",
        "issueType": "PLACEHOLDER",
        "originalTimeEstimate": 18000,
        "remainingTimeEstimate": 18000,
        "placeholderIssueKey": "ADP-69",
        "extraLink": "",
        "approvedBy": null
    }, {
        "id": "4519045037419348631",
        "issueId": null,
        "issueKey": "ADP-6a2eb537-bf08-4403-a07a-2e8c8b520994",
        "summary": "[Placeholder | ADP-63] My team issue",
        "plannedStart": "2020-07-30",
        "plannedEnd": "2020-07-30",
        "due": "",
        "color": "Green",
        "issueType": "PLACEHOLDER",
        "originalTimeEstimate": 225000,
        "remainingTimeEstimate": 225000,
        "placeholderIssueKey": "ADP-63",
        "extraLink": "",
        "approvedBy": null
    }, {
        "id": "7749083366501270133",
        "issueId": null,
        "issueKey": "ADP-74f4b492-a4b9-432e-a463-cda63a7d447c",
        "summary": "[Placeholder | ADP-66] API issue",
        "plannedStart": "2020-07-27",
        "plannedEnd": "2020-07-27",
        "due": "",
        "color": "Green",
        "issueType": "PLACEHOLDER",
        "originalTimeEstimate": 0,
        "remainingTimeEstimate": 248400,
        "placeholderIssueKey": "ADP-66",
        "extraLink": "",
        "approvedBy": null
    }]
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/workload?auth_token=YOUR_AUTH_TOKEN

Info
Returns information about users and workloads for specified team for specified period of time.

Request

Code Block
GET /rest/api/1/workload?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter

Type

Description

start *

string

Start of the period formatted in "yyyy-MM-dd" format

end *

string

End of the period formatted in "yyyy-MM-dd" format

teamId *

long

id of specified team

projectKey

string

Optional ^{ActivityTimeline v8.1.2 and above}
The system will output the per-user workload per specific project if
projectKey parameter is set

startOffset

int

Offset for first users, default is 0

maxUsers

int

Maximum users count to return, max 50

includeProjectDetails

boolean

Optional ^{Activity Timeline v8.2.0 and above}
If set to 'true" then the app will return break down of hours per project key.

Example:

Code Block

"username": "amy.kartel",
"workload": [
    {
        "day": "2021-07-12",
        "day0fWeek" : "mon",
        "hours": {
            "ABC": 4,
            "CDF": 2,
            "AMS": 0.5
        }
    },
    {
        "day": "2021-07-13",
        "day0fWeek": "tue",
        "hours": 0
    },
    ..........
    {
        "day": "2021-07-16",
        "dayOfWeek": "fri",
        "hours": {
              "CDF": 7,
              "AMS": 1
        }
    }         
]

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/workload?start=2016-07-11&end=2016-07-18&teamId=1107507732947945188&startOffset=0&maxUsers=50&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Example

Code Block

{
    "id": "1107507732947945188",
    "name": "External Team",
    "members": [
        {
            "id": "3786270175247354575",
            "involvement": 8,
            "personPosition": {
                "id": "8582213406392863840",
                "positionNameLong": "QA",
                "positionDescription": "QA Engineer"
            },
            "userRealName": "Amy Kartel",
            "email": "amy.kartel@company.com",
            "enabled": true,
            "username": "amy.kartel",
            "workload": [
                {
                    "day": "2016-07-10",
                    "dayOfWeek": "sun",
                    "hours": -1000
                },
                {
                    "day": "2016-07-11",
                    "dayOfWeek": "mon",
                    "hours": -2000
                },
                {
                    "day": "2016-07-12",
                    "dayOfWeek": "tue",
                    "hours": -2000
                },
                {
                    "day": "2016-07-13",
                    "dayOfWeek": "wed",
                    "hours": 0
                },
                {
                    "day": "2016-07-14",
                    "dayOfWeek": "thu",
                    "hours": 2
                },
                {
                    "day": "2016-07-15",
                    "dayOfWeek": "fri",
                    "hours": 2
                },
                {
                    "day": "2016-07-16",
                    "dayOfWeek": "sat",
                    "hours": -1000
                },
                {
                    "day": "2016-07-17",
                    "dayOfWeek": "sun",
                    "hours": -1000
                },
                {
                    "day": "2016-07-18",
                    "dayOfWeek": "mon",
                    "hours": 0
                },
                {
                    "day": "2016-07-19",
                    "dayOfWeek": "tue",
                    "hours": 0
                }
            ]
        },
        {
            "id": "4759616025136811794",
            "involvement": 4,
            "personPosition": {
                "id": "3712124335976172354",
                "positionNameLong": "Consultant",
                "positionDescription": null
            },
            "userRealName": "Bob Robinson",
            "email": "bob.robinson@company.com",
            "enabled": true,
            "username": "bob.robinson",
            "workload": [
                {
                    "day": "2016-07-10",
                    "dayOfWeek": "sun",
                    "hours": -1000
                },
                {
                    "day": "2016-07-11",
                    "dayOfWeek": "mon",
                    "hours": 4
                },
                {
                    "day": "2016-07-12",
                    "dayOfWeek": "tue",
                    "hours": 4
                },
                {
                    "day": "2016-07-13",
                    "dayOfWeek": "wed",
                    "hours": 4
                },
                {
                    "day": "2016-07-14",
                    "dayOfWeek": "thu",
                    "hours": 4
                },
                {
                    "day": "2016-07-15",
                    "dayOfWeek": "fri",
                    "hours": 4
                },
                {
                    "day": "2016-07-16",
                    "dayOfWeek": "sat",
                    "hours": -1000
                },
                {
                    "day": "2016-07-17",
                    "dayOfWeek": "sun",
                    "hours": -1000
                },
                {
                    "day": "2016-07-18",
                    "dayOfWeek": "mon",
                    "hours": 4
                },
                {
                    "day": "2016-07-19",
                    "dayOfWeek": "tue",
                    "hours": 4
                }
            ]
        },
        {
            "id": "2612086174493854452",
            "involvement": 8,
            "personPosition": null,
            "userRealName": "Janny Miller",
            "email": "janny.miller@company.com",
            "enabled": true,
            "username": "janny.miller",
            "workload": [
                {
                    "day": "2016-07-10",
                    "dayOfWeek": "sun",
                    "hours": -1000
                },
                {
                    "day": "2016-07-11",
                    "dayOfWeek": "mon",
                    "hours": 0
                },
                {
                    "day": "2016-07-12",
                    "dayOfWeek": "tue",
                    "hours": 3.5
                },
                {
                    "day": "2016-07-13",
                    "dayOfWeek": "wed",
                    "hours": 8
                },
                {
                    "day": "2016-07-14",
                    "dayOfWeek": "thu",
                    "hours": 8
                },
                {
                    "day": "2016-07-15",
                    "dayOfWeek": "fri",
                    "hours": 8
                },
                {
                    "day": "2016-07-16",
                    "dayOfWeek": "sat",
                    "hours": -1000
                },
                {
                    "day": "2016-07-17",
                    "dayOfWeek": "sun",
                    "hours": -1000
                },
                {
                    "day": "2016-07-18",
                    "dayOfWeek": "mon",
                    "hours": 0
                },
                {
                    "day": "2016-07-19",
                    "dayOfWeek": "tue",
                    "hours": 0
                }
            ]
        }
    ]
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/workload/$username?auth_token=YOUR_AUTH_TOKEN (since v8.3.0)

Info
Returns information about user and workloads for specified user for specified period of time.

Request

Code Block
GET /rest/api/1/workload/$username?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
start *	string	Start of the period formatted in "yyyy-MM-dd" format
end *	string	End of the period formatted in "yyyy-MM-dd" format
username *	string	Username or accountId of specific user

* indicates required parameters

Example

Code Block
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/workload/admin?start=2020-07-01&end=2020-07-30&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Example

Code Block

{
    "id": "2641502681345183593",
    "involvement": 8.0,
    "personPosition": null,
    "userRealName": "Administrator",
    "email": "admin@company.com",
    "enabled": true,
    "username": "admin",
    "workload": [{
        "day": "2020-07-01",
        "hours": 0,
        "dayOfWeek": "wed"
    }, {
        "day": "2020-07-02",
        "hours": 0,
        "dayOfWeek": "thu"
    }, {
        "day": "2020-07-03",
        "hours": 0,
        "dayOfWeek": "fri"
    }, {
        "day": "2020-07-04",
        "hours": 0,
        "dayOfWeek": "sat"
    }, {
        "day": "2020-07-05",
        "hours": 0,
        "dayOfWeek": "sun"
    }, {
        "day": "2020-07-06",
        "hours": 0,
        "dayOfWeek": "mon"
    }, {
        "day": "2020-07-07",
        "hours": 0,
        "dayOfWeek": "tue"
    }, {
        "day": "2020-07-08",
        "hours": 0,
        "dayOfWeek": "wed"
    }, {
        "day": "2020-07-09",
        "hours": 0,
        "dayOfWeek": "thu"
    }, {
        "day": "2020-07-10",
        "hours": 0,
        "dayOfWeek": "fri"
    }, {
        "day": "2020-07-11",
        "hours": 0,
        "dayOfWeek": "sat"
    }, {
        "day": "2020-07-12",
        "hours": 0,
        "dayOfWeek": "sun"
    }, {
        "day": "2020-07-13",
        "hours": 0,
        "dayOfWeek": "mon"
    }, {
        "day": "2020-07-14",
        "hours": 0,
        "dayOfWeek": "tue"
    }, {
        "day": "2020-07-15",
        "hours": 0,
        "dayOfWeek": "wed"
    }, {
        "day": "2020-07-16",
        "hours": 0,
        "dayOfWeek": "thu"
    }, {
        "day": "2020-07-17",
        "hours": 0,
        "dayOfWeek": "fri"
    }, {
        "day": "2020-07-18",
        "hours": 0,
        "dayOfWeek": "sat"
    }, {
        "day": "2020-07-19",
        "hours": 0,
        "dayOfWeek": "sun"
    }, {
        "day": "2020-07-20",
        "hours": 0,
        "dayOfWeek": "mon"
    }, {
        "day": "2020-07-21",
        "hours": 0,
        "dayOfWeek": "tue"
    }, {
        "day": "2020-07-22",
        "hours": 0,
        "dayOfWeek": "wed"
    }, {
        "day": "2020-07-23",
        "hours": 0,
        "dayOfWeek": "thu"
    }, {
        "day": "2020-07-24",
        "hours": 0,
        "dayOfWeek": "fri"
    }, {
        "day": "2020-07-25",
        "hours": 0,
        "dayOfWeek": "sat"
    }, {
        "day": "2020-07-26",
        "hours": 0,
        "dayOfWeek": "sun"
    }, {
        "day": "2020-07-27",
        "hours": 0,
        "dayOfWeek": "mon"
    }, {
        "day": "2020-07-28",
        "hours": 0,
        "dayOfWeek": "tue"
    }, {
        "day": "2020-07-29",
        "hours": 0,
        "dayOfWeek": "wed"
    }, {
        "day": "2020-07-30",
        "hours": 62.5,
        "dayOfWeek": "thu"
    }, {
        "day": "2020-07-31",
        "hours": 0,
        "dayOfWeek": "fri"
    }]
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/availability?auth_token=YOUR_AUTH_TOKEN (since v9.5.4)

Info
Returns information about availability of users of a specific team for a specified period of time. User’s availability means how many hours of work user still has capacity to do taking into account currently scheduled tasks on that user.

Request

Code Block
GET /rest/api/1/availability?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
start *	string	Start of the period formatted in "yyyy-MM-dd" format
end *	string	End of the period formatted in "yyyy-MM-dd" format
teamId *	long	id of specified team
startOffset	int	Offset for first users, default is 0
maxUsers	int	Maximum users count to return, max 50

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/availability?start=2023-02-11&end=2023-02-18&teamId=5648895637201243664&startOffset=0&maxUsers=50&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Example

Code Block

{
   "id":"5648895637201243664",
   "name":"Sample Team",
   "members":[
      {
         "id":"5412165287981567372",
         "involvement":8.0,
         "personPosition":null,
         "userRealName":"Fefofi",
         "email":"person@company.com",
         "enabled":true,
         "username":"63c83eb49d59ec705fedddddd",
         "availability":[
            {
               "day":"2023-02-11",
               "hours":"0",
               "dayOfWeek":"sat"
            },
            {
               "day":"2023-02-12",
               "hours":"0",
               "dayOfWeek":"sun"
            },
            {
               "day":"2023-02-13",
               "hours":"8",
               "dayOfWeek":"mon"
            },
            {
               "day":"2023-02-14",
               "hours":"8",
               "dayOfWeek":"tue"
            },
            {
               "day":"2023-02-15",
               "hours":"8",
               "dayOfWeek":"wed"
            },
            {
               "day":"2023-02-16",
               "hours":"8",
               "dayOfWeek":"thu"
            },
            {
               "day":"2023-02-17",
               "hours":"8",
               "dayOfWeek":"fri"
            },
            {
               "day":"2023-02-18",
               "hours":"0",
               "dayOfWeek":"sat"
            }
         ]
      }
   ]
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/availability/$username?auth_token=YOUR_AUTH_TOKEN (since v9.5.4)

Info
Returns information about availability of a specific user for a specified period of time. User’s availability means how many hours of work user still has capacity to do taking into account currently scheduled tasks on that user.

Request

Code Block
GET rest/api/1/availability/$username?auth_token==YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
start *	string	Start of the period formatted in "yyyy-MM-dd" format
end *	string	End of the period formatted in "yyyy-MM-dd" format

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/availability/63c83eb49d59ec705dddddd?start=2023-02-11&end=2023-02-18&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Example

Code Block

{
   "id":"5412165287981567372",
   "involvement":8.0,
   "personPosition":null,
   "userRealName":"Fefofi",
   "email":"person@company.com",
   "enabled":true,
   "username":"63c83eb49d59ec705fdddddd",
   "availability":[
      {
         "day":"2023-02-11",
         "hours":"0",
         "dayOfWeek":"sat"
      },
      {
         "day":"2023-02-12",
         "hours":"0",
         "dayOfWeek":"sun"
      },
      {
         "day":"2023-02-13",
         "hours":"8",
         "dayOfWeek":"mon"
      },
      {
         "day":"2023-02-14",
         "hours":"8",
         "dayOfWeek":"tue"
      },
      {
         "day":"2023-02-15",
         "hours":"8",
         "dayOfWeek":"wed"
      },
      {
         "day":"2023-02-16",
         "hours":"8",
         "dayOfWeek":"thu"
      },
      {
         "day":"2023-02-17",
         "hours":"8",
         "dayOfWeek":"fri"
      },
      {
         "day":"2023-02-18",
         "hours":"0",
         "dayOfWeek":"sat"
      }
   ]
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/capacity?auth_token=YOUR_AUTH_TOKEN (since v9.5.4)

Info
Returns information about total capacity of users of a specific team for a specified period of time. User’s capacity means how many hours of work user can do each day ignoring currently scheduled tasks on that user.

Request

Code Block
GET /rest/api/1/capacity?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
start *	string	Start of the period formatted in "yyyy-MM-dd" format
end *	string	End of the period formatted in "yyyy-MM-dd" format
teamId *	long	id of specified team
startOffset	int	Offset for first users, default is 0
maxUsers	int	Maximum users count to return, max 50

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/capacity?start=2023-02-11&end=2023-02-18&teamId=5648895637201243664&startOffset=0&maxUsers=50&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Example

Code Block

{
   "id":"5648895637201243664",
   "name":"Sample Team",
   "members":[
      {
         "id":"5412165287981567372",
         "involvement":8.0,
         "personPosition":null,
         "userRealName":"Fefofi",
         "email":"person@company.com",
         "enabled":true,
         "username":"63c83eb49d59ec70dddddd",
         "capacity":[
            {
               "day":"2023-02-11",
               "hours":"0",
               "dayOfWeek":"sat"
            },
            {
               "day":"2023-02-12",
               "hours":"0",
               "dayOfWeek":"sun"
            },
            {
               "day":"2023-02-13",
               "hours":"8",
               "dayOfWeek":"mon"
            },
            {
               "day":"2023-02-14",
               "hours":"8",
               "dayOfWeek":"tue"
            },
            {
               "day":"2023-02-15",
               "hours":"8",
               "dayOfWeek":"wed"
            },
            {
               "day":"2023-02-16",
               "hours":"8",
               "dayOfWeek":"thu"
            },
            {
               "day":"2023-02-17",
               "hours":"8",
               "dayOfWeek":"fri"
            },
            {
               "day":"2023-02-18",
               "hours":"0",
               "dayOfWeek":"sat"
            }
         ]
      }
   ]
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/capacity/$username?auth_token=YOUR_AUTH_TOKEN (since v9.5.4)

Info
Returns information about total capacity of a specific user for a specified period of time. User’s capacity means how many hours of work user can do each day ignoring currently scheduled tasks on that user.

Request

Code Block
GET rest/api/1/capacity/$username?auth_token==YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
start *	string	Start of the period formatted in "yyyy-MM-dd" format
end *	string	End of the period formatted in "yyyy-MM-dd" format

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/capacity/63c83eb49d59ec705dddddd?start=2023-02-11&end=2023-02-18&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Example

Code Block

{
   "id":"5412165287981567372",
   "involvement":8.0,
   "personPosition":null,
   "userRealName":"Fefofi",
   "email":"person@company.com",
   "enabled":true,
   "username":"63c83eb49d59ec705dddddd",
   "capacity":[
      {
         "day":"2023-02-11",
         "hours":"0",
         "dayOfWeek":"sat"
      },
      {
         "day":"2023-02-12",
         "hours":"0",
         "dayOfWeek":"sun"
      },
      {
         "day":"2023-02-13",
         "hours":"8",
         "dayOfWeek":"mon"
      },
      {
         "day":"2023-02-14",
         "hours":"8",
         "dayOfWeek":"tue"
      },
      {
         "day":"2023-02-15",
         "hours":"8",
         "dayOfWeek":"wed"
      },
      {
         "day":"2023-02-16",
         "hours":"8",
         "dayOfWeek":"thu"
      },
      {
         "day":"2023-02-17",
         "hours":"8",
         "dayOfWeek":"fri"
      },
      {
         "day":"2023-02-18",
         "hours":"0",
         "dayOfWeek":"sat"
      }
   ]
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Custom events
Status
colour Green
title v4.5.5+

Expand

title	POST /rest/api/1/event?auth_token=YOUR_AUTH_TOKEN

Info
Creates a new custom event.

Request

Code Block
POST /rest/api/1/event?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
start *	string	Start of the period formatted in "yyyy-MM-dd" format
end *	string	End of the period formatted in "yyyy-MM-dd" format
username *	string	Assignee username (Jira Server) or accountld (Jira Cloud)
eventTypeld *	long	id of eventType
eventTitle *	string	Title of event
projectKey (optional)	string	Key of target project (Booking, Placeholder and Note types)
hours (optional)	number	Booking event estimate in hours / hours for partial Day Off event
estimate (optional)	number	Estimate in hours for Placeholder event type Available starting from AT v7.3.5
color (optional)	string	Set custom Color for the newly created event. Possible values: `Red` `Orange` `Yellow` `Green` `Blue` `Purple` `Violet` `Livid` `Teal` `Silver` `Olive` `Gray` Available starting from AT v9.5.5
isApproved (optional)	string	If set to "true" then custom event will be created pre-approved. Applicable to Placeholder, Vacation and Booking event types. Available starting from AT v5.0.7
teamId (optional)	number	Id of a team. A new event will be created on a Team Panel of that team. Supported event types: Note, Booking and Placeholder (and custom event types based on those three types). username parameter must not be specified if teamId parameter is specified. Available starting from AT v9.7.0

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event?username=admin&eventTypeId=240025532758377186&eventTitle=someTitle&projectKey=TPA&hours=7&start=2016-11-14&end=2016-11-14&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "users":["admin"], "message":"admin\|\|\|<b>Booking</b> has been successfully created for admin.", "result":true, "id":3728690601734324315 }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/event/$id?auth_token=YOUR_AUTH_TOKEN (since v9.3.2)

Info
Get a single custom event data by id.

Request

Code Block
GET /rest/api/1/event/$id?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	number	ID of custom event

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event/29686068180042429?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns custom event JSON data.

Example

Code Block

{
    "id": "29686068180042429",
    "issueId": null,
    "issueKey": "SCRUM2b4e3596-31f2-4099-bf80-89765656975",
    "projectKey": "SCRUM",
    "summary": "[Booking] Scrum Project | Reservation",
    "plannedStart": "2022-07-18",
    "plannedEnd": "2022-07-31",
    "due": "",
    "color": "Green",
    "issueType": "BOOKING",
    "originalTimeEstimate": 28800,
    "remainingTimeEstimate": 28800,
    "estimatePerWorkDay": "yes",
    "extraLink": "",
    "approvedBy": null,
    "username": "557058:387baa8b-b43f-452e-cee0-08965456768"
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 404

Returns if custom event does not exist

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	PUT /rest/api/1/event?auth_token=YOUR_AUTH_TOKEN (since v9.7.0)

Info
Updates a custom event.

Request

Code Block
PUT /rest/api/1/event?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long number	Id of a custom event to update
start *	string	New Start date of the scheduled period formatted in "yyyy-MM-dd" format
end *	string	New End date of the scheduled period formatted in "yyyy-MM-dd" format
username*	string	New Assignee username (Jira Server) or accountld (Jira Cloud) to re-assign an item to
teamId (optional)	number	Id of Team to re-assign an item to / put an item on a Team Panel. Supported event types: Note, Booking and Placeholder (and custom event types based on those three types). If specified then username parameter is ignored.
title (optional)	string	New title for the item
projectKey (optional)	string	Key of target project (Booking, Placeholder, Overtime and Note types)
hours (optional)	number	Set estimate in hours per day for Issue / Issue part / Booking / Partial Day Off / Overtime events
estimate (optional)	number	Set total remaining estimate in hours for Placeholder events
color (optional)	string	New color for the event. Possible values: `Red` `Orange` `Yellow` `Green` `Blue` `Purple` `Violet` `Livid` `Teal` `Silver` `Olive` `Gray`
isApproved (optional)	string	Defines whether event is approved or not (true - approved, false - not approved). Applicable to Placeholder, Vacation and Booking event types.

* indicates required parameters

Example

Code Block
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event/24002553275837718634?title=New%20Title&start=2023-11-14&end=2023-11-14&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "users":["admin"], "message":"admin\|\|\|<b>Booking</b> has been successfully updated for admin.", "result":true, "id":24002553275837718634 }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	DELETE /rest/api/1/event/$id?auth_token=YOUR_AUTH_TOKEN

Info
Deletes a custom event.

Request

Code Block
DELETE /rest/api/1/event/$id?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	id of custom event

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event/312463?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns success message.

Example

Code Block
{ "message":"Event has been successfully deleted!" }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	POST /rest/api/1/event/$id/color?auth_token=YOUR_AUTH_TOKEN (since v9.5.5)

Info
Updates color of an issue/event on the timeline.

Request

Code Block
POST /rest/api/1/event/$id/color?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	id of custom event
color *	string	color of the event to be set. Possible values: `Red` `Orange` `Yellow` `Green` `Blue` `Purple` `Violet` `Livid` `Teal` `Silver` `Olive` `Gray`

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event/312463534535435/color?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns updated issue/event data.

Example

Code Block
{ "id": 312463534535435, ...... "summary": "Event title", "username": "bob.robinson" }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 404

Returns if issue/event does not exist

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN

Info
Returns a list of custom event types.

Request

Code Block
GET /rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns json representation of event types.

Example

Code Block

[
	{
		"id":240025532758377186,
		"name":"Booking",
		"eventType":"BOOKING",
		"eventTypeIconUrl":"../images/jira/icons/eventTypes/at_booking.png",
		"isSystemEventType":true,
		"isMilestoneEventType":false
	},
    {
		"id":143598346239228823,
		"name":"Vacation",
		"eventType":"VACATION",
		"eventTypeIconUrl":"../images/jira/icons/eventTypes/at_vacation.png",
		"isSystemEventType":true,
		"isMilestoneEventType":false
	},
	{
		"id":308729741261950787,
		"name":"Placeholder",
		"eventType":"PLACEHOLDER",
		"eventTypeIconUrl":"../images/jira/icons/eventTypes/at_placeholder.png",
		"isSystemEventType":true,
		"isMilestoneEventType":false
	}
]

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Teams
Status
colour Green
title v8.3.0+

Expand

title	GET /rest/api/1/team/list?auth_token=YOUR_AUTH_TOKEN (since v4.5.5)

Info
Returns list of Activity Timeline teams.

Request

Code Block
GET /rest/api/1/team/list?auth_token=YOUR_AUTH_TOKEN

Responses

Status

colour	Green
title	status 200

application/json Returns json representation of the result if request performed successfully.

Example

Code Block
[{ "id": "1107507732947945188", "name": "External Team" }, { "id": "387281612195971911", "name": "Developers Team" }, { "id": "7756417552636331634", "name": "QA Team" }]

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/team/$teamId?auth_token=YOUR_AUTH_TOKEN

Info
Returns information about team and users in a specified team.

Request

Code Block
GET /rest/api/1/team/$teamId?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
teamId *	long	id of specific team

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/1107507732947945188?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Example

Code Block

{
    "id": "1107507732947945188",
    "name": "External Team",
    "members": [
        {
            "id": "3786270175247354575",
            "involvement": 8,
            "personPosition": {
                "id": "8582213406392863840",
                "positionNameLong": "QA",
                "positionDescription": "QA Engineer"
            },
            "userRealName": "Amy Kartel",
            "email": "amy.kartel@company.com",
            "enabled": true,
            "username": "amy.kartel",
            "skills": [
                {
                    "skill": {
                        "id": "6696288071248397937",
                        "skillName": "TESTING"
                    },
                    "level": {
                        "id": "2845444854505357930",
                        "levelName": "Advanced",
                        "levelColor": "#419B28",
                        "defaultLevel": false
                    }
                },
                {
                    "skill": {
                        "id": "9007657690122438304",
                        "skillName": "QA"
                    },
                    "level": {
                        "id": "2845444854505357930",
                        "levelName": "Advanced",
                        "levelColor": "#419B28",
                        "defaultLevel": false
                    }
                },
                {
                    "skill": {
                        "id": "5423046373371626385",
                        "skillName": "JIRA"
                    },
                    "level": {
                        "id": "8309150234355319522",
                        "levelName": "Intermediate",
                        "levelColor": "#FCA800",
                        "defaultLevel": true
                    }
                },
                {
                    "skill": {
                        "id": "495820420823861967",
                        "skillName": "TEST CASES"
                    },
                    "level": {
                        "id": "8309150234355319522",
                        "levelName": "Intermediate",
                        "levelColor": "#FCA800",
                        "defaultLevel": true
                    }
                },
                {
                    "skill": {
                        "id": "5159432958879026484",
                        "skillName": "TEST PLAN"
                    },
                    "level": {
                        "id": "7372549001497429227",
                        "levelName": "Basic",
                        "levelColor": "#C2D2E8",
                        "defaultLevel": false
                    }
                }
            ]
        },
        {
            "id": "4759616025136811794",
            "involvement": 4,
            "personPosition": {
                "id": "3712124335976172354",
                "positionNameLong": "Consultant",
                "positionDescription": null
            },
            "userRealName": "Bob Robinson",
            "email": "bob.robinson@company.com",
            "enabled": true,
            "username": "bob.robinson",
            "skills": [
                {
                    "skill": {
                        "id": "6393636176441000868",
                        "skillName": "CONSULTING"
                    },
                    "level": {
                        "id": "7372549001497429227",
                        "levelName": "Basic",
                        "levelColor": "#C2D2E8",
                        "defaultLevel": false
                    }
                },
                {
                    "skill": {
                        "id": "6433704713829763909",
                        "skillName": "EMAIL"
                    },
                    "level": {
                        "id": "8309150234355319522",
                        "levelName": "Intermediate",
                        "levelColor": "#FCA800",
                        "defaultLevel": true
                    }
                },
                {
                    "skill": {
                        "id": "2081234984920762007",
                        "skillName": "COMMUNICATION"
                    },
                    "level": {
                        "id": "2845444854505357930",
                        "levelName": "Advanced",
                        "levelColor": "#419B28",
                        "defaultLevel": false
                    }
                }
            ]
        },
        {
            "id": "2612086174493854452",
            "involvement": 8,
            "personPosition": null,
            "userRealName": "Janny Miller",
            "email": "janny.miller@company.com",
            "enabled": true,
            "username": "janny.miller",
            "skills": [
                {
                    "skill": {
                        "id": "4881094816891751527",
                        "skillName": "DESIGN"
                    },
                    "level": {
                        "id": "7372549001497429227",
                        "levelName": "Basic",
                        "levelColor": "#C2D2E8",
                        "defaultLevel": false
                    }
                },
                {
                    "skill": {
                        "id": "2918480463760540781",
                        "skillName": "PHOTOSHOP"
                    },
                    "level": {
                        "id": "8309150234355319522",
                        "levelName": "Intermediate",
                        "levelColor": "#FCA800",
                        "defaultLevel": true
                    }
                }
            ]
        }
    ]
}

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	DELETE /rest/api/1/team/$id?auth_token=YOUR_AUTH_TOKEN

Info
Deletes team.

Request

Code Block
DELETE /rest/api/1/team/$id?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	id of team

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns success message.

Example

Code Block
{ "message": "Team successfully deleted" }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	POST /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN

Info
Add user to the team.

Request

Code Block
POST /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	Id of team
username *	string	Username of user who will be added to the team

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/member?auth_token=YOUR_AUTH_TOKEN&username=admin

Responses

Status
colour Green
title status 200
application/json Returns success message.

Example

Code Block
{ 'message':'User successfully added to Team [BP] Business Project Team' }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	DELETE /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN

Info
Remove user from the team.

Request

Code Block
DELETE /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	id of team
username *	string	Username of user who will be removed from the team

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/member?auth_token=YOUR_AUTH_TOKEN&username=admin

Responses

Status
colour Green
title status 200
application/json Returns success message.

Example

Code Block
{ 'message':'User successfully removed from Team [BP] Business Project Team' }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN

Info
Get the list of team managers.

Request

Code Block
GET /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	id of team

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns success message.

Example

Code Block
[{ "fullName": "Administrator", "username": "admin" }]

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	POST /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN

Info
Add team manager to the team.

Request

Code Block
POST /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	id of team
username *	string	Username of user who will be added to the team managers

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN&username=admin

Responses

Status
colour Green
title status 200
application/json Returns success message.

Example

Code Block
{ "message": "User successfully added to Team Managers" }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	DELETE /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN

Info
Remove user from the team managers.

Request

Code Block
DELETE /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	id of team
username *	string	Username of user who will be removed from the team managers

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN&username=admin

Responses

Status
colour Green
title status 200
application/json Returns success message.

Example

Code Block
{ "message": "User successfully removed from Team Managers." }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Projects
Status
colour Green
title v8.3.0+

Expand

title	GET /rest/api/1/project/list?auth_token=YOUR_AUTH_TOKEN

Info
Returns list of Activity Timeline projects by portions of 100.

Request

Code Block
GET /rest/api/1/project/list?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter

Type

Description

startOffset

integer

Offset for the first project, default is 0

state

Status

colour	Green
title	v9.2.0+

string

If specified then only projects of specified state will be returned. Should be either "active" or "inactive"

* indicates required parameters

Responses

Status

colour	Green
title	status 200

application/json Returns json representation of the result if request performed successfully.

Example

Code Block

[{
    "id": 230762418407883660,
    "name": "Sprint project",
    "projectKey": "SPRINT",
    "state": "inactive"
}, {
    "id": 385656806786155406,
    "name": "Agile adaptation",
    "projectKey": "AGILE",
    "state": "active"
}, {
    "id": 466697191147325533,
    "name": "New Features Proj",
    "projectKey": "NFP",
    "state": "active"
},  {
    "id": 847848775082921846,
    "name": "Project Managment",
    "projectKey": "PM",
    "state": "active"
},  {
    "id": 1074321572696248313,
    "name": "Automation Project",
    "projectKey": "AP",
    "state": "active"
}, {
    "id": 1414612396227578312,
    "name": "Business Project ",
    "projectKey": "BP",
    "state": "active"
}]

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	POST /rest/api/1/project/$id/state?auth_token=YOUR_AUTH_TOKEN

Info
Change the project state between active (enabled in the app) and inactive (disabled in the app).

Request

Code Block
POST /rest/api/1/project/$id/state?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	id of project
state *	string	Project state. Should be either "active" or "inactive"

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/project/1074321572696248313/state?auth_token=YOUR_AUTH_TOKEN&state=inactive

Responses

Status
colour Green
title status 200
application/json Returns success message.

Example

Code Block
{ "message": "Project successfully updated", "projectId": "1074321572696248313", "state": "inactive" }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Users
Status
colour Green
title v8.3.0+

Expand

title	GET /rest/api/1/user?auth_token=YOUR_AUTH_TOKEN

Info
Get paginated user list. Returns 100 users.

Request

Code Block
GET /rest/api/1/user?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
startOffset *	string	Offset for first user, default is 0

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
[{ "fullName": "Administrator", "username": "admin" }, { "fullName": "Anna Jons", "username": "anna" }, { "fullName": "Erik Plain", "username": "erik" }]

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/user/$username?auth_token=YOUR_AUTH_TOKEN

Info
Get detailed user data.

Request

Code Block
GET /rest/api/1/user/$username?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
username *	string	Username or accountId of specific user

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block

{
    "fullName": "Administrator",
    "position": {
        "id": 6343917500869986762,
        "positionDescription": null,
        "positionNameLong": "Developer"
    },
    "skillLevels": [{
        "level": {
            "defaultLevel": false,
            "id": 3239422491610663746,
            "levelColor": "#FCA800",
            "levelName": "Intermediate"
        },
        "skill": {
            "id": "5038994036906348198",
            "skillName": "JAVA"
        }
    }],
    "username": "admin"
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/user/$username/skill?auth_token=YOUR_AUTH_TOKEN

Info
Get user's skills.

Request

Code Block
GET /rest/api/1/user/$username/skill?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
username *	string	Username or accountId of specific user

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
[{ "level": { "defaultLevel": false, "id": 3239422491610663746, "levelColor": "#FCA800", "levelName": "Intermediate" }, "skill": { "id": "5038994036906348198", "skillName": "JAVA" } }]

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	DELETE /rest/api/1/user/$username/skill?auth_token=YOUR_AUTH_TOKEN

Info
Remove all skills from the user.

Request

Code Block
DELETE /rest/api/1/user/$username/skill?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
username *	string	Username or accountId of specific user

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "message": "Skills successfully removed from user.", "username": "admin" }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	POST /rest/api/1/user/$username/skill/$skillId?auth_token=YOUR_AUTH_TOKEN

Info
Assign a skill to user.

Request

Code Block
POST /rest/api/1/user/$username/skill/$skillId?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
username *	string	Username or accountId of specific user
skillId	long	Skill ID
levelId	long	Level for assigned skill

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill/356054081858522338?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "message": "Skill successfully assigned to user.", "skillId": 356054081858522338, "username": "admin" }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	DELETE /rest/api/1/user/$username/skill/$skillId?auth_token=YOUR_AUTH_TOKEN

Info
Remove a skill from the user.

Request

Code Block
DELETE /rest/api/1/user/$username/skill/$skillId?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
username *	string	Username or accountId of specific user
skillId	long	Skill ID

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill/356054081858522338?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "message": "Skill successfully removed from user.", "username": "admin" }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	POST /rest/api/1/user/$username/position?auth_token=YOUR_AUTH_TOKEN

Info
Add a position for the user.

Request

Code Block
POST /rest/api/1/user/$username/position?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
username *	string	Username or accountId of specific user
positionId	long	Position D

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/position?positionId=8219751323950402194&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "message": "Position successfully assigned to user", "username": "admin", "positionId": 8219751323950402194 }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	DELETE /rest/api/1/user/$username/position?auth_token=YOUR_AUTH_TOKEN

Info
Remove position from a user.

Request

Code Block
DELETE /rest/api/1/user/$username/position?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
username *	string	Username or accountId of specific user
positionId	long	Position Id

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/position?positionId=8219751323950402194&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "message": "Position successfully removed from user", "positionId": 8219751323950402194 }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Skills
Status
colour Green
title v8.3.0+

Expand

title	POST /rest/api/1/skill?auth_token=YOUR_AUTH_TOKEN

Info
Creates a new skill.

Request

Code Block
POST /rest/api/1/skill?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
name *	string	Skill name

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill?name=skillName&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "message": "Skill SKILL_NAME successfully created!", "skillId": 2217128537518329713 }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/skill?auth_token=YOUR_AUTH_TOKEN

Info
Get paginated list of skills. Returns 100 skills

Request

Code Block
GET /rest/api/1/skill?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
startOffset	int	Offset for the first skill, default is 0

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill?startOffSet=0&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block

[{
    "id": "356054081858522338",
    "skillName": "API"
}, {
    "id": "2047937836421629992",
    "skillName": "JS"
}, {
    "id": "2698045061671109178",
    "skillName": "CSS"
}, {
    "id": "3109049378266500399",
    "skillName": "SQL"
},  {
    "id": "5038994036906348198",
    "skillName": "JAVA"
}]

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/skill/$id?auth_token=YOUR_AUTH_TOKEN

Info
Get skill by Id.

Request

Code Block
GET /rest/api/1/skill/$id?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id	long	Skill Id

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill/5038994036906348198?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block

[{
    "level": {
        "id": 3239422491610663746,
        "levelName": "Intermediate"
    },
    "skill": {
        "id": "5038994036906348198",
        "skillName": "JAVA"
    },
    "users": [{
        "fullName": "Administrator",
        "username": "admin"
    }, {
        "fullName": "Erik Jons",
        "username": "erik"
    }]
}, {
    "level": {
        "id": 149100742758843112,
        "levelName": "Advanced"
    },
    "skill": {
        "id": "5038994036906348198",
        "skillName": "JAVA"
    },
    "users": [{
        "fullName": "Ana Lee",
        "username": "anna"
    }]
}]

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	POST /rest/api/1/skill/level?auth_token=YOUR_AUTH_TOKEN

Info
Creates a new skill proficiency level.

Request

Code Block
POST /rest/api/1/skill/level?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
name *	string	Skill proficiency level name
isDefault	boolean	Should it be the default proficiency level for new skills?
color *	string	Level color to display (HEX format), without hash symbol

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill/level?name=Expert&color=FCA800&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "message": "Level Expert successfully created!", "levelId": 8468734445048317988 }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/skill/level?auth_token=YOUR_AUTH_TOKEN

Info
Get paginated list of skill proficiency levels. Returns 100 skill levels

Request

Code Block
GET /rest/api/1/skill/level?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
startOffset	int	Offset for the first level, default is 0

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill/level?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block

[{
    "defaultLevel": false,
    "id": 149100742758843112,
    "levelColor": "#419B28",
    "levelName": "Advanced"
}, {
    "defaultLevel": false,
    "id": 2281499161498896296,
    "levelColor": "#03439C",
    "levelName": "Basic"
}, {
    "defaultLevel": false,
    "id": 3239422491610663746,
    "levelColor": "#FCA800",
    "levelName": "Intermediate"
}, {
    "defaultLevel": true,
    "id": 4033501717766817092,
    "levelColor": "#FCA800",
    "levelName": "Low"
}, {
    "defaultLevel": null,
    "id": 8468734445048317988,
    "levelColor": "#FCA800",
    "levelName": "Expert"
}]

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Positions
Status
colour Green
title v8.3.0+

Expand

title	POST /rest/api/1/position?auth_token=YOUR_AUTH_TOKEN

Info
Creates a new user position.

Request

Code Block
POST /rest/api/1/position?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
name *	string	User position name

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/position?name=Manager&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "message": "Position Manager successfully created!", "positionId": 3000053725301066422 }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/position?auth_token=YOUR_AUTH_TOKEN

Info
Get paginated list of positions. Returns 100 positions

Request

Code Block
GET /rest/api/1/position?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
startOffset	int	Offset for the first position, default is 0

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/position?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block

[{
    "id": 3000053725301066422,
    "positionDescription": "",
    "positionNameLong": "Manager"
}, {
    "id": 6265207833807701265,
    "positionDescription": "",
    "positionNameLong": "CEO"
}, {
    "id": 6343917500869986762,
    "positionDescription": null,
    "positionNameLong": "Developer"
}, {
    "id": 7828428543988420376,
    "positionDescription": null,
    "positionNameLong": "QA"
}, {
    "id": 8219751323950402194,
    "positionDescription": "",
    "positionNameLong": "Tester"
}]

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/position/$id?auth_token=YOUR_AUTH_TOKEN

Info
Get user position by ID

Request

Code Block
GET /rest/api/1/position/$id?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id	long	Position ID

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/position/5038994036906348198?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Example

Code Block
{ "id": 6343917500869986762, "persons": [{ "fullName": "Administrator", "username": "admin" }], "positionDescription": null, "positionNameLong": "Developer" }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Worklogs
Status
colour Green
title V8.3.0+

Expand

title	POST /rest/api/1/worklog?auth_token=YOUR_AUTH_TOKEN

Info
Add work log for current user or on behalf of other user.

Request

Code Block
POST /rest/api/1/worklog?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
date *	string	Date for a worklog in "yyyy-MM-ddTHH:mm:ss±hh:mm" format. Example: "2021-06-30T14:30:00+00:00”
username *	string	Username (Jira Server) or accountId (Jira Cloud) of the user who logs work hours
issueKey *	string	issueKey of issue
timeSpent *	string	The time spent working on the issue. Examples: "1h", "4h 30m", "30m”
comment	string	A comment for the worklog
category	number	Worklog category id. Configurable in Default Billable (“0”)

* indicates required parameters

Example

Code Block
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog?username=Adam&date=2021-04-15%2001:14:00%20%2B0300&issueKey=KAN-175&timeSpent=1h&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns created worklog.

Example

Code Block

{
    "approved": false,
    "approvedBy": "",
    "category": 0,
    "comment": "worklog comment",
    "date": "2021-04-15T01:14:00.000+03:00",
    "issueId": 12597,
    "issueKey": "KAN-175",
    "projectKey": "KAN",
    "timeSpent": 3600,
    "username": "557058:af2f543d-d6f7-4abc-a673-12355112323",
    "worklogId": 11667
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	PUT /rest/api/1/worklog/$id?auth_token=YOUR_AUTH_TOKEN

Info
Updates existing worklog record.

Request

Code Block
PUT /rest/api/1/worklog/$id?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	Worklog id
date *	string	Log work date in "yyyy-MM-ddTHH:mm:ss±hh:mm" format. Example: "2021-06-30T14:30:00+00:00”
username *	string	Username (Jira Server) or accountId (Jira Cloud) of the user who updates worklog
timeSpent *	string	The time spent working on the issue.
comment	string	A comment for the worklog
category	number	Worklog category. Default Billable (“0”)

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/11667?username=Adam&date=2021-04-15 01:14:00 %2B0300&issueKey=KAN-175&timeSpent=1h&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns updated worklog.

Example

Code Block

{
    "approved": false,
    "approvedBy": "",
    "category": 0,
    "comment": "",
    "date": "2021-04-15T01:14:00.000+03:00",
    "issueId": 12597,
    "issueKey": "KAN-175",
    "projectKey": "KAN",
    "timeSpent": 3600,
    "username": "557058:af2f543d-d6f7-4abc-a673-12355112323",
    "worklogId": 11667
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	DELETE /rest/api/1/worklog/$id?auth_token=YOUR_AUTH_TOKEN

Info
Deletes a worklog record.

Request

Code Block
DELETE /rest/api/1/worklog/$id?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	id of worklog

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/312463?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns success message.

Example

Code Block
{ "message":"Worklog has been successfully deleted!" }

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/worklog/list?auth_token=YOUR_AUTH_TOKEN

Info

Return a list of worklog records. Maximum 1000 worklog records per request.

Pass startOffset parameter to load the next portions of worklog records.

Request

Code Block
GET /rest/api/1/worklog/list?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
start *	string	Start of the period formatted in "yyyy-MM-dd" format
end *	string	End of the period formatted in "yyyy-MM-dd" format
username	string	Username or Accountld of specific user. If specified then returns worklogs from specific user only.
teamld	long	Id of specific team. If specified then returns worklogs of specific team members only.
projectKey	string	Project Key of Jira project. If specified then returns worklogs from specific project only.
startOffset	int	Offset for the first worklog in portion, default is 0.
category	byte	Worklog category. Default Billable (“0”). If specified then returns worklogs of specific category only.

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/list?start=2021-04-12&end=2021-04-20&auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns list of worklogs.

Example

Code Block

[{
    "approved": false,
    "approvedBy": "",
    "category": 0,
    "comment": "",
    "date": "2021-04-13T03:14:00.000+03:00",
    "issueId": 12637,
    "issueKey": "BT-11",
    "projectKey": "BT",
    "timeSpent": 7200,
    "username": "557058:009e0ad2-70b5-4b95-862c-12355112323",
    "worklogId": 11649
}, {
    "approved": false,
    "approvedBy": "",
    "category": 0,
    "comment": "",
    "date": "2021-04-14T00:00:00.000+03:00",
    "issueId": 12637,
    "issueKey": "BT-11",
    "projectKey": "BT",
    "timeSpent": 7200,
    "username": "557058:009e0ad2-70b5-4b95-862c-12355112323",
    "worklogId": 11641
}, {
    "approved": false,
    "approvedBy": "",
    "category": 0,
    "comment": "",
    "date": "2021-04-14T00:00:00.000+03:00",
    "issueId": 12707,
    "issueKey": "KAN-259",
    "projectKey": "KAN",
    "timeSpent": 7200,
    "username": "557058:009e0ad2-70b5-4b95-862c-12355112323",
    "worklogId": 11639
}, {
    "approved": false,
    "approvedBy": "",
    "category": 0,
    "comment": "",
    "date": "2021-04-14T00:00:00.000+03:00",
    "issueId": 12637,
    "issueKey": "BT-11",
    "projectKey": "BT",
    "timeSpent": 7200,
    "username": "557058:009e0ad2-70b5-4b95-862c-12355112323",
    "worklogId": 11640
}]

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	PUT /rest/api/1/worklog/approve/$id?auth_token=YOUR_AUTH_TOKEN (since v9.7.9)

Info
Approve a worklog record by a System.

Request

Code Block
PUT /rest/api/1/worklog/approve/$id?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	Worklog id

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/approve/11667?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns updated worklog.

Example

Code Block

{
    "approved": true,
    "approvedBy": "",
    "category": 0,
    "comment": "",
    "date": "2021-04-15T01:14:00.000+03:00",
    "issueId": 12597,
    "issueKey": "KAN-175",
    "projectKey": "KAN",
    "timeSpent": 3600,
    "username": "557058:af2f543d-d6f7-4abc-a673-12355112323",
    "worklogId": 11667
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions or the Timesheets Approval process is turned off in the settings

Status

colour	Red
title	status 404

Returns if worklog record is not found

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	PUT /rest/api/1/worklog/unapprove/$id?auth_token=YOUR_AUTH_TOKEN (since v9.7.9)

Info
Unapprove a worklog record.

Request

Code Block
PUT /rest/api/1/worklog/unapprove/$id?auth_token=YOUR_AUTH_TOKEN

QUERY PARAMETERS

Parameter	Type	Description
id *	long	Worklog id

* indicates required parameters

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/unapprove/11667?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns updated worklog.

Example

Code Block

{
    "approved": false,
    "approvedBy": "",
    "category": 0,
    "comment": "",
    "date": "2021-04-15T01:14:00.000+03:00",
    "issueId": 12597,
    "issueKey": "KAN-175",
    "projectKey": "KAN",
    "timeSpent": 3600,
    "username": "557058:af2f543d-d6f7-4abc-a673-12355112323",
    "worklogId": 11667
}

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions or the Timesheets Approval process is turned off in the settings

Status

colour	Red
title	status 404

Returns if worklog record is not found

Status

colour	Red
title	status 500

Returns if errors occurred during request

Expand

title	GET /rest/api/1/worklog/categories?auth_token=YOUR_AUTH_TOKEN

Info
Return a list of worklog categories.

Request

Code Block
GET /rest/api/1/worklog/categories?auth_token=YOUR_AUTH_TOKEN

Example

Code Block
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/categories?auth_token=YOUR_AUTH_TOKEN

Responses

Status
colour Green
title status 200
application/json Returns list of worklog categories.

Example

Code Block
[{ "active": true, "id": 1, "name": "Non-Billable" }, { "active": true, "id": 0, "name": "Billable" }]

Status

colour	Red
title	status 400

Returns if incorrect input parameters were supplied

Status

colour	Red
title	status 401

Returns if user was not logged in

Status

colour	Red
title	status 403

Returns if user didn't have permissions

Status

colour	Red
title	status 500

Returns if errors occurred during request

Frequently Asked Question. Read more.

📰 Helpful tips in our Blog.

📬 Questions? Contacts Us.

🤝 Contact details for Solution partners.

Search doсumentation

Live Search

spaceKey	AC
placeholder	Search doсumentation...

Page Comparison

Versions Compared

Old Version 71

New Version 72

Key

How to Use REST API

Sample Java/C# code of AT REST API usage

Authorization

Methods:

Timeline Schedule & Workload StatuscolourGreentitlev4.2.0+

Request

QUERY PARAMETERS

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns json representation of the result if request performed successfully.

Example

Request

QUERY PARAMETERS

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns json representation of the result if request performed successfully.

Example

Request

QUERY PARAMETERS

Example:

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns json representation of the result if request performed successfully.

Example

Request

QUERY PARAMETERS

* indicates required parameters

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns json representation of the result if request performed successfully.

Example

Request

QUERY PARAMETERS

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns json representation of the result if request performed successfully.

Example

Request

QUERY PARAMETERS

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns json representation of the result if request performed successfully.

Example

Request

QUERY PARAMETERS

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns json representation of the result if request performed successfully.

Example

Request

QUERY PARAMETERS

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns json representation of the result if request performed successfully.

Example

Custom events StatuscolourGreentitlev4.5.5+

Request

QUERY PARAMETERS

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns created event id and new assignee username.

Example

Request

QUERY PARAMETERS

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns custom event JSON data.

Example

Request

QUERY PARAMETERS

Example

Responses

StatuscolourGreentitlestatus 200 application/json Returns created event id and new assignee username.

Example

Request

Timeline Schedule & Workload
Status
colour Green
title v4.2.0+

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Custom events
Status
colour Green
title v4.5.5+

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Status
colour Green
title status 200
application/json Returns custom event JSON data.

Status
colour Green
title status 200
application/json Returns created event id and new assignee username.

Status
colour Green
title status 200
application/json Returns success message.

Status
colour Green
title status 200
application/json Returns updated issue/event data.

Status
colour Green
title status 200
application/json Returns json representation of event types.

Teams
Status
colour Green
title v8.3.0+

Status
colour Green
title status 200
application/json Returns json representation of the result if request performed successfully.

Status
colour Green
title status 200
application/json Returns success message.

Status
colour Green
title status 200
application/json Returns success message.

Status
colour Green
title status 200
application/json Returns success message.

Status
colour Green
title status 200
application/json Returns success message.

Status
colour Green
title status 200
application/json Returns success message.

Status
colour Green
title status 200
application/json Returns success message.

Projects
Status
colour Green
title v8.3.0+