Time to SLA Cloud REST API

Authentication

Create a token under Settings > API Token, then send it as a bearer token on every request.

export BASE_URL="https://tts.snapbytesapps.com"
export JWT_TOKEN="your-token-here"

curl -X GET "$BASE_URL/api/sla" \
  -H "Authorization: Bearer $JWT_TOKEN"

A 200 means the token is valid and has access. A 401 or 403 means it is invalid, expired, or lacks the permission the endpoint requires — check both the token's access level and your own Time to SLA permissions.

Every endpoint has a 28-second timeout. Keep page sizes small on the JQL and bulk endpoints.

SLA API

Read, create, update, delete and clone SLA configurations.

Get all SLAs

GET /api/sla

Returns every SLA configuration you have access to.

Parameters

None.

Request

curl -X GET "$BASE_URL/api/sla" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response (abbreviated to one SLA)

[
    {
        "id": "1",
        "name": "Time to Response",
        "projectIds": [
            "10002",
            "10000",
            "10003",
            "10004"
        ],
        "jql": "",
        "criticalThresholdPercentage": 80,
        "goals": [
            {
                "id": "000f1a2b-3c4d-4e5f-8a9b-000fc0d1e2f3",
                "calendarId": null,
                "goalType": "FIXED_DURATION",
                "context": {
                    "duration": "1h"
                },
                "order": 1,
                "defaultGoal": true,
                "enabled": true
            }
        ],
        "enabled": true,
        "calculationMethod": "ALL_CYCLES",
        "eventRules": [
            {
                "id": "00101a2b-3c4d-4e5f-8a9b-0010c0d1e2f3",
                "eventType": "START",
                "sourceType": "CHANGE_HISTORY",
                "context": {
                    "fieldType": "SYSTEM",
                    "fieldKey": "status",
                    "fieldValueType": "STATUS",
                    "fieldChangeType": "CHANGED_TO",
                    "fieldValueCondition": "EQUALS",
                    "values": [
                        {
                            "ids": [
                                "1"
                            ],
                            "label": "Open"
                        },
                        {
                            "ids": [
                                "10000",
                                "10009"
                            ],
                            "label": "To Do"
                        },
                        {
                            "ids": [
                                "10016"
                            ],
                            "label": "Waiting for approval"
                        },
                        {
                            "ids": [
                                "10011"
                            ],
                            "label": "Waiting for support"
                        },
                        {
                            "ids": [
                                "10012"
                            ],
                            "label": "Waiting for customer"
                        }
                    ]
                },
                "eventContext": null
            },
            {
                "id": "00111a2b-3c4d-4e5f-8a9b-0011c0d1e2f3",
                "eventType": "STOP",
                "sourceType": "CHANGE_HISTORY",
                "context": {
                    "fieldType": "SYSTEM",
                    "fieldKey": "status",
                    "fieldValueType": "STATUS",
                    "fieldChangeType": "CHANGED_TO",
                    "fieldValueCondition": "EQUALS",
                    "values": [
                        {
                            "ids": [
                                "6"
                            ],
                            "label": "Closed"
                        },
                        {
                            "ids": [
                                "10002",
                                "10005"
                            ],
                            "label": "Done"
                        },
                        {
                            "ids": [
                                "10021"
                            ],
                            "label": "Completed"
                        },
                        {
                            "ids": [
                                "5"
                            ],
                            "label": "Resolved"
                        }
                    ]
                },
                "eventContext": null
            }
        ],
        "intervalRules": [],
        "displayLinkedIssuesTypes": []
    }
]

Get an SLA

GET /api/sla/{slaId}

Returns a single SLA configuration by ID.

Path parameters

Parameter	Description
`slaId`	ID of the SLA configuration.

Request

curl -X GET "$BASE_URL/api/sla/1" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

{
    "id": "1",
    "name": "Time to Response",
    "projectIds": [
        "10002",
        "10000",
        "10003",
        "10004"
    ],
    "jql": "",
    "criticalThresholdPercentage": 80,
    "goals": [
        {
            "id": "00121a2b-3c4d-4e5f-8a9b-0012c0d1e2f3",
            "calendarId": null,
            "goalType": "FIXED_DURATION",
            "context": {
                "duration": "1h"
            },
            "order": 1,
            "defaultGoal": true,
            "enabled": true
        }
    ],
    "enabled": true,
    "calculationMethod": "ALL_CYCLES",
    "eventRules": [
        {
            "id": "00101a2b-3c4d-4e5f-8a9b-0010c0d1e2f3",
            "eventType": "START",
            "sourceType": "CHANGE_HISTORY",
            "context": {
                "fieldType": "SYSTEM",
                "fieldKey": "status",
                "fieldValueType": "STATUS",
                "fieldChangeType": "CHANGED_TO",
                "fieldValueCondition": "EQUALS",
                "values": [
                    {
                        "ids": [
                            "1"
                        ],
                        "label": "Open"
                    },
                    {
                        "ids": [
                            "10000",
                            "10009"
                        ],
                        "label": "To Do"
                    },
                    {
                        "ids": [
                            "10016"
                        ],
                        "label": "Waiting for approval"
                    },
                    {
                        "ids": [
                            "10011"
                        ],
                        "label": "Waiting for support"
                    },
                    {
                        "ids": [
                            "10012"
                        ],
                        "label": "Waiting for customer"
                    }
                ]
            },
            "eventContext": null
        },
        {
            "id": "00111a2b-3c4d-4e5f-8a9b-0011c0d1e2f3",
            "eventType": "STOP",
            "sourceType": "CHANGE_HISTORY",
            "context": {
                "fieldType": "SYSTEM",
                "fieldKey": "status",
                "fieldValueType": "STATUS",
                "fieldChangeType": "CHANGED_TO",
                "fieldValueCondition": "EQUALS",
                "values": [
                    {
                        "ids": [
                            "6"
                        ],
                        "label": "Closed"
                    },
                    {
                        "ids": [
                            "10002",
                            "10005"
                        ],
                        "label": "Done"
                    },
                    {
                        "ids": [
                            "10021"
                        ],
                        "label": "Completed"
                    },
                    {
                        "ids": [
                            "5"
                        ],
                        "label": "Resolved"
                    }
                ]
            },
            "eventContext": null
        }
    ],
    "intervalRules": [],
    "displayLinkedIssuesTypes": []
}

Create an SLA

POST /api/sla

Creates a new SLA configuration.

The example below starts the SLA when a label is added, stops it on a status change, resets it when the fix version changes, and pauses it while the work item is In Progress.

Parameters

None.

Request

curl -X POST "$BASE_URL/api/sla" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
  "name": "Fast Response",
  "projectIds": [
    "10000"
  ],
  "jql": "",
  "criticalThresholdPercentage": 80,
  "goals": [
    {
      "calendarId": null,
      "goalType": "FIXED_DURATION",
      "context": {
        "duration": "1h"
      },
      "order": 1,
      "defaultGoal": true,
      "enabled": true
    }
  ],
  "enabled": false,
  "calculationMethod": "ALL_CYCLES",
  "eventRules": [
    {
      "eventType": "START",
      "sourceType": "CHANGE_HISTORY",
      "context": {
        "fieldType": "SYSTEM",
        "fieldKey": "labels",
        "fieldValueType": "LABEL",
        "fieldChangeType": "CHANGED_TO",
        "fieldValueCondition": "CONSISTS_OF",
        "values": [
          "New Label"
        ]
      },
      "eventContext": null
    },
    {
      "eventType": "STOP",
      "sourceType": "CHANGE_HISTORY",
      "context": {
        "fieldType": "SYSTEM",
        "fieldKey": "status",
        "fieldValueType": "STATUS",
        "fieldChangeType": "CHANGED_TO",
        "fieldValueCondition": "EQUALS",
        "values": [
          {
            "ids": [
              "10008"
            ],
            "label": "Documentation"
          }
        ]
      },
      "eventContext": null
    },
    {
      "eventType": "RESET",
      "sourceType": "CHANGE_HISTORY",
      "context": {
        "fieldType": "SYSTEM",
        "fieldKey": "fixVersions",
        "fieldValueType": "MULTI_ALL_CHANGED",
        "fieldChangeType": "CHANGED",
        "fieldValueCondition": "EQUALS",
        "values": [
          null
        ]
      },
      "eventContext": null
    }
  ],
  "intervalRules": [
    {
      "intervalType": "PAUSE_ON",
      "sourceType": "FIELD_CONDITION",
      "context": {
        "fieldType": "SYSTEM",
        "fieldKey": "status",
        "fieldValueType": "STATUS",
        "fieldValueCondition": "EQUALS",
        "values": [
          {
            "ids": [
              "10001"
            ],
            "label": "In Progress"
          }
        ]
      }
    }
  ],
  "displayLinkedIssuesTypes": []
}

