The Format Settings API allows you to programmatically read and update the date and datetime display formats configured in Timepiece. These format settings control how Jira date field values are displayed in Timepiece reports on screen and in exported files. If no custom formats are configured, Timepiece falls back to the default date formats defined in Jira's own Look & Feel settings.
The API group consists of two endpoints.
Get Format Settings
GET /rest/formatSettings
Returns the currently configured dateFormat and dateTimeFormat values for the instance. All users with Timepiece access can call this endpoint, no admin permissions are required. The response is a simple JSON object with two string fields. If no custom formats have been set, the response will reflect the Jira instance defaults.
See Get Format Settings for the full reference and example response.
Update Format Settings
PUT /rest/formatSettings
Replaces the current dateFormat and dateTimeFormat values with the ones provided in the request body. The format strings follow standard Java date format patterns. The response returns the updated format values on success. Only Jira Admins can call this endpoint.
See Update Format Settings for the full request body reference and example.