openapi: 3.2.0 info: contact: email: ecosystem@atlassian.com description: Jira Cloud platform REST API documentation license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/ title: Jira Cloud platform REST Issue worklogs API version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df servers: - url: https://your-domain.atlassian.net tags: - description: 'This resource represents issue worklogs. Use it to: * get, create, update, and delete worklogs. * obtain lists of updated or deleted worklogs.' name: Issue Worklogs paths: /rest/api/3/issue/{issueIdOrKey}/worklog: delete: deprecated: false description: 'Deletes a list of worklogs from an issue. This is an experimental API with limitations: * You can''t delete more than 5000 worklogs at once. * No notifications will be sent for deleted worklogs. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. **Permissions required:** * *Browse projects* project permission for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue. * *Delete all worklogs* project permission to delete any worklog. * If any worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.' operationId: bulkDeleteWorklogs parameters: - description: The ID or key of the issue. in: path name: issueIdOrKey required: true schema: type: string - description: "Defines how to update the issue's time estimate, the options are:\n\n * `leave` Leaves the estimate unchanged.\n * `auto` Reduces the estimate by the aggregate value of `timeSpent` across all worklogs being deleted." in: query name: adjustEstimate schema: default: auto enum: - leave - auto type: string - description: Whether the work log entries should be removed to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag. in: query name: overrideEditableFlag schema: default: false type: boolean requestBody: content: application/json: example: ids: - 1 - 2 - 5 - 10 schema: $ref: '#/components/schemas/WorklogIdsRequestBean' description: A JSON object containing a list of worklog IDs. required: true responses: '200': description: Returned if the bulk deletion request was partially successful, with a message indicating partial success. '204': description: Returned if the request is successful. '400': description: "Returned if:\n\n * `request` is not provided or is invalid\n * the user does not have permission to delete the worklogs\n * the number of worklogs being deleted exceeds the limit" '401': description: Returned if the authentication credentials are incorrect. '404': description: "Returned if:\n\n * the issue is not found or user does not have permission to view the issue\n * at least one of the worklogs is not associated with the provided issue\n * time tracking is disabled" security: - basicAuth: [] - OAuth2: - write:jira-work - {} summary: Bulk delete worklogs tags: - Issue Worklogs x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - write:jira-work state: Current - scheme: OAuth2 scopes: - delete:issue-worklog:jira - delete:issue-worklog.property:jira - write:issue.time-tracking:jira - read:group:jira - read:issue-worklog:jira - read:project-role:jira - read:user:jira - read:issue-worklog.property:jira state: Beta x-experimental: true x-atlassian-connect-scope: DELETE get: deprecated: false description: 'Returns worklogs for an issue (ordered by created time), starting from the oldest worklog or from the worklog started on or after a date and time. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously. **Permissions required:** Workloads are only returned where the user has: * *Browse projects* project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue. * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.' operationId: getIssueWorklog parameters: - description: The ID or key of the issue. in: path name: issueIdOrKey required: true schema: type: string - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 5000 format: int32 type: integer - description: The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned. in: query name: startedAfter schema: format: int64 type: integer - description: The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned. in: query name: startedBefore schema: format: int64 type: integer - description: Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts`properties`, which returns worklog properties. in: query name: expand schema: default: '' type: string responses: '200': content: application/json: example: '{"maxResults":1,"startAt":0,"total":1,"worklogs":[{"author":{"accountId":"5b10a2844c20165700ede21g","active":false,"displayName":"Mia Krystof","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"comment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"I did some work here."}]}]},"id":"100028","issueId":"10002","self":"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000","started":"2021-01-17T12:34:00.000+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"updateAuthor":{"accountId":"5b10a2844c20165700ede21g","active":false,"displayName":"Mia Krystof","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"updated":"2021-01-18T23:45:00.000+0000","visibility":{"identifier":"276f955c-63d7-42c8-9520-92d01dca0625","type":"group","value":"jira-developers"}}]}' schema: $ref: '#/components/schemas/PageOfWorklogs' description: Returned if the request is successful '401': description: Returned if the authentication credentials are incorrect or missing. '404': description: "Returned if:\n\n * the issue is not found or the user does not have permission to view the issue.\n * `startAt` or `maxResults` has non-numeric values.\n * time tracking is disabled." security: - basicAuth: [] - OAuth2: - read:jira-work - {} summary: Get issue worklogs tags: - Issue Worklogs x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - read:jira-work state: Current - scheme: OAuth2 scopes: - read:group:jira - read:issue-worklog:jira - read:issue-worklog.property:jira - read:project-role:jira - read:user:jira - read:avatar:jira state: Beta x-atlassian-connect-scope: READ post: deprecated: false description: 'Adds a worklog to an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously. **Permissions required:** * *Browse projects* and *Work on issues* project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue.' operationId: addWorklog parameters: - description: The ID or key the issue. in: path name: issueIdOrKey required: true schema: type: string - description: Whether users watching the issue are notified by email. in: query name: notifyUsers schema: default: true type: boolean - description: "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `manual` Reduces the estimate by amount specified in `reduceBy`.\n * `auto` Reduces the estimate by the value of `timeSpent` in the worklog." in: query name: adjustEstimate schema: default: auto enum: - new - leave - manual - auto type: string - description: The value to set as the issue's remaining time estimate, as days (\#d), hours (\#h), or minutes (\#m or \#). For example, *2d*. Required when `adjustEstimate` is `new`. in: query name: newEstimate schema: type: string - description: The amount to reduce the issue's remaining estimate by, as days (\#d), hours (\#h), or minutes (\#m). For example, *2d*. Required when `adjustEstimate` is `manual`. in: query name: reduceBy schema: type: string - description: Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts `properties`, which returns worklog properties. in: query name: expand schema: default: '' type: string - description: Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag. in: query name: overrideEditableFlag schema: default: false type: boolean requestBody: content: application/json: example: comment: content: - content: - text: I did some work here. type: text type: paragraph type: doc version: 1 started: 2021-01-17T12:34:00.000+0000 timeSpentSeconds: 12000 visibility: identifier: 276f955c-63d7-42c8-9520-92d01dca0625 type: group schema: $ref: '#/components/schemas/Worklog' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Worklog' description: Returned if the request is successful. '400': description: "Returned if:\n\n * `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.\n * `adjustEstimate` is set to `manual` but `reduceBy` is not provided or is invalid.\n * the user does not have permission to add the worklog.\n * the request JSON is malformed." '401': description: Returned if the authentication credentials are incorrect. '404': description: Returned if the issue is not found or the user does not have permission to view it. '413': description: "Returned if the per-issue limit has been breached for one of the following fields:\n\n * worklogs\n * attachments" security: - basicAuth: [] - OAuth2: - write:jira-work - {} summary: Add worklog tags: - Issue Worklogs x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - write:jira-work state: Current - scheme: OAuth2 scopes: - write:issue-worklog:jira - write:issue-worklog.property:jira - read:avatar:jira - read:group:jira - read:issue-worklog:jira - read:project-role:jira - read:user:jira - read:issue-worklog.property:jira state: Beta x-atlassian-connect-scope: WRITE /rest/api/3/issue/{issueIdOrKey}/worklog/move: post: deprecated: false description: 'Moves a list of worklogs from one issue to another. This is an experimental API with several limitations: * You can''t move more than 5000 worklogs at once. * You can''t move worklogs containing an attachment. * You can''t move worklogs restricted by project roles. * No notifications will be sent for moved worklogs. * No webhooks or events will be sent for moved worklogs. * No issue history will be recorded for moved worklogs. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. **Permissions required:** * *Browse projects* project permission for the projects containing the source and destination issues. * If issue-level security is configured, issue-level security permission to view the issue. * *Delete all worklogs* project permission * *Work on issues* project permission to log work on an issue, that is to create a worklog entry, if time tracking is enabled. This permission is required as a prerequisite for applying the other time-tracking permissions * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.' operationId: bulkMoveWorklogs parameters: - in: path name: issueIdOrKey required: true schema: type: string - description: "Defines how to update the issues' time estimate, the options are:\n\n * `leave` Leaves the estimate unchanged.\n * `auto` Reduces the estimate by the aggregate value of `timeSpent` across all worklogs being moved in the source issue, and increases it in the destination issue." in: query name: adjustEstimate schema: default: auto enum: - leave - auto type: string - description: Whether the work log entry should be moved to and from the issues even if the issues are not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag. in: query name: overrideEditableFlag schema: default: false type: boolean requestBody: content: application/json: example: ids: - 1 - 2 - 5 - 10 issueIdOrKey: ABC-1234 schema: $ref: '#/components/schemas/WorklogsMoveRequestBean' description: A JSON object containing a list of worklog IDs and the ID or key of the destination issue. required: true responses: '200': description: Returned if the request is partially successful. '204': description: Returned if the request is successful. '400': description: "Returned if:\n\n * `request` is not provided or is invalid\n * the user does not have permission to move the worklogs\n * the number of worklogs being moved exceeds the limit\n * the total size of worklogs being moved is too large\n * any worklog contains attachments" '401': description: Returned if the authentication credentials are incorrect. '404': description: "Returned if:\n\n * the source or destination issue is not found or the user does not have permission to view the issues\n * at least one of the worklogs is not associated with the provided issue\n * time tracking is disabled" security: - basicAuth: [] - OAuth2: - write:jira-work - {} summary: Bulk move worklogs tags: - Issue Worklogs x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - write:jira-work state: Current - scheme: OAuth2 scopes: - read:issue-worklog:jira - write:issue-worklog:jira - delete:issue-worklog:jira - read:issue-worklog.property:jira - write:issue-worklog.property:jira - delete:issue-worklog.property:jira - write:issue.time-tracking:jira - read:group:jira - read:project-role:jira - read:user:jira state: Beta x-experimental: true x-atlassian-connect-scope: WRITE /rest/api/3/issue/{issueIdOrKey}/worklog/{id}: delete: deprecated: false description: 'Deletes a worklog from an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously. **Permissions required:** * *Browse projects* project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue. * *Delete all worklogs* project permission to delete any worklog or *Delete own worklogs* to delete worklogs created by the user, * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.' operationId: deleteWorklog parameters: - description: The ID or key of the issue. in: path name: issueIdOrKey required: true schema: type: string - description: The ID of the worklog. in: path name: id required: true schema: type: string - description: Whether users watching the issue are notified by email. in: query name: notifyUsers schema: default: true type: boolean - description: "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `manual` Increases the estimate by amount specified in `increaseBy`.\n * `auto` Reduces the estimate by the value of `timeSpent` in the worklog." in: query name: adjustEstimate schema: default: auto enum: - new - leave - manual - auto type: string - description: The value to set as the issue's remaining time estimate, as days (\#d), hours (\#h), or minutes (\#m or \#). For example, *2d*. Required when `adjustEstimate` is `new`. in: query name: newEstimate schema: type: string - description: The amount to increase the issue's remaining estimate by, as days (\#d), hours (\#h), or minutes (\#m or \#). For example, *2d*. Required when `adjustEstimate` is `manual`. in: query name: increaseBy schema: type: string - description: Whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag. in: query name: overrideEditableFlag schema: default: false type: boolean responses: '204': description: Returned if the request is successful. '400': description: "Returned if:\n\n * `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.\n * `adjustEstimate` is set to `manual` but `reduceBy` is not provided or is invalid.\n * the user does not have permission to delete the worklog." '401': description: Returned if the authentication credentials are incorrect. '404': description: "Returned if:\n\n * the issue is not found or user does not have permission to view the issue.\n * the worklog is not found or the user does not have permission to view it.\n * time tracking is disabled." security: - basicAuth: [] - OAuth2: - write:jira-work - {} summary: Delete worklog tags: - Issue Worklogs x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - write:jira-work state: Current - scheme: OAuth2 scopes: - delete:issue-worklog:jira - delete:issue-worklog.property:jira - write:issue.time-tracking:jira state: Beta x-atlassian-connect-scope: DELETE get: deprecated: false description: 'Returns a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously. **Permissions required:** * *Browse projects* project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue. * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.' operationId: getWorklog parameters: - description: The ID or key of the issue. in: path name: issueIdOrKey required: true schema: type: string - description: The ID of the worklog. in: path name: id required: true schema: type: string - description: 'Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts `properties`, which returns worklog properties.' in: query name: expand schema: default: '' type: string responses: '200': content: application/json: example: '{"author":{"accountId":"5b10a2844c20165700ede21g","active":false,"displayName":"Mia Krystof","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"comment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"I did some work here."}]}]},"id":"100028","issueId":"10002","self":"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000","started":"2021-01-17T12:34:00.000+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"updateAuthor":{"accountId":"5b10a2844c20165700ede21g","active":false,"displayName":"Mia Krystof","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"updated":"2021-01-18T23:45:00.000+0000","visibility":{"identifier":"276f955c-63d7-42c8-9520-92d01dca0625","type":"group","value":"jira-developers"}}' schema: $ref: '#/components/schemas/Worklog' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect. '404': description: "Returned if:\n\n * the issue is not found or the user does not have permission to view it.\n * the worklog is not found or the user does not have permission to view it.\n * time tracking is disabled.\n\n." security: - basicAuth: [] - OAuth2: - read:jira-work - {} summary: Get worklog tags: - Issue Worklogs x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - read:jira-work state: Current - scheme: OAuth2 scopes: - read:comment:jira - read:group:jira - read:issue-worklog:jira - read:issue-worklog.property:jira - read:project-role:jira - read:user:jira - read:avatar:jira state: Beta x-atlassian-connect-scope: READ put: deprecated: false description: 'Updates a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously. **Permissions required:** * *Browse projects* project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue. * *Edit all worklogs* project permission to update any worklog or *Edit own worklogs* to update worklogs created by the user. * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.' operationId: updateWorklog parameters: - description: The ID or key the issue. in: path name: issueIdOrKey required: true schema: type: string - description: The ID of the worklog. in: path name: id required: true schema: type: string - description: Whether users watching the issue are notified by email. in: query name: notifyUsers schema: default: true type: boolean - description: "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `auto` Updates the estimate by the difference between the original and updated value of `timeSpent` or `timeSpentSeconds`." in: query name: adjustEstimate schema: default: auto enum: - new - leave - manual - auto type: string - description: The value to set as the issue's remaining time estimate, as days (\#d), hours (\#h), or minutes (\#m or \#). For example, *2d*. Required when `adjustEstimate` is `new`. in: query name: newEstimate schema: type: string - description: Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties`, which returns worklog properties. in: query name: expand schema: default: '' type: string - description: Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag. in: query name: overrideEditableFlag schema: default: false type: boolean requestBody: content: application/json: example: comment: content: - content: - text: I did some work here. type: text type: paragraph type: doc version: 1 started: 2021-01-17T12:34:00.000+0000 timeSpentSeconds: 12000 visibility: identifier: 276f955c-63d7-42c8-9520-92d01dca0625 type: group schema: $ref: '#/components/schemas/Worklog' required: true responses: '200': content: application/json: example: '{"author":{"accountId":"5b10a2844c20165700ede21g","active":false,"displayName":"Mia Krystof","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"comment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"I did some work here."}]}]},"id":"100028","issueId":"10002","self":"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000","started":"2021-01-17T12:34:00.000+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"updateAuthor":{"accountId":"5b10a2844c20165700ede21g","active":false,"displayName":"Mia Krystof","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"updated":"2021-01-18T23:45:00.000+0000","visibility":{"identifier":"276f955c-63d7-42c8-9520-92d01dca0625","type":"group","value":"jira-developers"}}' schema: $ref: '#/components/schemas/Worklog' description: Returned if the request is successful '400': description: "Returned if:\n\n * `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.\n * the user does not have permission to update the worklog.\n * the request JSON is malformed." '401': description: Returned if the authentication credentials are incorrect. '404': description: "Returned if:\n\n * the issue is not found or user does not have permission to view the issue.\n * the worklog is not found or the user does not have permission to view it.\n * time tracking is disabled." security: - basicAuth: [] - OAuth2: - write:jira-work - {} summary: Update worklog tags: - Issue Worklogs x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - write:jira-work state: Current - scheme: OAuth2 scopes: - read:comment:jira - read:group:jira - read:issue-worklog:jira - read:issue-worklog.property:jira - read:project-role:jira - read:user:jira - write:comment:jira - write:issue-worklog:jira - write:issue-worklog.property:jira - read:avatar:jira state: Beta x-atlassian-connect-scope: WRITE /rest/api/3/worklog/deleted: get: deprecated: false description: 'Returns a list of IDs and delete timestamps for worklogs deleted after a date and time. This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, `until` indicates the timestamp of the youngest item on the page. Also, `nextPage` provides the URL for the next page of worklogs. The `lastPage` parameter is set to true on the last page of worklogs. This resource does not return worklogs deleted during the minute preceding the request. **Permissions required:** Permission to access Jira.' operationId: getIdsOfWorklogsDeletedSince parameters: - description: The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned. in: query name: since schema: default: 0 format: int64 type: integer responses: '200': content: application/json: example: '{"lastPage":true,"nextPage":"https://your-domain.atlassian.net/api/~ver~/worklog/deleted?since=1438013693136","self":"https://your-domain.atlassian.net/api/~ver~/worklog/deleted?since=1438013671562","since":1438013671562,"until":1438013693136,"values":[{"properties":[],"updatedTime":1438013671562,"worklogId":103},{"properties":[],"updatedTime":1438013672165,"worklogId":104},{"properties":[],"updatedTime":1438013693136,"worklogId":105}]}' schema: $ref: '#/components/schemas/ChangedWorklogs' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. security: - basicAuth: [] - OAuth2: - read:jira-work summary: Get IDs of deleted worklogs tags: - Issue Worklogs x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - read:jira-work state: Current - scheme: OAuth2 scopes: - read:issue-worklog:jira - read:issue-worklog.property:jira state: Beta x-atlassian-connect-scope: READ /rest/api/3/worklog/list: post: deprecated: false description: 'Returns worklog details for a list of worklog IDs. The returned list of worklogs is limited to 1000 items. **Permissions required:** Permission to access Jira, however, worklogs are only returned where either of the following is true: * the worklog is set as *Viewable by All Users*. * the user is a member of a project role or group with permission to view the worklog.' operationId: getWorklogsForIds parameters: - description: Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties` that returns the properties of each worklog. in: query name: expand schema: default: '' type: string requestBody: content: application/json: example: ids: - 1 - 2 - 5 - 10 schema: $ref: '#/components/schemas/WorklogIdsRequestBean' description: A JSON object containing a list of worklog IDs. required: true responses: '200': content: application/json: example: '[{"author":{"accountId":"5b10a2844c20165700ede21g","active":false,"displayName":"Mia Krystof","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"comment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"I did some work here."}]}]},"id":"100028","issueId":"10002","self":"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000","started":"2021-01-17T12:34:00.000+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"updateAuthor":{"accountId":"5b10a2844c20165700ede21g","active":false,"displayName":"Mia Krystof","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"},"updated":"2021-01-18T23:45:00.000+0000","visibility":{"identifier":"276f955c-63d7-42c8-9520-92d01dca0625","type":"group","value":"jira-developers"}}]' schema: items: $ref: '#/components/schemas/Worklog' type: array description: Returned if the request is successful. '400': description: Returned if the request contains more than 1000 worklog IDs or is empty. '401': description: Returned if the authentication credentials are incorrect or missing. security: - basicAuth: [] - OAuth2: - read:jira-work summary: Get worklogs tags: - Issue Worklogs x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - read:jira-work state: Current - scheme: OAuth2 scopes: - read:comment:jira - read:group:jira - read:issue-worklog:jira - read:issue-worklog.property:jira - read:project-role:jira - read:user:jira - read:avatar:jira state: Beta x-atlassian-connect-scope: READ /rest/api/3/worklog/updated: get: deprecated: false description: 'Returns a list of IDs and update timestamps for worklogs updated after a date and time. This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, `until` indicates the timestamp of the youngest item on the page. Also, `nextPage` provides the URL for the next page of worklogs. The `lastPage` parameter is set to true on the last page of worklogs. This resource does not return worklogs updated during the minute preceding the request. **Permissions required:** Permission to access Jira, however, worklogs are only returned where either of the following is true: * the worklog is set as *Viewable by All Users*. * the user is a member of a project role or group with permission to view the worklog.' operationId: getIdsOfWorklogsModifiedSince parameters: - description: The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned. in: query name: since schema: default: 0 format: int64 type: integer - description: Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties` that returns the properties of each worklog. in: query name: expand schema: default: '' type: string responses: '200': content: application/json: example: '{"lastPage":true,"nextPage":"https://your-domain.atlassian.net/api/~ver~/worklog/updated?since=1438013693136","self":"https://your-domain.atlassian.net/api/~ver~/worklog/updated?since=1438013671562","since":1438013671562,"until":1438013693136,"values":[{"properties":[],"updatedTime":1438013671562,"worklogId":103},{"properties":[],"updatedTime":1438013672165,"worklogId":104},{"properties":[],"updatedTime":1438013693136,"worklogId":105}]}' schema: $ref: '#/components/schemas/ChangedWorklogs' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. security: - basicAuth: [] - OAuth2: - read:jira-work summary: Get IDs of updated worklogs tags: - Issue Worklogs x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - read:jira-work state: Current - scheme: OAuth2 scopes: - read:issue-worklog:jira - read:issue-worklog.property:jira state: Beta x-atlassian-connect-scope: READ components: schemas: EntityProperty: additionalProperties: false description: An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/). properties: key: description: The key of the property. Required on create and update. type: string value: description: The value of the property. Required on create and update. type: object UserDetails: additionalProperties: false description: "User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values." properties: accountId: description: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. maxLength: 128 type: string accountType: description: The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) readOnly: true type: string active: description: Whether the user is active. readOnly: true type: boolean avatarUrls: allOf: - $ref: '#/components/schemas/AvatarUrlsBean' description: The avatars of the user. readOnly: true displayName: description: The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. readOnly: true type: string emailAddress: description: The email address of the user. Depending on the user’s privacy settings, this may be returned as null. readOnly: true type: string key: description: This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. readOnly: true type: string name: description: This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. readOnly: true type: string self: description: The URL of the user. readOnly: true type: string timeZone: description: The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. readOnly: true type: string type: object Worklog: additionalProperties: true description: Details of a worklog. properties: author: allOf: - $ref: '#/components/schemas/UserDetails' description: Details of the user who created the worklog. readOnly: true comment: description: A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog. created: description: The datetime on which the worklog was created. format: date-time readOnly: true type: string id: description: The ID of the worklog record. readOnly: true type: string issueId: description: The ID of the issue this worklog is for. readOnly: true type: string properties: description: Details of properties for the worklog. Optional when creating or updating a worklog. items: $ref: '#/components/schemas/EntityProperty' type: array self: description: The URL of the worklog item. format: uri readOnly: true type: string started: description: The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog. format: date-time type: string timeSpent: description: The time spent working on the issue as days (\#d), hours (\#h), or minutes (\#m or \#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided. type: string timeSpentSeconds: description: The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided. format: int64 type: integer updateAuthor: allOf: - $ref: '#/components/schemas/UserDetails' description: Details of the user who last updated the worklog. readOnly: true updated: description: The datetime on which the worklog was last updated. format: date-time readOnly: true type: string visibility: allOf: - $ref: '#/components/schemas/Visibility' description: Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog. type: object xml: name: worklog PageOfWorklogs: additionalProperties: true description: Paginated list of worklog details properties: maxResults: description: The maximum number of results that could be on the page. format: int32 readOnly: true type: integer startAt: description: The index of the first item returned on the page. format: int32 readOnly: true type: integer total: description: The number of results on the page. format: int32 readOnly: true type: integer worklogs: description: List of worklogs. items: $ref: '#/components/schemas/Worklog' readOnly: true type: array type: object Visibility: additionalProperties: true description: The group or role to which this item is visible. properties: identifier: description: The ID of the group or the name of the role that visibility of this item is restricted to. type: - string - 'null' type: description: Whether visibility of this item is restricted to a group or role. enum: - group - role type: string value: description: The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use `identifier`. type: string type: object WorklogsMoveRequestBean: additionalProperties: false properties: ids: description: A list of worklog IDs. items: format: int64 type: integer type: array uniqueItems: true issueIdOrKey: description: The issue id or key of the destination issue type: string type: object ChangedWorklog: additionalProperties: false description: Details of a changed worklog. properties: properties: description: Details of properties associated with the change. items: $ref: '#/components/schemas/EntityProperty' readOnly: true type: array updatedTime: description: The datetime of the change. format: int64 readOnly: true type: integer worklogId: description: The ID of the worklog. format: int64 readOnly: true type: integer type: object AvatarUrlsBean: additionalProperties: false properties: 16x16: description: The URL of the item's 16x16 pixel avatar. format: uri type: string 24x24: description: The URL of the item's 24x24 pixel avatar. format: uri type: string 32x32: description: The URL of the item's 32x32 pixel avatar. format: uri type: string 48x48: description: The URL of the item's 48x48 pixel avatar. format: uri type: string type: object ChangedWorklogs: additionalProperties: false description: List of changed worklogs. properties: lastPage: type: boolean nextPage: description: The URL of the next list of changed worklogs. format: uri readOnly: true type: string self: description: The URL of this changed worklogs list. format: uri readOnly: true type: string since: description: The datetime of the first worklog item in the list. format: int64 readOnly: true type: integer until: description: The datetime of the last worklog item in the list. format: int64 readOnly: true type: integer values: description: Changed worklog list. items: $ref: '#/components/schemas/ChangedWorklog' readOnly: true type: array type: object WorklogIdsRequestBean: additionalProperties: false properties: ids: description: A list of worklog IDs. items: format: int64 type: integer type: array uniqueItems: true required: - ids type: object securitySchemes: OAuth2: description: OAuth2 scopes for Jira flows: authorizationCode: authorizationUrl: https://auth.atlassian.com/authorize scopes: delete:async-task:jira: Delete asynchronous task. delete:attachment:jira: Delete issue attachments. delete:avatar:jira: Delete system and custom avatars. delete:comment.property:jira: Delete issue comment properties. delete:comment:jira: Delete issue comments. delete:dashboard.property:jira: Delete dashboard properties. delete:dashboard:jira: Delete dashboards. delete:field-configuration-scheme:jira: Delete field configuration schemes. delete:field-configuration:jira: Delete field configurations. delete:field.option:jira: Delete field options. delete:field:jira: Delete fields. delete:filter.column:jira: Delete filter columns. delete:filter:jira: Delete filters. delete:group:jira: Delete user groups. delete:issue-link-type:jira: Delete issue link types. delete:issue-link:jira: Delete issue links. delete:issue-type-scheme:jira: Delete issue type schemes. delete:issue-type-screen-scheme:jira: Delete issue type screen schemes. delete:issue-type.property:jira: Delete issue type properties. delete:issue-type:jira: Delete issue types. delete:issue-worklog.property:jira: Delete issue worklog properties. delete:issue-worklog:jira: Delete issue worklogs. delete:issue.property:jira: Delete issue properties. delete:issue.remote-link:jira: Delete issue remote links. delete:issue:jira: Delete issues. delete:permission-scheme:jira: Delete permission schemes. delete:permission:jira: Delete permissions. delete:project-category:jira: Delete project categories. delete:project-role:jira: Delete project roles. delete:project-version:jira: Delete project versions. delete:project.avatar:jira: Delete project avatars. delete:project.component:jira: Delete project components. delete:project.property:jira: Delete project properties. delete:project:jira: Delete projects and their details, such as issue types, project lead, and avatars. delete:screen-scheme:jira: Delete screen schemes. delete:screen-tab:jira: Delete screen tabs. delete:screen:jira: Delete screens. delete:screenable-field:jira: Delete screenable fields. delete:user-configuration:jira: Delete user configurations. delete:user.property:jira: Delete user properties. delete:webhook:jira: Delete webhooks. delete:workflow-scheme:jira: Delete workflow schemes. delete:workflow.property:jira: Delete workflow properties. delete:workflow:jira: Delete workflows. manage:jira-configuration: Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types. manage:jira-project: Create and edit project settings and create new project-level objects, for example, versions, components. manage:jira-webhook: Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks. read:app-data:jira: Read app data. read:application-role:jira: View application roles. read:attachment:jira: View issue attachments. read:audit-log:jira: View audit logs. read:avatar:jira: View system and custom avatars. read:comment.property:jira: View issue comment properties. read:comment:jira: View issue comments. read:custom-field-contextual-configuration:jira: Read custom field contextual configurations. read:dashboard.property:jira: View dashboard properties. read:dashboard:jira: View dashboards. read:email-address:jira: View email addresses of all users regardless of the user's profile visibility settings. read:field-configuration-scheme:jira: View field configuration schemes. read:field-configuration:jira: Read field configurations. read:field.default-value:jira: View field default values. read:field.option:jira: View field options. read:field.options:jira: Read field options. read:field:jira: View fields. read:filter.column:jira: View filter columns. read:filter.default-share-scope:jira: View filter default share scopes. read:filter:jira: View filters. read:group:jira: View user groups. read:instance-configuration:jira: View instance configurations. read:issue-details:jira: View issue details. read:issue-event:jira: Read issue events. read:issue-field-values:jira: View issue field valueses. read:issue-link-type:jira: View issue link types. read:issue-link:jira: View issue links. read:issue-meta:jira: View issue meta. read:issue-security-level:jira: View issue security levels. read:issue-security-scheme:jira: View issue security schemes. read:issue-status:jira: View issue statuses. read:issue-type-hierarchy:jira: Read issue type hierarchies. read:issue-type-scheme:jira: View issue type schemes. read:issue-type-screen-scheme:jira: View issue type screen schemes. read:issue-type.property:jira: View issue type properties. read:issue-type:jira: View issue types. read:issue-worklog.property:jira: View issue worklog properties. read:issue-worklog:jira: View issue worklogs. read:issue.changelog:jira: View issue changelogs. read:issue.property:jira: View issue properties. read:issue.remote-link:jira: View issue remote links. read:issue.time-tracking:jira: View issue time trackings. read:issue.transition:jira: View issue transitions. read:issue.vote:jira: View issue votes. read:issue.votes:jira: View issue voteses. read:issue.watcher:jira: View issue watchers. read:issue:jira: View issues. read:jira-expressions:jira: View jira expressions. read:jira-user: View user information in Jira that you have access to, including usernames, email addresses, and avatars. read:jira-work: Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs). read:jql:jira: View JQL. read:label:jira: View labels. read:license:jira: View licenses. read:notification-scheme:jira: View notification schemes. read:permission-scheme:jira: View permission schemes. read:permission:jira: View permissions. read:priority:jira: View priorities. read:project-category:jira: View project categories. read:project-role:jira: View project roles. read:project-type:jira: View project types. read:project-version:jira: View project versions. read:project.avatar:jira: Read project avatars. read:project.component:jira: View project components. read:project.email:jira: View project emails. read:project.feature:jira: Read project features. read:project.property:jira: View project properties. read:project:jira: View projects. read:resolution:jira: View resolutions. read:role:jira: View roles. read:screen-field:jira: View screen fields. read:screen-scheme:jira: View screen schemes. read:screen-tab:jira: View screen tabs. read:screen:jira: View screens. read:screenable-field:jira: View screenable fields. read:status:jira: View statuses. read:user-configuration:jira: View user configurations. read:user.columns:jira: View user columnses. read:user.property:jira: View user properties. read:user:jira: View users. read:webhook:jira: View webhooks. read:workflow-scheme:jira: View workflow schemes. read:workflow.property:jira: View workflow properties. read:workflow:jira: View workflows. send:notification:jira: Send notifications. validate:jql:jira: Validate JQL. write:app-data:jira: Write app data. write:attachment:jira: Create and update issue attachments. write:avatar:jira: Create and update system and custom avatars. write:comment.property:jira: Create and update issue comment properties. write:comment:jira: Create and update issue comments. write:custom-field-contextual-configuration:jira: Save custom field contextual configurations. write:dashboard.property:jira: Create and update dashboard properties. write:dashboard:jira: Create and update dashboards. write:field-configuration-scheme:jira: Create and update field configuration schemes. write:field-configuration:jira: Save field configurations. write:field.default-value:jira: Create and update field default values. write:field.option:jira: Create and update field options. write:field:jira: Create and update fields. write:filter.column:jira: Create and update filter columns. write:filter.default-share-scope:jira: Create and update filter default share scopes. write:filter:jira: Create and update filters. write:group:jira: Create and update user groups. write:instance-configuration:jira: Create and update instance configurations. write:issue-link-type:jira: Create and update issue link types. write:issue-link:jira: Create and update issue links. write:issue-type-scheme:jira: Create and update issue type schemes. write:issue-type-screen-scheme:jira: Create and update issue type screen schemes. write:issue-type.property:jira: Create and update issue type properties. write:issue-type:jira: Create and update issue types. write:issue-worklog.property:jira: Create and update issue worklog properties. write:issue-worklog:jira: Create and update issue worklogs. write:issue.property:jira: Create and update issue properties. write:issue.remote-link:jira: Create and update issue remote links. write:issue.time-tracking:jira: Create and update issue time trackings. write:issue.vote:jira: Create and update issue votes. write:issue.watcher:jira: Create and update issue watchers. write:issue:jira: Create and update issues. write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues. write:permission-scheme:jira: Create and update permission schemes. write:permission:jira: Create and update permissions. write:project-category:jira: Create and update project categories. write:project-role:jira: Create and update project roles. write:project-version:jira: Create and update project versions. write:project.avatar:jira: Create and update project avatars. write:project.component:jira: Create and update project components. write:project.email:jira: Create and update project emails. write:project.feature:jira: Save project features. write:project.property:jira: Create and update project properties. write:project:jira: Create and update projects. write:screen-scheme:jira: Create and update screen schemes. write:screen-tab:jira: Create and update screen tabs. write:screen:jira: Create and update screens. write:screenable-field:jira: Create and update screenable fields. write:user-configuration:jira: Create and update user configurations. write:user.property:jira: Create and update user properties. write:webhook:jira: Create and update webhooks. write:workflow-scheme:jira: Create and update workflow schemes. write:workflow.property:jira: Create and update workflow properties. write:workflow:jira: Create and update workflows. tokenUrl: https://auth.atlassian.com/oauth/token type: oauth2 basicAuth: description: You can access this resource via basic auth. scheme: basic type: http externalDocs: description: Find out more about Atlassian products and services. url: http://www.atlassian.com x-atlassian-narrative: documents: - anchor: about body: "The Jira REST API enables you to interact with Jira programmatically. Use this API to \n[build apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/), script interactions with \nJira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including \nthe HTTP response codes and example requests and responses." title: About - anchor: version body: "This documentation is for **version 3** of the Jira Cloud platform REST API, which is the latest\nversion. [Version 2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) and\nversion 3 of the API offer the same collection of operations. However, version 3 provides support for\nthe [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)\n(ADF) in:\n- `body` in comments, including where comments are used in issue, issue link, and transition resources.\n- `comment` in worklogs.\n- `description` and `environment` fields in issues.\n- `textarea` type custom fields (multi-line text fields) in issues. Single line custom fields\n (`textfield`) accept a string and don't handle Atlassian Document Format content.\n" title: Version - anchor: authentication body: "### Forge apps\n\nFor Forge apps, [REST API scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/) \nare used when authenticating with Jira Cloud platform. See [Add scopes to call an Atlassian REST API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/) for more details.\n\nThe URIs for Forge app REST API calls have this structure:\n\n`/rest/api/3/`\n\nFor example, `/rest/api/3/issue/DEMO-1`\n\n### Connect apps\n\nFor Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either \nscopes (shown as _App scope required_ for operations on this page) or user impersonation. See \n[Security for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/) \nfor details.\n\nThe URIs for Connect app REST API calls have this structure:\n\n`https:///rest/api/3/`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n\n### Other integrations\n\nFor integrations that are not Forge or Connect apps, use OAuth 2.0 authorization code grants (3LO) for security \n(3LO scopes are shown as for operations _OAuth scopes required_). See \n[OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) \nfor details.\n\nThe URIs for OAuth 2.0 (3LO) app REST API calls have this structure:\n\n`https://api.atlassian.com/ex/jira//rest/api/3/`\n\nFor example, `https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/api/3/issue/DEMO-1`\n\n### Ad-hoc API calls\n\nFor personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. See [Basic auth for REST APIs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/) for details. \n\nThe URIs for basic authentication REST API calls have this structure:\n\n`https:///rest/api/3/`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n" title: Authentication and authorization - anchor: permissions body: "### Operation permissions\n\nMost operations in this API require permissions. The calling user must have the required permissions for an operation to \nuse it. Note that for Connect apps, the app user must have the required permissions for the operation and the app must \nhave scopes that permit the operation.\n\nA permission can be granted to a group, project role, or issue role that the user is a member of, or granted directly to a user. \nSee [Permissions overview](https://confluence.atlassian.com/x/FQiiLQ) for details. The most common permissions are:\n\n- **Administer the Cloud site**: Users in the _site-admins_ group have this \npermission. See [Manage groups](https://confluence.atlassian.com/x/24xjL) for details.\n- **Administer Jira**: Granted by the _Jira Administrators_ global permission. There is a default group for this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and [Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n- **Administer a project in Jira**: Granted by the _Administer projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access a project in Jira**: Granted by the _Browse projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access Jira**: Granted by the _Jira Users_ global permission. Users in the default product access group (for example, \n_jira-software-users-acmesite_) have this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and \n[Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n\n### Anonymous access\n\nSome operations provide support for anonymous access. However, anonymous access is only available if \nthe Jira permission needed to access the object or records returned by the operation is granted to \nthe _Public_ group. See [Allowing anonymous access to your project](https://confluence.atlassian.com/x/GDxxLg) \nfor details.\n\nIf an operation is called anonymously and anonymous access is not available, the operation will return \nan error. Note that not all operations that correspond to objects that can be given public access \nprovide for anonymous access.\n" title: Permissions - anchor: expansion body: "### Expansion\n\nThe Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified \nin the request. This simplifies responses and minimizes network traffic.\n\nTo expand part of a resource in a request, use the expand query parameter and specify the object(s) to be expanded. \nIf you need to expand nested objects, use the `.` dot notation. If you need to expand multiple objects, use a \ncomma-separated list. \n\nFor example, the following request expands the `names` and `renderedFields` properties for the _JRACLOUD-34423_ issue:\n\n`GET issue/JRACLOUD-34423?expand=names,renderedFields`\n\nTo discover which object can be expanded, refer to the `expand` property in the object. \nIn the JSON example below, the resource declares `widgets` as expandable.\n\n```json\n{\n \"expand\": \"widgets\", \n \"self\": \"https://your-domain.atlassian.net/rest/api/3/resource/KEY-1\", \n \"widgets\": {\n \"widgets\": [],\n \"size\": 5\n }\n}\n```\n\n### Pagination\n\nThe Jira REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large \ncollection of items. When you make a request to a paginated resource, the response wraps the returned array of values in \na JSON object with paging metadata. For example:\n\n```json\n{\n \"startAt\" : 0,\n \"maxResults\" : 10,\n \"total\": 200,\n \"isLast\": false,\n \"values\": [\n { /* result 0 */ },\n { /* result 1 */ },\n { /* result 2 */ }\n ]\n}\n```\n\n* `startAt` is the index of the first item returned in the page.\n* `maxResults` is the maximum number of items that a page can return. Each operation can have a different limit for\n the number of items returned, and these limits may change without notice. To find the maximum number of items \n that an operation could return, set `maxResults` to a large number—for example, over 1000—and if the returned value of `maxResults` is less than the requested value, the returned value is the maximum.\n* `total` is the total number of items contained in all pages. This number **_may change_** as the client \nrequests the subsequent pages, therefore the client should always assume that the requested page can be empty. Note \nthat this property is not returned for all operations.\n* `isLast` indicates whether the page returned is the last one. Note that this property is not returned for all operations.\n\n### Ordering\n\nSome operations support ordering the elements of a response by a field. Check the documentation for the operation to \nconfirm whether ordering of a response is supported and which fields can be used. Responses are listed in ascending order \nby default. You can change the order using the `orderby` query parameter with a `-` or `+` symbol. For example:\n\n* `?orderBy=name` to order by `name` field ascending.\n* `?orderBy=+name` to order by `name` field ascending.\n* `?orderBy=-name` to order by `name` field descending.\n\n\n" title: Expansion, pagination, and ordering - anchor: timestamps body: 'By default, top-level timestamps (e.g. updated and created) are returned in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, in the system default user time zone. To return date time data in the logged in user''s timezone, please refer to `renderedFields` property under the `expand` query parameter in relevant APIs. ' title: Timestamps - anchor: special-request-headers body: 'The following request and response headers define important metadata for the Jira Cloud REST API resources. - `X-Atlassian-Token` (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check` header in requests. Otherwise the request is blocked by cross-site request forgery (CSRF/XSRF) protection. - `X-Force-Accept-Language` (request): controls how the standard HTTP `Accept-Language` header is processed. By default `Accept-Language` is ignored and the response is in the language configured in the user''s profile or, when no language is configured for the user, the default Jira instance language. For the response to recognize `Accept-Language` send `X-Force-Accept-Language = true` as well. If `Accept-Language` requests a language that Jira can return the response is in that language, otherwise Jira returns the response in the default language. If `Accept-Language` is not specified the response is in the default language. - `X-AAccountId` (response): This response header contains the Atlassian account ID of the authenticated user.' title: Special headers - anchor: anonymous-operations body: " Jira provides for all permissions, except the [global permission](https://confluence.atlassian.com/x/x4dKLg) Administer Jira, to be assigned to *Anyone*. Once a permission is assigned to *Anyone*, anyone knowing a project's URL is able to use the features in Jira enabled by the permission. However, the Jira REST API does not enable anonymous access for operations by default. This means that an anonymous user who may be able to perform an action through Jira, may not be able to perform the same action where it's enabled by the REST API. \n\n The operations that provide anonymous access are annotated \"This operation can be accessed anonymously.\"" title: Anonymous operations - anchor: async-operations body: "Some Jira REST API operations may trigger long-running or computationally expensive tasks. In these cases, the operation \nwill schedule an asynchronous task and return a `303 (See Other)` response, indicating the location of the queued task \nin the `Location` header. You can query this task to get progress updates.\n\nWhen the task finishes, the response object will contain the `result` field. The content of the field is specific to the \noperation that created the task. Refer to the operation’s documentation for more information.\n\nNote that asynchronous tasks are not guaranteed to be run in order. In other words, if you need your tasks to execute \nin a certain order, you should start a task only after the prerequisite task(s) have finished." title: Asynchronous operations - anchor: experimental body: "Features and methods marked as experimental may change without notice. Feedback on experimental functionality is welcome. \nReport issues to [Developer and Marketplace support](https://developer.atlassian.com/support) (preferred) or use the \n**Give docs feedback** link at the top of this page. \n" title: Experimental features - anchor: status-codes body: "The Jira Cloud platform REST API uses the [standard HTTP status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).\n\nOperations that return an error status code may also return a response body containing details of the error or errors. \nThe schema for the response body is shown below:\n\n\n```json\n{\n \"id\": \"https://docs.atlassian.com/jira/REST/schema/error-collection#\",\n \"title\": \"Error Collection\",\n \"type\": \"object\",\n \"properties\": {\n \"errorMessages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"errors\": {\n \"type\": \"object\",\n \"patternProperties\": {\n \".+\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n },\n \"status\": { \n \"type\": \"integer\"\n }\n },\n \"additionalProperties\": false\n}\n```" title: Status codes