Clone an SLA

POST /api/sla/clone

Creates a new SLA by copying an existing one.

Body parameters

Parameter	Type	Required	Description
`slaConfigurationId`	String	Yes	ID of the SLA to copy.
`name`	String	Yes	Name for the new SLA.
`enabled`	Boolean	No	Whether the new SLA starts out enabled.
`clonePause`	Boolean	No	Copy the pause conditions.
`cloneReset`	Boolean	No	Copy the reset conditions.
`cloneNotifs`	Boolean	No	Copy the SLA actions.

Request

curl -X POST "$BASE_URL/api/sla/clone" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
    "slaConfigurationId": "1",
    "name": "Clone SLA",
    "enabled": true,
    "clonePause": true,
    "cloneReset": true,
    "cloneNotifs": true
}

Update an SLA

PUT /api/sla

Updates an existing SLA configuration.

Send the complete object including its id; the arrays you supply replace the stored ones. Note that the response returns the same fields in a different order.

Parameters

None.

Request

curl -X PUT "$BASE_URL/api/sla" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
    "id": "3",
    "name": "Fast Response (Edit)",
    "projectIds": [
        "10000"
    ],
    "jql": "",
    "criticalThresholdPercentage": 90,
    "goals": [
        {
            "id": "00131a2b-3c4d-4e5f-8a9b-0013c0d1e2f3",
            "calendarId": null,
            "goalType": "FIXED_DURATION",
            "context": {
                "duration": "1h"
            },
            "order": 1,
            "defaultGoal": true,
            "enabled": true
        }
    ],
    "enabled": true,
    "calculationMethod": "ALL_CYCLES",
    "eventRules": [
        {
            "id": "00141a2b-3c4d-4e5f-8a9b-0014c0d1e2f3",
            "eventType": "START",
            "sourceType": "CHANGE_HISTORY",
            "context": {
                "fieldType": "SYSTEM",
                "fieldKey": "labels",
                "fieldValueType": "LABEL",
                "fieldChangeType": "CHANGED_TO",
                "fieldValueCondition": "CONSISTS_OF",
                "values": [
                    "New Label"
                ]
            },
            "eventContext": null
        },
        {
            "id": "00151a2b-3c4d-4e5f-8a9b-0015c0d1e2f3",
            "eventType": "STOP",
            "sourceType": "CHANGE_HISTORY",
            "context": {
                "fieldType": "SYSTEM",
                "fieldKey": "status",
                "fieldValueType": "STATUS",
                "fieldChangeType": "CHANGED_TO",
                "fieldValueCondition": "EQUALS",
                "values": [
                    {
                        "ids": [
                            "10008"
                        ],
                        "label": "Documentation"
                    }
                ]
            },
            "eventContext": null
        },
        {
            "id": "00161a2b-3c4d-4e5f-8a9b-0016c0d1e2f3",
            "eventType": "RESET",
            "sourceType": "CHANGE_HISTORY",
            "context": {
                "fieldType": "SYSTEM",
                "fieldKey": "fixVersions",
                "fieldValueType": "MULTI_ALL_CHANGED",
                "fieldChangeType": "CHANGED",
                "fieldValueCondition": "EQUALS",
                "values": [
                    null
                ]
            },
            "eventContext": null
        }
    ],
    "intervalRules": [
        {
            "id": "00171a2b-3c4d-4e5f-8a9b-0017c0d1e2f3",
            "intervalType": "PAUSE_ON",
            "sourceType": "FIELD_CONDITION",
            "context": {
                "fieldType": "SYSTEM",
                "fieldKey": "status",
                "fieldValueType": "STATUS",
                "fieldValueCondition": "EQUALS",
                "values": [
                    {
                        "ids": [
                            "10001"
                        ],
                        "label": "In Progress"
                    }
                ]
            }
        }
    ],
    "displayLinkedIssuesTypes": []
}

Delete an SLA

DELETE /api/sla/{slaId}

Deletes the SLA configuration with the given ID.

Path parameters

Parameter	Description
`slaId`	ID of the SLA configuration.

Request

curl -X DELETE "$BASE_URL/api/sla/1" \
  -H "Authorization: Bearer $JWT_TOKEN"

Calendar API

The working calendars that SLA goals are measured against.

Get all calendars

GET /api/calendar

Returns every calendar defined in Time to SLA.

Parameters

None.

Request

curl -X GET "$BASE_URL/api/calendar" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response (abbreviated to one calendar)

[
    {
        "id": "00011a2b-3c4d-4e5f-8a9b-0001c0d1e2f3",
        "calendarName": "Normal Calendar",
        "businessDayInfo": {
            "calculationType": "CALENDAR",
            "isCustom": false
        },
        "currentBusinessHours": [
            {
                "day": "Monday",
                "start": "08:00",
                "end": "16:00"
            },
            {
                "day": "Tuesday",
                "start": "08:00",
                "end": "16:00"
            },
            {
                "day": "Wednesday",
                "start": "08:00",
                "end": "16:00"
            },
            {
                "day": "Thursday",
                "start": "08:00",
                "end": "16:00"
            }
        ],
        "holidays": [
            {
                "id": "00021a2b-3c4d-4e5f-8a9b-0002c0d1e2f3",
                "isRecurring": false,
                "holidayName": "Holiday",
                "holidayType": "whole",
                "holidayDate": "2022-03-08"
            },
            {
                "id": "00031a2b-3c4d-4e5f-8a9b-0003c0d1e2f3",
                "isRecurring": false,
                "holidayName": "Holiday",
                "holidayType": "whole",
                "holidayDate": "2022-03-09"
            }
        ],
        "timeZone": {
            "id": "Asia/Jakarta",
            "label": "(GMT+07:00) Asia/Jakarta"
        },
        "sharedHolidays": [
            {
                "isRecurring": false,
                "holidayName": "Shared",
                "holidayType": "whole",
                "holidayDate": "2022-01-01"
            }
        ],
        "exceptions": [
            {
                "id": "exc-001",
                "isRecurring": false,
                "recurringType": null,
                "name": "Overtime Day",
                "date": "2022-03-10",
                "from": "08:00",
                "until": "20:00",
                "breaks": []
            },
            {
                "id": "exc-002",
                "isRecurring": true,
                "recurringType": "yearly",
                "name": "Yearly Support Day",
                "date": "2022-12-25",
                "from": "00:00",
                "until": "23:59",
                "breaks": []
            },
            {
                "id": "exc-003",
                "isRecurring": false,
                "recurringType": null,
                "name": "Extended Hours with Break",
                "date": "2022-03-15",
                "from": "08:00",
                "until": "18:00",
                "breaks": [
                    {
                        "from": "12:00",
                        "until": "13:00"
                    }
                ]
            }
        ],
        "sharedExceptions": [
            {
                "id": null,
                "isRecurring": false,
                "recurringType": null,
                "name": "Shared Overtime",
                "date": "2022-01-15",
                "from": "09:00",
                "until": "17:00",
                "breaks": []
            },
            {
                "id": null,
                "isRecurring": true,
                "recurringType": "monthly",
                "name": "Monthly Support Day",
                "date": "2022-01-01",
                "from": "10:00",
                "until": "14:00",
                "breaks": []
            }
        ],
        "exceptionsPrecedence": "exceptions_override_holidays"
    }
]

Get a calendar

GET /api/calendar/{id}

Returns a single calendar configuration by ID.

Path parameters

Parameter	Description
`id`	ID of the calendar.

