ActivityTimeline REST API
All API requests can be made by ActivityTimeline user with Administrator permission only.
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 setting at Dashboard → Configuration → Advanced Settings page or AT REST API page:
ActivityTimeline REST API is available starting from ActivityTimeline v4.2.
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):
Authorization
You can authorize into the REST API by specifying a unique Authorization Token in one of 4 supported ways:
Authorization Token can be generated at ActivityTimeline Configuration → AT REST API page. |
---|
You can authorize into the REST API by specifying a unique Authorization Token in one of 4 supported ways:
Authorization Token can be generated at ActivityTimeline Configuration → AT REST API page. |
---|
Methods:
Timeline Schedule & Workload v4.2.0+
Returns information about user and events (Jira issues and custom events) for specified user for specified period of time.
Request
1
GET /rest/api/1/timeline?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
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.
|
* indicates required parameters
Example
1
2
3
4
5
6
7
8
9
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
|
---|
|
---|
Returns information about user and events (Jira issues and custom events) for specified user for specified period of time.
Request
1
GET /rest/api/1/timeline/$username?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
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
|
* indicates required parameters
Example
1
2
3
4
5
6
7
8
9
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
|
---|
|
---|
Returns information about users and workloads for specified team for specified period of time.
Request
1
GET /rest/api/1/workload?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
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 |
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 Example:1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
"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
1
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
|
---|
|
---|
Returns information about user and workloads for specified user for specified period of time.
Request
1
GET /rest/api/1/workload/$username?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
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
1
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/workload/admin?start=2020-07-01&end=2020-07-30&auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Custom events v4.5.5+
Creates a new custom event.
Request
1
POST /rest/api/1/event?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
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 |
isApproved (optional) | string | If set to "true" then custom event will be created pre-approved. |
* indicates required parameters
Example
1
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
|
---|
|
---|
Deletes a custom event.
Request
1
DELETE /rest/api/1/event/$id?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
id * | long | id of custom event |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event/312463?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Returns a list of custom event types.
Request
1
GET /rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Teams v8.3.0+
Returns list of Activity Timeline teams.
Request
1
GET /rest/api/1/team/list?auth_token=YOUR_AUTH_TOKEN
Responses
status 200 application/json Returns json representation of the result if request performed successfully. Example1
2
3
4
5
6
7
8
9
10
[{
"id": "1107507732947945188",
"name": "External Team"
}, {
"id": "387281612195971911",
"name": "Developers Team"
}, {
"id": "7756417552636331634",
"name": "QA Team"
}] status 401 Returns if user was not logged in status 403 Returns if user didn't have permissions status 500 Returns if errors occurred during request |
---|
status 200 application/json Returns json representation of the result if request performed successfully. Example1
2
3
4
5
6
7
8
9
10
[{
"id": "1107507732947945188",
"name": "External Team"
}, {
"id": "387281612195971911",
"name": "Developers Team"
}, {
"id": "7756417552636331634",
"name": "QA Team"
}] status 401 Returns if user was not logged in status 403 Returns if user didn't have permissions status 500 Returns if errors occurred during request |
---|
Returns information about team and users in a specified team.
Request
1
GET /rest/api/1/team/$teamId?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
teamId * | long | id of specific team |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/1107507732947945188?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Deletes team.
Request
1
DELETE /rest/api/1/team/$id?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
id * | long | id of team |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Add user to the team.
Request
1
POST /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
id * | long | Id of team |
username * | string | Username of user who will be added to the team |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/member?auth_token=YOUR_AUTH_TOKEN&username=admin
Responses
|
---|
|
---|
Remove user from the team.
Request
1
DELETE /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
id * | long | id of team |
username * | string | Username of user who will be removed from the team |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/member?auth_token=YOUR_AUTH_TOKEN&username=admin
Responses
|
---|
|
---|
Get the list of team managers.
Request
1
GET /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
id * | long | id of team |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Add team manager to the team.
Request
1
POST /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
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
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN&username=admin
Responses
|
---|
|
---|
Remove user from the team managers.
Request
1
DELETE /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
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
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN&username=admin
Responses
|
---|
|
---|
Projects v8.3.0+
Returns list of Activity Timeline projects by portions of 100.
Request
1
GET /rest/api/1/project/list?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
startOffset | integer | Offset for the first project, default is 0 |
state 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 200 application/json Returns json representation of the result if request performed successfully. Example1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
[{
"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 401 Returns if user was not logged in status 403 Returns if user didn't have permissions status 500 Returns if errors occurred during request |
---|
status 200 application/json Returns json representation of the result if request performed successfully. Example1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
[{
"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 401 Returns if user was not logged in status 403 Returns if user didn't have permissions status 500 Returns if errors occurred during request |
---|
Change the project state between active (enabled in the app) and inactive (disabled in the app).
Request
1
POST /rest/api/1/project/$id/state?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
id * | long | id of project |
state * | string | Project state. Should be either "active" or "inactive" |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/project/1074321572696248313/state?auth_token=YOUR_AUTH_TOKEN&state=inactive
Responses
|
---|
|
---|
Users v8.3.0+
Get paginated user list. Returns 100 users.
Request
1
GET /rest/api/1/user?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
startOffset * | string | Offset for first user, default is 0 |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Get detailed user data.
Request
1
GET /rest/api/1/user/$username?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Get user's skills.
Request
1
GET /rest/api/1/user/$username/skill?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Remove all skills from the user.
Request
1
DELETE /rest/api/1/user/$username/skill?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Assign a skill to user.
Request
1
POST /rest/api/1/user/$username/skill/$skillId?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
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
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill/356054081858522338?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Remove a skill from the user.
Request
1
DELETE /rest/api/1/user/$username/skill/$skillId?auth_token=YOUR_AUTH_TOKEN
QUERY PARAMETERS
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
skillId | long | Skill ID |
* indicates required parameters
Example
1
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill/356054081858522338?auth_token=YOUR_AUTH_TOKEN
Responses
|
---|
|
---|
Add a position for the user.
Request
1
POST /rest/api/1/user/$username/position?auth_token=YOUR_AUTH_TOKEN