The Timepiece REST API provides a set of endpoints grouped into two categories: Report Endpoints that return time-in-status data for issues, and Administration Endpoints that allow programmatic management of Timepiece configuration. All endpoints require a valid tisjwt token for authorization and must be called against the base service URL https://tis.obss.io/.
Report Endpoints
Single Issue
GET /rest/issue
Returns a Timepiece report for a single Jira issue identified by its issue key. The response can be returned in CSV or JSON format. Supports all report types available on the Timepiece UI, including Status Duration, Assignee Duration, Duration Between Statuses, Date reports, and more. History trimming, custom calendars, and field columns are also supported.
See Single Issue for the full parameter reference and example requests.
Single Issue Expanded
GET /rest/issue/expanded
Returns the full status transition history for a single issue in a row-per-transition format, rather than one aggregated duration per status. Each row in the response represents one individual visit to a status, including the start time, end time, and duration of that visit. Useful when you need the complete timeline of an issue rather than a summary.
See Single Issue Expanded for the full parameter reference and example requests.
Issue List
GET /rest/issues
Returns a Timepiece report for a list of issues matching a given filter, with pagination support. The filter can be defined by project, user, JQL filter ID, sprint, or a custom JQL query — mirroring the filter types available in the Timepiece UI. Supports all report types, custom calendars, field columns, history trimming, and multi-visit behavior configuration.
See Issue List for the full parameter reference and example requests.
Issue List v2
GET /rest/issues/v2
An updated version of the Issue List endpoint with enhanced parameter support, including group-by field capabilities that allow results to be grouped by any Jira field value. This endpoint is the recommended choice for new integrations that require grouped or segmented list data.
See Issue List v2 for the full parameter reference and example requests.
Issue Aggregation
GET /rest/issues/aggregation
Returns aggregated Timepiece report data across a set of issues. Instead of returning one row per issue, this endpoint computes and returns a single aggregate row representing the Sum, Average, Median, or Standard Deviation of duration values across all matched issues. Supports the same filter types as the Issue List endpoint.
See Issue Aggregation for the full parameter reference and example requests.
File Export
POST /rest/export/status
Generates a Timepiece report and returns it as a downloadable file in CSV, XLS, or XLSX format. Supports two modes of operation: Synchronous (Small Export) for smaller datasets where the file is returned directly in the response, and Asynchronous (Large Export) for larger datasets where the export is queued and a download link is returned once the file is ready. This is the endpoint used by the Sample Spreadsheet Integration templates.
See File Export for the full parameter reference, including how to poll for async export status and retrieve the completed file.
Administration Endpoints
Statuses
GET /rest/statuses
Returns the list of Jira workflow statuses available on the instance, including their IDs and names. Use this endpoint to look up status IDs when building requests for report endpoints that require status parameters.
See Statuses for the full parameter reference and example responses.
Custom Calendars
GET /rest/calendars
Returns the list of custom business calendars configured in Timepiece, including their IDs, names, timezone settings, and working time definitions. Use this endpoint to look up calendar IDs when building report requests that use a custom calendar.
See Custom Calendars for the full parameter reference and example responses.
Parameter Sets
GET /rest/reportSettings GET /rest/reportSettings/<param_set_id>
Provides access to saved Timepiece parameter sets. The list endpoint returns all parameter sets visible to the authenticated user, including their IDs and names. The detail endpoint returns the full configuration of a single parameter set. Parameter set IDs retrieved here can be used in report endpoint requests to run reports based on saved configurations.
See Parameter Sets for the full parameter reference and example responses.
Format Settings API
GET /rest/formatSettings PUT /rest/formatSettings
Allows reading and updating the Timepiece date and datetime format settings programmatically. The GET endpoint returns the currently configured formats. The PUT endpoint allows updating them. The formats set here are used as the default display format for date fields in all Timepiece reports and exports.
See Format Settings API for the full parameter reference and example requests.