Request

curl -X GET "$BASE_URL/api/calendar/00011a2b-3c4d-4e5f-8a9b-0001c0d1e2f3" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

{
  "id": "00011a2b-3c4d-4e5f-8a9b-0001c0d1e2f3",
  "calendarName": "Normal Calendar",
  "businessDayInfo": {
    "calculationType": "CALENDAR",
    "isCustom": false
  },
  "currentBusinessHours": [
    {
      "day": "Monday",
      "start": "08:00",
      "end": "16:00"
    },
    {
      "day": "Tuesday",
      "start": "08:00",
      "end": "16:00"
    },
    {
      "day": "Wednesday",
      "start": "08:00",
      "end": "16:00"
    },
    {
      "day": "Thursday",
      "start": "08:00",
      "end": "16:00"
    }
  ],
  "holidays": [
    {
      "id": "00021a2b-3c4d-4e5f-8a9b-0002c0d1e2f3",
      "isRecurring": false,
      "holidayName": "Holiday",
      "holidayType": "whole",
      "holidayDate": "2022-03-08"
    },
    {
      "id": "00031a2b-3c4d-4e5f-8a9b-0003c0d1e2f3",
      "isRecurring": false,
      "holidayName": "Holiday",
      "holidayType": "whole",
      "holidayDate": "2022-03-09"
    }
  ],
  "timeZone": {
    "id": "Asia/Jakarta",
    "label": "(GMT+07:00) Asia/Jakarta"
  },
  "sharedHolidays": [
    {
      "isRecurring": false,
      "holidayName": "Shared",
      "holidayType": "whole",
      "holidayDate": "2022-01-01"
    }
  ],
  "exceptions": [
    {
      "id": "exc-001",
      "isRecurring": false,
      "recurringType": null,
      "name": "Overtime Day",
      "date": "2022-03-10",
      "from": "08:00",
      "until": "20:00",
      "breaks": []
    },
    {
      "id": "exc-002",
      "isRecurring": true,
      "recurringType": "yearly",
      "name": "Yearly Support Day",
      "date": "2022-12-25",
      "from": "00:00",
      "until": "23:59",
      "breaks": []
    },
    {
      "id": "exc-003",
      "isRecurring": false,
      "recurringType": null,
      "name": "Extended Hours with Break",
      "date": "2022-03-15",
      "from": "08:00",
      "until": "18:00",
      "breaks": [
        {
          "from": "12:00",
          "until": "13:00"
        }
      ]
    }
  ],
  "sharedExceptions": [
    {
      "id": null,
      "isRecurring": false,
      "recurringType": null,
      "name": "Shared Overtime",
      "date": "2022-01-15",
      "from": "09:00",
      "until": "17:00",
      "breaks": []
    },
    {
      "id": null,
      "isRecurring": true,
      "recurringType": "monthly",
      "name": "Monthly Support Day",
      "date": "2022-01-01",
      "from": "10:00",
      "until": "14:00",
      "breaks": []
    }
  ],
  "exceptionsPrecedence": "exceptions_override_holidays"
}

Create a calendar

POST /api/calendar

Creates a new calendar.

Send a calendar object without an id; the response contains the generated ID.

Parameters

None.

Request

curl -X POST "$BASE_URL/api/calendar" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
  "calendarName": "Jakarta Calendar",
  "businessDayInfo": {
    "calculationType": "CALENDAR",
    "isCustom": false
  },
  "currentBusinessHours": [
    {
      "day": "Monday",
      "start": "08:00",
      "end": "16:00"
    },
    {
      "day": "Tuesday",
      "start": "08:00",
      "end": "16:00"
    },
    {
      "day": "Wednesday",
      "start": "08:00",
      "end": "16:00"
    },
    {
      "day": "Thursday",
      "start": "08:00",
      "end": "16:00"
    }
  ],
  "timeZone": {
    "id": "Asia/Jakarta",
    "label": "(GMT+07:00) Asia/Jakarta"
  },
  "holidays": [
    {
      "id": "00021a2b-3c4d-4e5f-8a9b-0002c0d1e2f3",
      "holidayDate": "2022-03-08",
      "holidayName": "Holiday",
      "holidayType": "whole",
      "isRecurring": false
    },
    {
      "id": "00031a2b-3c4d-4e5f-8a9b-0003c0d1e2f3",
      "holidayDate": "2022-03-09",
      "holidayName": "Holiday",
      "holidayType": "whole",
      "isRecurring": false
    }
  ],
  "sharedHolidays": [
    {
      "holidayDate": "2022-01-01",
      "holidayName": "Shared",
      "holidayType": "whole",
      "isRecurring": false
    }
  ],
  "exceptions": [
    {
      "id": null,
      "isRecurring": false,
      "recurringType": null,
      "name": "Overtime Day",
      "date": "2022-03-10",
      "from": "08:00",
      "until": "20:00",
      "breaks": []
    },
    {
      "id": null,
      "isRecurring": true,
      "recurringType": "yearly",
      "name": "Yearly Support Day",
      "date": "2022-12-25",
      "from": "00:00",
      "until": "23:59",
      "breaks": []
    },
    {
      "id": null,
      "isRecurring": false,
      "recurringType": null,
      "name": "Extended Hours with Break",
      "date": "2022-03-15",
      "from": "08:00",
      "until": "18:00",
      "breaks": [
        {
          "from": "12:00",
          "until": "13:00"
        }
      ]
    }
  ],
  "sharedExceptions": [
    {
      "id": null,
      "isRecurring": false,
      "recurringType": null,
      "name": "Shared Overtime",
      "date": "2022-01-15",
      "from": "09:00",
      "until": "17:00",
      "breaks": []
    },
    {
      "id": null,
      "isRecurring": true,
      "recurringType": "monthly",
      "name": "Monthly Support Day",
      "date": "2022-01-01",
      "from": "10:00",
      "until": "14:00",
      "breaks": []
    }
  ],
  "exceptionsPrecedence": "exceptions_override_holidays"
}

Update a calendar

PUT /api/calendar

Updates an existing calendar.

Send the complete calendar object including its id — the arrays you supply replace the stored ones. New exceptions are sent with "id": null and get an ID back in the response.

Parameters

None.

Request

curl -X PUT "$BASE_URL/api/calendar" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
    "id": "00041a2b-3c4d-4e5f-8a9b-0004c0d1e2f3",
    "calendarName": "Jakarta Calendar (Update)",
    "businessDayInfo": {
        "calculationType": "CALENDAR",
        "isCustom": false
    },
    "currentBusinessHours": [
        {
            "day": "Monday",
            "start": "08:00",
            "end": "17:00"
        },
        {
            "day": "Tuesday",
            "start": "08:00",
            "end": "16:00"
        },
        {
            "day": "Wednesday",
            "start": "08:00",
            "end": "17:00"
        },
        {
            "day": "Thursday",
            "start": "08:00",
            "end": "16:00"
        }
    ],
    "holidays": [
        {
            "id": "00021a2b-3c4d-4e5f-8a9b-0002c0d1e2f3",
            "isRecurring": false,
            "holidayName": "Holiday",
            "holidayType": "whole",
            "holidayDate": "2022-03-08"
        },
        {
            "id": "00031a2b-3c4d-4e5f-8a9b-0003c0d1e2f3",
            "isRecurring": false,
            "holidayName": "Holiday",
            "holidayType": "whole",
            "holidayDate": "2022-03-09"
        }
    ],
    "timeZone": {
        "id": "Asia/Jakarta",
        "label": "(GMT+07:00) Asia/Jakarta"
    },
    "sharedHolidays": [
        {
            "isRecurring": false,
            "holidayName": "Shared",
            "holidayType": "whole",
            "holidayDate": "2022-01-01"
        }
    ],
    "exceptions": [
        {
            "id": "exc-001",
            "isRecurring": false,
            "recurringType": null,
            "name": "Overtime Day",
            "date": "2022-03-10",
            "from": "08:00",
            "until": "20:00",
            "breaks": []
        },
        {
            "id": "exc-002",
            "isRecurring": true,
            "recurringType": "yearly",
            "name": "Yearly Support Day",
            "date": "2022-12-25",
            "from": "00:00",
            "until": "23:59",
            "breaks": []
        },
        {
            "id": null,
            "isRecurring": false,
            "recurringType": null,
            "name": "New Exception",
            "date": "2022-04-01",
            "from": "09:00",
            "until": "15:00",
            "breaks": []
        }
    ],
    "sharedExceptions": [
        {
            "id": null,
            "isRecurring": false,
            "recurringType": null,
            "name": "Shared Overtime",
            "date": "2022-01-15",
            "from": "09:00",
            "until": "17:00",
            "breaks": []
        },
        {
            "id": null,
            "isRecurring": true,
            "recurringType": "monthly",
            "name": "Monthly Support Day",
            "date": "2022-01-01",
            "from": "10:00",
            "until": "14:00",
            "breaks": []
        }
    ],
    "exceptionsPrecedence": "exceptions_override_holidays"
}

Delete a calendar

DELETE /api/calendar/{id}

Deletes the calendar with the given ID.

Path parameters

Parameter	Description
`id`	ID of the calendar.

Request

curl -X DELETE "$BASE_URL/api/calendar/00011a2b-3c4d-4e5f-8a9b-0001c0d1e2f3" \
  -H "Authorization: Bearer $JWT_TOKEN"

SLA actions API

Per-SLA and global actions (formerly called notifiers).

Get the actions of an SLA

GET /api/notifier/sla/{slaId}

Returns every SLA action attached to the given SLA.

Path parameters

Parameter	Description
`slaId`	ID of the SLA configuration.

Request

curl -X GET "$BASE_URL/api/notifier/sla/1" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

[
    {
        "id": "2",
        "enabled": true,
        "thresholdType": "WILL_BE_BREACHED",
        "duration": "1h",
        "recurrenceInterval": null,
        "workingCalendarEnabled": true,
        "actionType": "SLACK",
        "slaNotifierActionContext": {
            "webhooksUrl": "slackwebhook",
            "messageBody": "SLA Notification for $issue.key from 'Time to SLA Plugin' <br/>\nThe following issue is close to the SLA target date. <br/>\n <br/>\nHere are the details: <br/>\nSLA Start: $slaStartDate <br/>\nSLA Target: $slaTargetDate <br/>\nStart Conditions : $startConditions <br/>\nEnd Conditions : $endConditions <br/>\n"
        },
        "appliedToAllGoals": true,
        "appliedGoals": null,
        "slaConfiguration": "1"
    }
]

Get global actions

GET /api/notifier/global

Returns every global SLA action defined in Time to SLA.

Parameters

None.

Request

curl -X GET "$BASE_URL/api/notifier/global" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

[
  {
    "id": "11",
    "enabled": true,
    "thresholdType": "IS_BREACHED",
    "duration": null,
    "recurrenceEnabled": true,
    "recurrenceInterval": "10m",
    "actionType": "SLACK",
    "slaNotifierActionContext": {
      "webhooksUrl": "slackwebhook",
      "messageBody": "SLA Notification for $issue.key from 'Time to SLA Plugin' <br/>\nThe following issue is close to the SLA target date. <br/>\n <br/>\nHere are the details: <br/>\nSLA Start: $slaStartDate <br/>\nSLA Target: $slaTargetDate <br/>\nStart Conditions : $startConditions <br/>\nEnd Conditions : $endConditions <br/>\n"
    },
    "appliedToAllGoals": true,
    "appliedGoals": null,
    "slaConfiguration": "-1",
    "globalNotifier": true
  }
]

Get an SLA action

GET /api/notifier/{notifierId}/sla/{slaId}

Returns a single SLA action by SLA ID and action ID.

Path parameters

Parameter	Description
`notifierId`	ID of the SLA action.
`slaId`	ID of the SLA configuration.

Request

curl -X GET "$BASE_URL/api/notifier/12/sla/1" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

{
    "id": "12",
    "enabled": true,
    "thresholdType": "WILL_BE_BREACHED",
    "duration": "1h",
    "recurrenceInterval": null,
    "workingCalendarEnabled": true,
    "actionType": "SLACK",
    "slaNotifierActionContext": {
        "webhooksUrl": "slackwebhook",
        "messageBody": "SLA Notification for $issue.key from 'Time to SLA Plugin' <br/>\nThe following issue is close to the SLA target date. <br/>\n <br/>\nHere are the details: <br/>\nSLA Start: $slaStartDate <br/>\nSLA Target: $slaTargetDate <br/>\nStart Conditions : $startConditions <br/>\nEnd Conditions : $endConditions <br/>\n"
    },
    "appliedToAllGoals": true,
    "appliedGoals": null,
    "slaConfiguration": "1"
}

Create an SLA action

POST /api/notifier

Creates a new SLA action configuration.

Parameters

None.

Request

curl -X POST "$BASE_URL/api/notifier" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
    "enabled": true,
    "thresholdType": "WILL_BE_BREACHED",
    "duration": "2h",
    "recurrenceInterval": null,
    "workingCalendarEnabled": false,
    "actionType": "SLACK",
    "slaNotifierActionContext": {
        "webhooksUrl": "slackwebhook",
        "messageBody": "SLA Notification for $issue.key from 'Time to SLA Plugin' <br/>\nThe following issue is close to the SLA target date. <br/>\n <br/>\nHere are the details: <br/>\nSLA Start: $slaStartDate <br/>\nSLA Target: $slaTargetDate <br/>\nStart Conditions : $startConditions <br/>\nEnd Conditions : $endConditions <br/>\n"
    },
    "appliedToAllGoals": true,
    "appliedGoals": null,
    "slaConfiguration": "38"
}

Response

{
    "id": "14",
    "enabled": true,
    "thresholdType": "WILL_BE_BREACHED",
    "duration": "2h",
    "recurrenceInterval": null,
    "workingCalendarEnabled": false,
    "actionType": "SLACK",
    "slaNotifierActionContext": {
        "webhooksUrl": "slackwebhook",
        "messageBody": "SLA Notification for $issue.key from 'Time to SLA Plugin' \n<br/>\nThe following issue is close to the SLA target date.\n<br/>\n\n<br/>\nHere are the details:\n<br/>\nSLA Start: $slaStartDate\n<br/>\nSLA Target: $slaTargetDate\n<br/>\nStart Conditions : $startConditions\n<br/>\nEnd Conditions : $endConditions\n<br/>\n"
    },
    "appliedToAllGoals": true,
    "appliedGoals": null,
    "slaConfiguration": "38"
}

Update an SLA action

PUT /api/notifier

Updates an existing SLA action configuration.

Parameters

None.

Request

curl -X PUT "$BASE_URL/api/notifier" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
    "id": "14",
    "enabled": true,
    "thresholdType": "WILL_BE_BREACHED",
    "duration": "1h",
    "recurrenceInterval": null,
    "workingCalendarEnabled": true,
    "actionType": "SLACK",
    "slaNotifierActionContext": {
        "webhooksUrl": "slackwebhook",
        "messageBody": "SLA Notification for $issue.key from 'Time to SLA Plugin' <br/>\nThe following issue is close to the SLA target date. <br/>\n <br/>\nHere are the details: <br/>\nSLA Start: $slaStartDate <br/>\nSLA Target: $slaTargetDate <br/>\nStart Conditions : $startConditions <br/>\nEnd Conditions : $endConditions <br/>\n"
    },
    "appliedToAllGoals": true,
    "appliedGoals": null,
    "slaConfiguration": "1"
}

Response

{
  "id": "14",
  "enabled": true,
  "thresholdType": "WILL_BE_BREACHED",
  "duration": "1h",
  "recurrenceInterval": null,
  "workingCalendarEnabled": true,
  "actionType": "SLACK",
  "slaNotifierActionContext": {
    "webhooksUrl": "slackwebhook",
    "messageBody": "SLA Notification for $issue.key from 'Time to SLA Plugin' <br/>\nThe following issue is close to the SLA target date. <br/>\n <br/>\nHere are the details: <br/>\nSLA Start: $slaStartDate <br/>\nSLA Target: $slaTargetDate <br/>\nStart Conditions : $startConditions <br/>\nEnd Conditions : $endConditions <br/>\n"
  },
  "appliedToAllGoals": true,
  "appliedGoals": null,
  "slaConfiguration": "1"
}

Delete an SLA action

DELETE /api/notifier/{notifierId}/sla/{slaId}

Deletes an SLA action by SLA ID and action ID.

Path parameters

Parameter	Description
`notifierId`	ID of the SLA action.
`slaId`	ID of the SLA configuration.

Request

curl -X DELETE "$BASE_URL/api/notifier/12/sla/1" \
  -H "Authorization: Bearer $JWT_TOKEN"

Work item SLA API

Live SLA state per work item, by JQL or in bulk, plus SLA history.

Get all SLAs of a work item

GET /api/issue-sla/{issueId}

Returns the live state of every SLA running on a work item.

Path parameters

Parameter	Description
`issueId`	ID of the work item. To resolve an ID from a work item key, call `<your-jira-url>/rest/api/3/issue/{issueKey}`.

Query parameters

Parameter	Type	Required	Description
`durationFormat`	String	No	Human-readable duration values instead of milliseconds. See Duration formats.

Request

curl -X GET "$BASE_URL/api/issue-sla/10001" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

[
  {
    "issueId": "10001",
    "slaId": "38",
    "slaName": "Time to Response",
    "slaValueAsDurationString": "1h",
    "workingCalendarName": "7x24",
    "slaValueType": "SLA_VALUE",
    "slaStartType": {},
    "slaTargetType": {},
    "percentageThreshold": 80,
    "slaStatus": "STILL",
    "slaValue": 3600000,
    "startDate": 1647419947000,
    "endDate": null,
    "deadline": 1647423547000,
    "elapsedDuration": 151867,
    "remainingDuration": 3448133,
    "overdueDuration": 0,
    "pausedDuration": 0,
    "elapsedPercentage": 4,
    "isStarted": true,
    "isPaused": false,
    "isFinished": false,
    "inNonWorkingHours": false,
    "inNonWorkingDays": false,
    "lastStatusDate": 1647420098867,
    "calendarId": "7x24",
    "workingDuration": 151867,
    "slaValueForFixedDurations": null
  },
  {
    "issueId": "10001",
    "slaId": "40",
    "slaName": "Clone SLA",
    "slaValueAsDurationString": "1h",
    "workingCalendarName": "7x24",
    "slaValueType": "SLA_VALUE",
    "slaStartType": {},
    "slaTargetType": {},
    "percentageThreshold": 80,
    "slaStatus": "STILL",
    "slaValue": 3600000,
    "startDate": 1647419947000,
    "endDate": null,
    "deadline": 1647423547000,
    "elapsedDuration": 151884,
    "remainingDuration": 3448116,
    "overdueDuration": 0,
    "pausedDuration": 0,
    "elapsedPercentage": 4,
    "isStarted": true,
    "isPaused": false,
    "isFinished": false,
    "inNonWorkingHours": false,
    "inNonWorkingDays": false,
    "lastStatusDate": 1647420098884,
    "calendarId": "7x24",
    "workingDuration": 151884,
    "slaValueForFixedDurations": null
  }
]

Get one SLA of a work item

GET /api/issue-sla/{issueId}/sla/{slaId}

Returns the live state of a single SLA on a work item.

Path parameters

Parameter	Description
`issueId`	ID of the work item. To resolve an ID from a work item key, call `<your-jira-url>/rest/api/3/issue/{issueKey}`.
`slaId`	ID of the SLA configuration.

Query parameters

Parameter	Type	Required	Description
`durationFormat`	String	No	Human-readable duration values instead of milliseconds. See Duration formats.

Request

curl -X GET "$BASE_URL/api/issue-sla/10001/sla/38" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

{
  "issueId": "10001",
  "slaId": "38",
  "slaName": "Time to Response",
  "slaValueAsDurationString": "1h",
  "workingCalendarName": "7x24",
  "slaValueType": "SLA_VALUE",
  "slaStartType": {},
  "slaTargetType": {},
  "percentageThreshold": 80,
  "slaStatus": "STILL",
  "slaValue": 3600000,
  "startDate": 1647419947000,
  "endDate": null,
  "deadline": 1647423547000,
  "elapsedDuration": 235087,
  "remainingDuration": 3364913,
  "overdueDuration": 0,
  "pausedDuration": 0,
  "elapsedPercentage": 7,
  "isStarted": true,
  "isPaused": false,
  "isFinished": false,
  "inNonWorkingHours": false,
  "inNonWorkingDays": false,
  "lastStatusDate": 1647420182087,
  "calendarId": "7x24",
  "workingDuration": 235087,
  "slaValueForFixedDurations": null
}

Get the SLA history of a work item

GET /api/issue-sla-history/{issueId}/sla/{slaId}

Returns the recorded state changes of one SLA on a work item, including the conditions that started and ended it and the individual events in each cycle.

Path parameters

Parameter	Description
`issueId`	ID of the work item. To resolve an ID from a work item key, call `<your-jira-url>/rest/api/3/issue/{issueKey}`.
`slaId`	ID of the SLA configuration.

Request

curl -X GET "$BASE_URL/api/issue-sla-history/10001/sla/28" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

{
    "slaHistory": {
        "slaState": {
            "deadline": 1689172936000,
            "remainingDuration": 3548000,
            "overdueDuration": 0,
            "elapsedPercentage": 1,
            "state": "SUCCESS",
            "slaGoal": {
                "dateGoal": null,
                "durationGoal": 3600000,
                "nextBusinessDay": null
            },
            "elapsedDuration": 52000,
            "pausedDuration": 0,
            "startTime": 1689169336000,
            "endTime": 1689169388000,
            "startCondition": "Entered in Backlog status",
            "endCondition": "Entered in Selected for Development status",
            "goalCondition": "All issues Duration='1h'",
            "slaGoalContext": {
                "duration": "1h"
            },
            "slaGoalContextType": "FIXED_DURATION"
        },
        "calendarName": "7x24",
        "slaEventDtos": [
            {
                "authorName": "Test User",
                "authorAvatarUrl": "test_url",
                "eventTime": 1689169336000,
                "eventType": "START",
                "stateType": "RUNNING",
                "eventDuration": 52000,
                "overallElapsed": 52000,
                "overallPaused": 0,
                "overallOverdue": 0,
                "isBreached": false,
                "cycle": 1
            },
            {
                "authorName": "Test User",
                "authorAvatarUrl": "test_url",
                "eventTime": 1689169336000,
                "eventType": "ISSUE_CREATED",
                "stateType": null,
                "eventDuration": null,
                "overallElapsed": null,
                "overallPaused": null,
                "overallOverdue": null,
                "isBreached": null,
                "cycle": 1
            },
            {
                "authorName": "Test User",
                "authorAvatarUrl": "test_url",
                "eventTime": 1689169388000,
                "eventType": "STOP",
                "stateType": "STOPPED",
                "eventDuration": null,
                "overallElapsed": 52000,
                "overallPaused": 0,
                "overallOverdue": 0,
                "isBreached": false,
                "cycle": 1
            }
        ],
        "hoursOfBusinessDay": 24
    }
}

Get a work item's SLA history

GET /api/issue-sla-history/{issueId}

Returns the SLAs that have run on a work item, as a list of options.

Use this to discover which slaId values are available for a work item before calling Get the history of one SLA on a work item.

Honours work item permissions: if you cannot view the work item in Jira, the request is refused.

Path parameters

Parameter	Type	Required	Description
`issueId`	String	Yes	Work item ID or key, for example `10234` or `SUP-17`.

Request

curl -X GET "$BASE_URL/api/issue-sla-history/SUP-17" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

{
  "options": [
    {
      "value": "00091a2b-3c4d-4e5f-8a9b-0009c0d1e2f3",
      "label": "Time to first response"
    },
    {
      "value": "00081a2b-3c4d-4e5f-8a9b-0008c0d1e2f3",
      "label": "Time to resolution"
    }
  ],
  "issueId": 10234
}

Get work item SLAs by JQL

POST /api/issue-sla/

Returns SLA state for the work items matched by a JQL query.

Body parameters

Paging through results: when the response no longer contains a nextStart value, every matching work item has been returned and you can stop requesting further pages.

Parameter	Type	Required	Description
`jql`	String	Yes	JQL query selecting the work items to report on.
`slaId`	String	No	Restrict the result to a single SLA.
`start`	String	No	Pagination cursor. Omit it, or send an empty string, for the first page; for later pages send the `nextStart` value from the previous response.
`limit`	Integer	No	Page size. Keep this at 10 or lower to avoid hitting the 28-second request timeout.
`durationFormat`	String	No	Human-readable duration values instead of milliseconds. See Duration formats.

Request

curl -X POST "$BASE_URL/api/issue-sla/" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
  "jql": "project = SUP",
  "slaId": "38",
  "start": "SBGaXJl",
  "limit": 5
}

Response (abbreviated)

{
  "totalIssues": 1308,
  "nextStart": "CAEaAggD",
  "issueSlas": [
    {
      "issueId": "10006",
      "slaId": "9",
      "slaName": "test-all-cycles",
      "slaValueAsDurationString": "5m",
      "workingCalendarName": "7x24",
      "slaValueType": "SLA_VALUE",
      "slaStartType": {},
      "slaTargetType": {},
      "slaValueSourceName": "SLA_VALUE",
      "percentageThreshold": 80,
      "slaStatus": "EXCEED",
      "slaValue": 300000,
      "startDate": 1674790803000,
      "endDate": null,
      "deadline": 1674798315000,
      "elapsedDuration": 358963362,
      "remainingDuration": 0,
      "overdueDuration": 358663362,
      "pausedDuration": 30000,
      "elapsedPercentage": 119654,
      "isStarted": true,
      "isPaused": false,
      "isFinished": false,
      "inNonWorkingHours": false,
      "inNonWorkingDays": false,
      "inCriticalZone": true,
      "lastStatusDate": 1675156978362,
      "calendarId": "7x24",
      "workingDuration": 358963362,
      "slaValueForFixedDurations": null
    },
    {
      "issueId": "10005",
      "slaId": "9",
      "slaName": "test-all-cycles",
      "slaValueAsDurationString": "5m",
      "workingCalendarName": "7x24",
      "slaValueType": "SLA_VALUE",
      "slaStartType": {},
      "slaTargetType": {},
      "slaValueSourceName": "SLA_VALUE",
      "percentageThreshold": 80,
      "slaStatus": "EXCEED",
      "slaValue": 300000,
      "startDate": 1674486952000,
      "endDate": null,
      "deadline": 1674487252000,
      "elapsedDuration": 670026479,
      "remainingDuration": 0,
      "overdueDuration": 669726479,
      "pausedDuration": 0,
      "elapsedPercentage": 223342,
      "isStarted": true,
      "isPaused": false,
      "isFinished": false,
      "inNonWorkingHours": false,
      "inNonWorkingDays": false,
      "inCriticalZone": true,
      "lastStatusDate": 1675156978479,
      "calendarId": "7x24",
      "workingDuration": 670026479,
      "slaValueForFixedDurations": null
    }
  ]
}

Get work item SLAs by work item IDs

POST /api/issue-sla/multi

Returns SLA state for up to 100 work items, given their IDs.

Unlike the JQL endpoint, this one returns a plain array rather than a paged object.

Body parameters

Parameter	Type	Required	Description
`issueIds`	Array of integers	Yes	Work item IDs to report on. At most 100 per request.
`slaIds`	Array of strings	No	Restrict the result to specific SLAs.
`durationFormat`	String	No	Human-readable duration values instead of milliseconds. See Duration formats.

Request

curl -X POST "$BASE_URL/api/issue-sla/multi" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
    "issueIds": [
        10002,
        10003,
        10004,
        10005,
        10006
    ],
    "slaIds": [
        "9"
    ]
}

Response (abbreviated)

[
  {
    "issueId": "10006",
    "slaId": "9",
    "slaName": "test-all-cycles",
    "slaValueAsDurationString": "5m",
    "workingCalendarName": "7x24",
    "slaValueType": "SLA_VALUE",
    "slaStartType": {},
    "slaTargetType": {},
    "slaValueSourceName": "SLA_VALUE",
    "percentageThreshold": 80,
    "slaStatus": "EXCEED",
    "slaValue": 300000,
    "startDate": 1674790803000,
    "endDate": null,
    "deadline": 1674798315000,
    "elapsedDuration": 358963362,
    "remainingDuration": 0,
    "overdueDuration": 358663362,
    "pausedDuration": 30000,
    "elapsedPercentage": 119654,
    "isStarted": true,
    "isPaused": false,
    "isFinished": false,
    "inNonWorkingHours": false,
    "inNonWorkingDays": false,
    "inCriticalZone": true,
    "lastStatusDate": 1675156978362,
    "calendarId": "7x24",
    "workingDuration": 358963362,
    "slaValueForFixedDurations": null
  },
  {
    "issueId": "10005",
    "slaId": "9",
    "slaName": "test-all-cycles",
    "slaValueAsDurationString": "5m",
    "workingCalendarName": "7x24",
    "slaValueType": "SLA_VALUE",
    "slaStartType": {},
    "slaTargetType": {},
    "slaValueSourceName": "SLA_VALUE",
    "percentageThreshold": 80,
    "slaStatus": "EXCEED",
    "slaValue": 300000,
    "startDate": 1674486952000,
    "endDate": null,
    "deadline": 1674487252000,
    "elapsedDuration": 670026479,
    "remainingDuration": 0,
    "overdueDuration": 669726479,
    "pausedDuration": 0,
    "elapsedPercentage": 223342,
    "isStarted": true,
    "isPaused": false,
    "isFinished": false,
    "inNonWorkingHours": false,
    "inNonWorkingDays": false,
    "inCriticalZone": true,
    "lastStatusDate": 1675156978479,
    "calendarId": "7x24",
    "workingDuration": 670026479,
    "slaValueForFixedDurations": null
  }
]

Recalculation API

Start, monitor and abort recalculation jobs.

Get all recalculation jobs

GET /api/sla-recalculation

Returns every recalculation record.

Parameters

None.

Request

curl -X GET "$BASE_URL/api/sla-recalculation" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

[
    {
        "failRecordCount": 0,
        "tempAddToCount": 0,
        "lastPublishedThreadNumber": 1,
        "skey": "TASK_TYPE#SLA_RECALCULATE#PROCESS#1",
        "heartBeat": "2022-05-10T09:33:21.064Z",
        "expectedThreadCount": 1,
        "data": {
            "jql": "key = 'SUP-4'",
            "slaIds": [],
            "excludeFinishedSlas": false
        },
        "estimatedRecordCount": 1,
        "successRecordCount": 1,
        "messageGroupId": "000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3##1",
        "hangOnThreadNumberTempTest": 0,
        "completedRecordCount": 1,
        "messageDeduplicationId": "CK.000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3.JI.1.LPTN.0",
        "expectedRecordCount": 1,
        "jobId": "1",
        "startTime": "2022-05-10T09:33:15.188Z",
        "haltTasksOnThreadNumberTempTest": 0,
        "pkey": "CLIENT#000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3",
        "taskType": "SLA_RECALCULATE",
        "endTime": "2022-05-10T09:33:21.064Z",
        "remoteFetchSize": 400,
        "clientKey": "000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3",
        "loggingLevel": {
            "stats": false,
            "task": false
        },
        "jobStatus": "COMPLETED",
        "userAccountId": "5f8a1c2d3e4b5a6c7d8e9f01",
        "userData": {
            "self": "https://your-site.atlassian.net/rest/api/3/user?accountId=5f8a1c2d3e4b5a6c7d8e9f01",
            "accountId": "5f8a1c2d3e4b5a6c7d8e9f01",
            "accountType": "atlassian",
            "displayName": "SLA Administrator",
            "active": true,
            "timeZone": "Europe/Moscow",
            "locale": "en_US",
            "groups": {
                "size": 2,
                "items": [
                    {
                        "name": "administrators",
                        "groupId": "00051a2b-3c4d-4e5f-8a9b-0005c0d1e2f3",
                        "self": "https://your-site.atlassian.net/rest/api/3/group?groupId=00051a2b-3c4d-4e5f-8a9b-0005c0d1e2f3"
                    },
                    {
                        "name": "site-admins",
                        "groupId": "00071a2b-3c4d-4e5f-8a9b-0007c0d1e2f3",
                        "self": "https://your-site.atlassian.net/rest/api/3/group?groupId=00071a2b-3c4d-4e5f-8a9b-0007c0d1e2f3"
                    }
                ]
            },
            "applicationRoles": {
                "size": 2,
                "items": []
            },
            "expand": "groups,applicationRoles"
        }
    },
    {
        "failRecordCount": 0,
        "tempAddToCount": 0,
        "lastPublishedThreadNumber": 1,
        "skey": "TASK_TYPE#SLA_RECALCULATE#PROCESS#2",
        "heartBeat": "2022-05-11T09:28:33.047Z",
        "expectedThreadCount": 1,
        "data": {
            "jql": "key = 'SUP-1041'",
            "slaIds": [],
            "excludeFinishedSlas": false
        },
        "estimatedRecordCount": 1,
        "successRecordCount": 1,
        "messageGroupId": "000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3##2",
        "hangOnThreadNumberTempTest": 0,
        "completedRecordCount": 1,
        "messageDeduplicationId": "CK.000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3.JI.2.LPTN.0",
        "expectedRecordCount": 1,
        "jobId": "2",
        "startTime": "2022-05-11T09:28:27.295Z",
        "haltTasksOnThreadNumberTempTest": 0,
        "pkey": "CLIENT#000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3",
        "taskType": "SLA_RECALCULATE",
        "endTime": "2022-05-11T09:28:33.047Z",
        "remoteFetchSize": 400,
        "clientKey": "000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3",
        "loggingLevel": {
            "stats": false,
            "task": false
        },
        "jobStatus": "COMPLETED",
        "userAccountId": "5f8a1c2d3e4b5a6c7d8e9f01",
        "userData": {
            "self": "https://your-site.atlassian.net/rest/api/3/user?accountId=5f8a1c2d3e4b5a6c7d8e9f01",
            "accountId": "5f8a1c2d3e4b5a6c7d8e9f01",
            "accountType": "atlassian",
            "displayName": "SLA Administrator",
            "active": true,
            "timeZone": "Europe/Moscow",
            "locale": "en_US",
            "groups": {
                "size": 2,
                "items": [
                    {
                        "name": "administrators",
                        "groupId": "00051a2b-3c4d-4e5f-8a9b-0005c0d1e2f3",
                        "self": "https://your-site.atlassian.net/rest/api/3/group?groupId=00051a2b-3c4d-4e5f-8a9b-0005c0d1e2f3"
                    },
                    {
                        "name": "site-admins",
                        "groupId": "00071a2b-3c4d-4e5f-8a9b-0007c0d1e2f3",
                        "self": "https://your-site.atlassian.net/rest/api/3/group?groupId=00071a2b-3c4d-4e5f-8a9b-0007c0d1e2f3"
                    }
                ]
            },
            "applicationRoles": {
                "size": 2,
                "items": []
            },
            "expand": "groups,applicationRoles"
        }
    }
]

Get a recalculation job

GET /api/sla-recalculation/{jobId}

Returns a single recalculation job by ID.

Path parameters

Parameter	Description
`jobId`	ID of the recalculation job.

Request

curl -X GET "$BASE_URL/api/sla-recalculation/1" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

{
    "failRecordCount": 0,
    "tempAddToCount": 0,
    "lastPublishedThreadNumber": 1,
    "skey": "TASK_TYPE#SLA_RECALCULATE#PROCESS#1",
    "heartBeat": "2022-05-10T09:33:21.064Z",
    "expectedThreadCount": 1,
    "data": {
        "jql": "key = 'SUP-4'",
        "slaIds": [],
        "excludeFinishedSlas": false
    },
    "estimatedRecordCount": 1,
    "successRecordCount": 1,
    "messageGroupId": "000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3##1",
    "hangOnThreadNumberTempTest": 0,
    "completedRecordCount": 1,
    "messageDeduplicationId": "CK.000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3.JI.1.LPTN.0",
    "expectedRecordCount": 1,
    "jobId": "1",
    "startTime": "2022-05-10T09:33:15.188Z",
    "haltTasksOnThreadNumberTempTest": 0,
    "pkey": "CLIENT#000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3",
    "taskType": "SLA_RECALCULATE",
    "endTime": "2022-05-10T09:33:21.064Z",
    "remoteFetchSize": 400,
    "clientKey": "000b1a2b-3c4d-4e5f-8a9b-000bc0d1e2f3",
    "loggingLevel": {
        "stats": false,
        "task": false
    },
    "jobStatus": "COMPLETED",
    "userAccountId": "5f8a1c2d3e4b5a6c7d8e9f01",
    "userData": {
        "self": "https://your-site.atlassian.net/rest/api/3/user?accountId=5f8a1c2d3e4b5a6c7d8e9f01",
        "accountId": "5f8a1c2d3e4b5a6c7d8e9f01",
        "accountType": "atlassian",
        "displayName": "SLA Administrator",
        "active": true,
        "timeZone": "Europe/Moscow",
        "locale": "en_US",
        "groups": {
            "size": 2,
            "items": [
                {
                    "name": "administrators",
                    "groupId": "00051a2b-3c4d-4e5f-8a9b-0005c0d1e2f3",
                    "self": "https://your-site.atlassian.net/rest/api/3/group?groupId=00051a2b-3c4d-4e5f-8a9b-0005c0d1e2f3"
                },
                {
                    "name": "site-admins",
                    "groupId": "00071a2b-3c4d-4e5f-8a9b-0007c0d1e2f3",
                    "self": "https://your-site.atlassian.net/rest/api/3/group?groupId=00071a2b-3c4d-4e5f-8a9b-0007c0d1e2f3"
                }
            ]
        },
        "applicationRoles": {
            "size": 2,
            "items": []
        },
        "expand": "groups,applicationRoles"
    }
}

Start a recalculation

POST /api/sla-recalculation

Starts a recalculation job over the work items matched by a JQL query.

Body parameters

Parameter	Type	Required	Description
`jql`	String	Yes	JQL query selecting the work items to recalculate.
`slaIds`	Array of strings	No	SLAs to recalculate. An empty array recalculates every SLA.
`excludeFinishedSlas`	Boolean	No	When true, SLAs that have already finished are left untouched.

Request

curl -X POST "$BASE_URL/api/sla-recalculation" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
    "jql": "key='SUP-1'",
    "slaIds": [],
    "excludeFinishedSlas": true
}

Abort a recalculation

POST /api/sla-recalculation/{jobId}

Aborts the running recalculation job with the given ID.

Path parameters

Parameter	Description
`jobId`	ID of the recalculation job.

Request

curl -X POST "$BASE_URL/api/sla-recalculation/1" \
  -H "Authorization: Bearer $JWT_TOKEN"

Permissions API

Read and update Time to SLA permissions.

Get all permissions

GET /api/permissions

Returns the full Time to SLA permission configuration.

One object is returned per permission entry.

Parameters

None.

Request

curl -X GET "$BASE_URL/api/permissions" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response (abbreviated)

[
  {
    "name": "Audit Logs",
    "groups": [
      {
        "value": "00051a2b-3c4d-4e5f-8a9b-0005c0d1e2f3",
        "label": "administrators"
      }
    ],
    "id": "00061a2b-3c4d-4e5f-8a9b-0006c0d1e2f3",
    "users": [
      {
        "label": "SLA Administrator",
        "value": "5f8a1c2d3e4b5a6c7d8e9f01"
      }
    ],
    "order": 10
  },
  {
    "name": "Calendars",
    "groups": [
      {
        "value": "00051a2b-3c4d-4e5f-8a9b-0005c0d1e2f3",
        "label": "administrators"
      },
      {
        "value": "00071a2b-3c4d-4e5f-8a9b-0007c0d1e2f3",
        "label": "site-admins"
      }
    ],
    "id": "00081a2b-3c4d-4e5f-8a9b-0008c0d1e2f3",
    "users": [
      {
        "label": "SLA Administrator",
        "value": "5f8a1c2d3e4b5a6c7d8e9f01"
      }
    ],
    "order": 2
  }
]

Update a permission

PUT /api/permissions

Updates a single Time to SLA permission entry.

Send the whole entry — the groups and users arrays you supply replace the stored ones, so an empty array clears that grant.

Body parameters

Parameter	Type	Required	Description
`id`	String	Yes	ID of the permission entry to update, as returned by Get all permissions.
`name`	String	Yes	Name of the permission entry.
`order`	Integer	Yes	Display order of the entry.
`groups`	Array of objects	No	Jira groups granted this permission — each takes a value (group ID) and a label (group name).
`users`	Array of objects	No	Individual users granted this permission — each takes a value (account ID) and an optional label.

Request

curl -X PUT "$BASE_URL/api/permissions" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
  "id": "00091a2b-3c4d-4e5f-8a9b-0009c0d1e2f3",
  "name": "SLA Configurations",
  "order": 0,
  "groups": [
    {
      "value": "000a1a2b-3c4d-4e5f-8a9b-000ac0d1e2f3",
      "label": "system-administrators"
    }
  ],
  "users": [
  ]
}

Response (abbreviated)

{
    "permissionSettings": [
        {
            "name": "Audit Logs",
            "groups": [
                {
                    "value": "00051a2b-3c4d-4e5f-8a9b-0005c0d1e2f3",
                    "label": "administrators"
                }
            ],
            "id": "00061a2b-3c4d-4e5f-8a9b-0006c0d1e2f3",
            "users": [
                {
                    "value": "5f8a1c2d3e4b5a6c7d8e9f01"
                }
            ],
            "order": 10
        },
        {
            "name": "Calendars",
            "groups": [
                {
                    "value": "00051a2b-3c4d-4e5f-8a9b-0005c0d1e2f3",
                    "label": "administrators"
                },
                {
                    "value": "00071a2b-3c4d-4e5f-8a9b-0007c0d1e2f3",
                    "label": "site-admins"
                }
            ],
            "id": "00081a2b-3c4d-4e5f-8a9b-0008c0d1e2f3",
            "users": [
                {
                    "value": "5f8a1c2d3e4b5a6c7d8e9f01",
                    "label": "SLA Administrator"
                }
            ],
            "order": 2
        }
    ],
    "permittedPages": [
        "Audit Logs",
        "SLA History",
        "Calendars",
        "SLA Summary Report",
        "SLA Detail Report",
        "Permissions",
        "Customer Portal SLAs",
        "Settings",
        "SLA Panel"
    ]
}

SLA reports API

List reports and queue a background export.

Get all SLA reports

GET /api/sla-reports

Returns every generated SLA report with its state and download URL.

Parameters

None.

Request

curl -X GET "$BASE_URL/api/sla-reports" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

[
    {
        "pkey": "CLIENT#000c1a2b-3c4d-4e5f-8a9b-000cc0d1e2f3",
        "skey": "BACKGROUND_REPORT#000d1a2b-3c4d-4e5f-8a9b-000dc0d1e2f3",
        "createdDate": 1672663965767,
        "createdBy": "5f8a1c2d3e4b5a6c7d8e9f01",
        "updatedDate": 1672663976884,
        "updatedBy": "5f8a1c2d3e4b5a6c7d8e9f01",
        "id": "000d1a2b-3c4d-4e5f-8a9b-000dc0d1e2f3",
        "name": "sample-report",
        "configuration": {
            "status": [],
            "timeFormat": "dayHourMinuteSecond",
            "slaIds": [],
            "additionalFields": [
                "issuetype",
                "summary",
                "priority",
                "reporter",
                "assignee",
                "status"
            ],
            "startDateFilter": null,
            "endDateFilter": null,
            "targetDateFilter": null,
            "filterType": "PROJECT",
            "reportType": "SUMMARY",
            "states": [],
            "elapsedFilter": {},
            "remainingFilter": {},
            "chartInterval": null,
            "downloadUrlExpireTime": 7200000
        },
        "state": "DONE",
        "location": "https://tts-reports.s3.eu-west-1.amazonaws.com/sample-report.csv",
        "downloadUrl": "https://tts-reports.s3.eu-west-1.amazonaws.com/sample-report.csv",
        "reportRequestType": "SIMPLE"
    }
]

Generate a background report

POST /api/sla-background-report

Queues a background SLA report export and returns its download URL.

Query parameters

Parameter	Type	Required	Description
`downloadUrlExpireTime`	Integer	No	How long the generated download URL stays valid, in milliseconds. Minimum 3600000 (1 hour), maximum 43200000 (12 hours).

Request

curl -X POST "$BASE_URL/api/sla-background-report" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
  "status": [],
  "states": [],
  "timeFormat": "dayHourMinuteSecond",
  "slaIds": [],
  "additionalFields": [
    "issuetype",
    "summary",
    "priority",
    "reporter",
    "assignee",
    "status"
  ],
  "slaColumns": [
    "startTime",
    "deadline",
    "endTime",
    "workingDuration",
    "remainingDuration",
    "pausedDuration",
    "breachString"
  ],
  "startDateFilter": null,
  "endDateFilter": null,
  "targetDateFilter": null,
  "filterValue": "issuekey > \"SUP-1042\"",
  "filterType": "JQL",
  "reportType": "SUMMARY",
  "elapsedFilter": {},
  "remainingFilter": {},
  "inCriticalZone": null,
  "downloadUrlExpireTime": 7200000
}

Response

{
    "id": "000e1a2b-3c4d-4e5f-8a9b-000ec0d1e2f3",
    "name": "tts-summary-report_2023-03-07T18:40:54.580+03:00",
    "state": "DONE",
    "location": "https://tts-reports.s3.eu-west-1.amazonaws.com/tts-summary-report.csv",
    "downloadUrl": "https://tts-reports.s3.eu-west-1.amazonaws.com/tts-summary-report.csv?X-Amz-Expires=7200"
}

Settings API

App-level settings.

Save advanced settings

POST /api/advanced-settings

Replaces the app-level advanced settings: the custom field update interval, the retention periods for old reports and audit logs, and the default event cardinality map.

All four fields are required. This is a full replacement, not a partial update, and unknown fields are rejected.

Body parameters

Parameter	Type	Required	Description
`cfUpdateInterval`	Object	Yes	How often SLA custom fields are refreshed. Takes `value` and `label`, both integers.
`cleanOldReportDto`	Object	Yes	Retention for generated reports. Takes `timeInput` (integer) and `timePeriod` (string).
`cleanOldAuditLogsDto`	Object	Yes	Retention for audit logs. Takes `timeInput` (integer) and `timePeriod` (string).
`defaultEventCardinalityMap`	String	Yes	A JSON-encoded object, sent as a string, mapping each event type to its default cardinality.

Request

curl -X POST "$BASE_URL/api/advanced-settings" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json

Examples

Request body

{
  "cfUpdateInterval": {
    "value": 15,
    "label": 15
  },
  "cleanOldReportDto": {
    "timeInput": 30,
    "timePeriod": "days"
  },
  "cleanOldAuditLogsDto": {
    "timeInput": 90,
    "timePeriod": "days"
  },
  "defaultEventCardinalityMap": "{\"SLA_START\":1,\"SLA_STOP\":1}"
}

Account API

Identify the account a token belongs to.

Identify the current token

GET /api/whoami

Returns the data residency region the token belongs to, and the regional base URL that token must use.

Use this to confirm you are calling the right regional host before running an integration. Requests sent to the wrong regional base URL are redirected today, but will be blocked in a future release.

This is the only endpoint that requires no Time to SLA permission: it reports where the token lives, not any SLA data.

Parameters

None.

Request

curl -X GET "$BASE_URL/api/whoami" \
  -H "Authorization: Bearer $JWT_TOKEN"

Examples

Response

{
  "dataRegion": "EU",
  "restApiUrl": "https://tts-eu.snapbytesapps.com"
}