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 fields API version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df servers: - url: https://your-domain.atlassian.net tags: - description: This resource represents issue fields, both system and custom fields. Use it to get fields, field configurations, and create custom fields. name: Issue Fields paths: /rest/api/3/field: get: deprecated: false description: 'Returns system and custom issue fields according to the following rules: * Fields that cannot be added to the issue navigator are always returned. * Fields that cannot be placed on an issue screen are always returned. * Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches. * Fields that are not associated to any used field configurations or screens are not returned. * For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has *Browse Projects* project permission for.) This operation can be accessed anonymously. **Permissions required:** None.' operationId: getFields parameters: [] responses: '200': content: application/json: example: '[{"clauseNames":["description"],"custom":false,"id":"description","name":"Description","navigable":true,"orderable":true,"schema":{"system":"description","type":"string"},"searchable":true},{"clauseNames":["summary"],"custom":false,"id":"summary","key":"summary","name":"Summary","navigable":true,"orderable":true,"schema":{"system":"summary","type":"string"},"searchable":true}]' schema: items: $ref: '#/components/schemas/FieldDetails' type: array 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 fields tags: - Issue Fields 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:field:jira - read:avatar:jira - read:project-category:jira - read:project:jira - read:field-configuration:jira state: Beta x-atlassian-connect-scope: READ post: deprecated: false description: 'Creates a custom field. **Permissions required:** *Administer Jira* global permission.' operationId: createCustomField parameters: [] requestBody: content: application/json: example: description: Custom field for picking groups name: New custom field searcherKey: com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher type: com.atlassian.jira.plugin.system.customfieldtypes:grouppicker schema: $ref: '#/components/schemas/CustomFieldDefinitionJsonBean' description: Definition of the custom field to be created required: true responses: '201': content: application/json: example: '{"clauseNames":["cf[10101]","New custom field"],"custom":true,"id":"customfield_10101","key":"customfield_10101","name":"New custom field","navigable":true,"orderable":true,"schema":{"custom":"com.atlassian.jira.plugin.system.customfieldtypes:project","customId":10101,"type":"project"},"searchable":true,"untranslatedName":"New custom field"}' schema: $ref: '#/components/schemas/FieldDetails' description: Returned if the custom field is created. '400': description: "Returned if:\n\n * the user does not have permission to create custom fields.\n * any of the request object properties have invalid or missing values." security: - basicAuth: [] - OAuth2: - manage:jira-configuration - {} summary: Create custom field tags: - Issue Fields x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field:jira - read:avatar:jira - read:field:jira - read:project-category:jira - read:project:jira - read:field-configuration:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/field/search: get: deprecated: false description: 'Returns a paginated list of fields for Classic Jira projects. The list can include: * all fields * specific fields, by defining `id` * fields that contain a string in the field name or description, by defining `query` * specific fields that contain a string in the field name or description, by defining `id` and `query` Use `type` must be set to `custom` to show custom fields only. **Permissions required:** Permission to access Jira.' operationId: getFieldsPaginated parameters: - 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: 50 format: int32 type: integer - description: The type of fields to search. in: query name: type schema: items: default: '' enum: - custom - system type: string type: array - description: The IDs of the custom fields to return or, where `query` is specified, filter. in: query name: id schema: items: default: '' type: string type: array uniqueItems: true - description: String used to perform a case-insensitive partial match with field names or descriptions. in: query name: query schema: type: string - description: "[Order](#ordering) the results by:\n\n * `contextsCount` sorts by the number of contexts related to a field\n * `lastUsed` sorts by the date when the value of the field last changed\n * `name` sorts by the field name\n * `screensCount` sorts by the number of screens related to a field" in: query name: orderBy schema: enum: - contextsCount - -contextsCount - +contextsCount - lastUsed - -lastUsed - +lastUsed - name - -name - +name - screensCount - -screensCount - +screensCount - projectsCount - -projectsCount - +projectsCount type: string - description: "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `key` returns the key for each field\n * `stableId` returns the stableId for each field\n * `lastUsed` returns the date when the value of the field last changed\n * `screensCount` returns the number of screens related to a field\n * `contextsCount` returns the number of contexts related to a field\n * `isLocked` returns information about whether the field is locked\n * `searcherKey` returns the searcher key for each custom field" in: query name: expand schema: type: string - description: The IDs of the projects to filter the fields by. Fields belonging to project Ids that the user does not have access to will not be returned in: query name: projectIds schema: items: format: int64 type: integer type: array uniqueItems: true responses: '200': content: application/json: example: '{"isLast":false,"maxResults":50,"startAt":0,"total":2,"values":[{"id":"customfield_10000","name":"Approvers","schema":{"custom":"com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker","customId":10000,"items":"user","type":"array"},"description":"Contains users needed for approval. This custom field was created by Jira Service Desk.","key":"customfield_10000","stableId":"sfid:approvers","isLocked":true,"searcherKey":"com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher","screensCount":2,"contextsCount":2,"lastUsed":{"type":"TRACKED","value":"2021-01-28T07:37:40.000+0000"}},{"id":"customfield_10001","name":"Change reason","schema":{"custom":"com.atlassian.jira.plugin.system.customfieldtypes:select","customId":10001,"type":"option"},"description":"Choose the reason for the change request","key":"customfield_10001","stableId":"sfid:change-reason","isLocked":false,"searcherKey":"com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher","screensCount":2,"contextsCount":2,"projectsCount":2,"lastUsed":{"type":"NOT_TRACKED"}}]}' schema: $ref: '#/components/schemas/PageBeanField' description: Returned if the request is successful. '400': content: application/json: example: '{"errorMessages":["Only custom fields can be queried."],"errors":{}}' schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the request is invalid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access fields."],"errors":{}}' schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user does not have the necessary permission. security: - basicAuth: [] - OAuth2: - read:jira-work summary: Get fields paginated tags: - Issue Fields 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:field:jira - read:field-configuration:jira state: Beta x-atlassian-connect-scope: NONE /rest/api/3/field/search/trashed: get: deprecated: false description: 'Returns a paginated list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string. Only custom fields can be queried, `type` must be set to `custom`. **Permissions required:** *Administer Jira* global permission.' operationId: getTrashedFieldsPaginated parameters: - 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: 50 format: int32 type: integer - in: query name: id schema: items: default: '' type: string type: array uniqueItems: true - description: String used to perform a case-insensitive partial match with field names or descriptions. in: query name: query schema: type: string - in: query name: expand schema: enum: - name - -name - +name - trashDate - -trashDate - +trashDate - plannedDeletionDate - -plannedDeletionDate - +plannedDeletionDate - projectsCount - -projectsCount - +projectsCount type: string - description: "[Order](#ordering) the results by a field:\n\n * `name` sorts by the field name\n * `trashDate` sorts by the date the field was moved to the trash\n * `plannedDeletionDate` sorts by the planned deletion date" in: query name: orderBy schema: type: string responses: '200': content: application/json: example: '{"isLast":false,"maxResults":50,"startAt":0,"total":1,"values":[{"id":"customfield_10000","name":"Approvers","schema":{"custom":"com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker","customId":10003,"type":"array"},"description":"Contains users needed for approval. This custom field was created by Jira Service Desk.","key":"customfield_10003","trashedDate":"2022-10-06T07:32:47.000+0000","trashedBy":{"accountId":"5b10a2844c20165700ede21g","active":true,"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia Krystof","emailAddress":"mia@example.com","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","timeZone":"Australia/Sydney"},"plannedDeletionDate":"2022-10-24T07:32:47.000+0000"}]}' schema: $ref: '#/components/schemas/PageBeanField' description: Returned if the request is successful. '400': content: application/json: example: '{"errorMessages":["Only custom fields can be queried."],"errors":{}}' schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the request is invalid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access fields."],"errors":{}}' schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user does not have the necessary permission. security: - basicAuth: [] - OAuth2: - read:jira-work summary: Get fields in trash paginated tags: - Issue Fields 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:field:jira - read:field-configuration:jira - read:user:jira state: Beta x-atlassian-connect-scope: READ /rest/api/3/field/{fieldId}: put: deprecated: false description: 'Updates a custom field. **Permissions required:** *Administer Jira* global permission.' operationId: updateCustomField parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string requestBody: content: application/json: example: description: Select the manager and the corresponding employee. name: Managers and employees list searcherKey: com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher schema: $ref: '#/components/schemas/UpdateCustomFieldDetails' description: The custom field update details. required: true responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': content: application/json: example: '{"errorMessages":["searcherKey is invalid for the field type."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can edit custom fields."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The custom field was not found."],"errors":{}}' description: Returned if the custom field is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Update custom field tags: - Issue Fields x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/field/{fieldId}/association/project: get: deprecated: false description: 'Returns a paginated list of project associations for the given custom field. Each association contains the ID of a project the field is associated with. **Permissions required:** *Administer Jira* global permission.' operationId: getFieldProjectAssociations parameters: - description: The ID of the field, for example `customfield_10000`. in: path name: fieldId 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: 50 format: int32 type: integer responses: '200': content: application/json: example: '{"isLast":false,"maxResults":50,"startAt":0,"total":2,"values":[{"projectId":"10010"},{"projectId":"10020"}]}' schema: $ref: '#/components/schemas/PageBeanFieldProjectAssociation' description: Returned if the request is successful. '400': description: Returned if the request is invalid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. security: - basicAuth: [] - OAuth2: - read:jira-work summary: Get field project associations tags: - Issue Fields 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:field:jira - read:field-configuration:jira state: Beta x-experimental: true x-atlassian-connect-scope: READ /rest/api/3/field/{fieldId}/contexts: get: deprecated: true description: 'Returns a paginated list of the contexts a field is used in. Deprecated, use Get custom field contexts. **Permissions required:** *Administer Jira* global permission.' operationId: getContextsForFieldDeprecated parameters: - description: The ID of the field to return contexts for. in: path name: fieldId 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: 20 format: int32 type: integer responses: '200': content: application/json: example: '{"isLast":false,"maxResults":1,"startAt":0,"total":5,"values":[{"id":10001,"name":"Default Context"}]}' schema: $ref: '#/components/schemas/PageBeanContext' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. security: - basicAuth: [] - OAuth2: - manage:jira-project - {} summary: Get contexts for a field tags: - Issue Fields x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-project state: Current - scheme: OAuth2 scopes: - read:field:jira - read:avatar:jira - read:project-category:jira - read:project:jira state: Beta x-atlassian-connect-scope: NONE /rest/api/3/field/{id}: delete: deprecated: false description: 'Deletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom field for more information on trashing and deleting custom fields. This operation is asynchronous. Follow the `location` link in the response to determine the status of the task and use Get task to obtain subsequent updates. **Permissions required:** *Administer Jira* global permission.' operationId: deleteCustomField parameters: - description: The ID of a custom field. in: path name: id required: true schema: type: string responses: '303': content: application/json: schema: $ref: '#/components/schemas/TaskProgressBeanObject' description: Returned if the request is successful. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: "Returned if any of these are true:\n\n * The custom field is locked.\n * The custom field is used in a issue security scheme or a permission scheme.\n * The custom field ID format is incorrect." '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user does not have the necessary permission. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the custom field is not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if a task to delete the custom field is running. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Delete custom field tags: - Issue Fields x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - delete:field:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/field/{id}/restore: post: deprecated: false description: 'Restores a custom field from trash. See Edit or delete a custom field for more information on trashing and deleting custom fields. **Permissions required:** *Administer Jira* global permission.' operationId: restoreCustomField parameters: - description: The ID of a custom field. in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: {} description: Returned if the request is successful. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the request is invalid. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user does not have the necessary permission. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the custom field is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Restore custom field from trash tags: - Issue Fields x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/field/{id}/trash: post: deprecated: false description: 'Moves a custom field to trash. See Edit or delete a custom field for more information on trashing and deleting custom fields. **Permissions required:** *Administer Jira* global permission.' operationId: trashCustomField parameters: - description: The ID of a custom field. in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: {} description: Returned if the request is successful. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the request is invalid. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the user does not have the necessary permission. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorCollection' description: Returned if the custom field is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Move custom field to trash tags: - Issue Fields x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - delete:field:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/projects/fields: get: deprecated: false description: 'Returns a paginated list of fields for the requested projects and work types. Only fields that are available for the specified combination of projects and work types are returned. This endpoint allows filtering to specific fields if field IDs are provided. **Permissions required:** Permission to access Jira.' operationId: getProjectFields parameters: - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 description: The index of the first item to return in a page of results (page offset). format: int64 minimum: 0 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 description: The maximum number of items to return per page. format: int32 maximum: 100 minimum: 1 type: integer - description: The IDs of projects to return fields for. in: query name: projectId required: true schema: description: The IDs of projects to return fields for. example: - 10000 - 10001 items: description: The IDs of projects to return fields for. format: int64 type: integer type: array - description: The IDs of work types (issue types) to return fields for. in: query name: workTypeId required: true schema: description: The IDs of work types (issue types) to return fields for. example: - 10000 - 10001 items: description: The IDs of work types (issue types) to return fields for. format: int64 type: integer type: array - description: The IDs of fields to return. If not provided, all fields are returned. in: query name: fieldId schema: description: The IDs of fields to return. If not provided, all fields are returned. example: - summary - description items: description: The IDs of fields to return. If not provided, all fields are returned. example: '["summary","description"]' type: string type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/PageBean2ProjectFieldBean' description: Returned if the request is successful. '400': description: Returned if the request parameters are invalid. '401': description: Returned if authentication is missing. '403': description: Returned if the user does not have permission to view the projects or work types. '404': description: Returned if the endpoint is not enabled via feature flag. security: - basicAuth: [] - OAuth2: - read:jira-work summary: Get fields for projects tags: - Issue Fields 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:field:jira - read:field-configuration:jira state: Beta x-experimental: true x-atlassian-connect-scope: INACCESSIBLE components: schemas: Scope: additionalProperties: true description: The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). properties: project: allOf: - $ref: '#/components/schemas/ProjectDetails' description: The project the item has scope in. readOnly: true type: description: The type of scope. enum: - PROJECT - TEMPLATE readOnly: true type: string type: object UpdateCustomFieldDetails: additionalProperties: false description: Details of a custom field. properties: description: description: The description of the custom field. The maximum length is 40000 characters. type: string name: description: The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters. type: string searcherKey: description: "The searcher that defines the way the field is searched in Jira. It can be set to `null`, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):\n\n * `cascadingselect`: `cascadingselectsearcher`\n * `datepicker`: `daterange`\n * `datetime`: `datetimerange`\n * `float`: `exactnumber` or `numberrange`\n * `grouppicker`: `grouppickersearcher`\n * `importid`: `exactnumber` or `numberrange`\n * `labels`: `labelsearcher`\n * `multicheckboxes`: `multiselectsearcher`\n * `multigrouppicker`: `multiselectsearcher`\n * `multiselect`: `multiselectsearcher`\n * `multiuserpicker`: `userpickergroupsearcher`\n * `multiversion`: `versionsearcher`\n * `project`: `projectsearcher`\n * `radiobuttons`: `multiselectsearcher`\n * `readonlyfield`: `textsearcher`\n * `select`: `multiselectsearcher`\n * `textarea`: `textsearcher`\n * `textfield`: `textsearcher`\n * `url`: `exacttextsearcher`\n * `userpicker`: `userpickergroupsearcher`\n * `version`: `versionsearcher`" enum: - com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher - com.atlassian.jira.plugin.system.customfieldtypes:daterange - com.atlassian.jira.plugin.system.customfieldtypes:datetimerange - com.atlassian.jira.plugin.system.customfieldtypes:exactnumber - com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher - com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher - com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher - com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher - com.atlassian.jira.plugin.system.customfieldtypes:numberrange - com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher - com.atlassian.jira.plugin.system.customfieldtypes:textsearcher - com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher - com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher type: string type: object writeOnly: true 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 FieldDetails: additionalProperties: false description: Details about a field. properties: clauseNames: description: The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ). items: type: string type: array uniqueItems: true custom: description: Whether the field is a custom field. type: boolean id: description: The ID of the field. type: string key: description: The key of the field. type: string name: description: The name of the field. type: string navigable: description: Whether the field can be used as a column on the issue navigator. type: boolean orderable: description: Whether the content of the field can be used to order lists. type: boolean schema: allOf: - $ref: '#/components/schemas/JsonTypeBean' description: The data schema for the field. scope: allOf: - $ref: '#/components/schemas/Scope' description: The scope of the field. searchable: description: Whether the content of the field can be searched. type: boolean type: object xml: name: field FieldProjectAssociation: additionalProperties: false description: List of project associations. properties: projectId: type: string type: object ErrorCollection: additionalProperties: false description: Error messages from an operation. properties: errorMessages: description: The list of error messages produced by this operation. For example, "input parameter 'key' must be provided" items: type: string type: array errors: additionalProperties: type: string description: 'The list of errors by parameter returned by the operation. For example,"projectKey": "Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters."' type: object status: format: int32 type: integer type: object ProjectFieldBean: additionalProperties: false properties: description: type: string fieldId: type: string isRequired: type: boolean projectId: format: int64 type: integer workTypeId: format: int64 type: integer type: object PageBeanField: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/Field' readOnly: true type: array type: object ProjectDetails: additionalProperties: false description: Details about a project. properties: avatarUrls: allOf: - $ref: '#/components/schemas/AvatarUrlsBean' description: The URLs of the project's avatars. readOnly: true id: description: The ID of the project. type: string key: description: The key of the project. readOnly: true type: string name: description: The name of the project. readOnly: true type: string projectCategory: allOf: - $ref: '#/components/schemas/UpdatedProjectCategory' description: The category the project belongs to. readOnly: true projectTypeKey: description: The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. enum: - software - service_desk - business - product_discovery readOnly: true type: string self: description: The URL of the project details. readOnly: true type: string simplified: description: Whether or not the project is simplified. readOnly: true type: boolean type: object PageBean2ProjectFieldBean: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/ProjectFieldBean' readOnly: true type: array type: object CustomFieldDefinitionJsonBean: additionalProperties: false properties: description: description: The description of the custom field, which is displayed in Jira. type: string name: description: The name of the custom field, which is displayed in Jira. This is not the unique identifier. type: string searcherKey: description: "The searcher defines the way the field is searched in Jira. For example, *com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher*. \nThe search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown):\n\n * `cascadingselect`: `cascadingselectsearcher`\n * `datepicker`: `daterange`\n * `datetime`: `datetimerange`\n * `float`: `exactnumber` or `numberrange`\n * `grouppicker`: `grouppickersearcher`\n * `importid`: `exactnumber` or `numberrange`\n * `labels`: `labelsearcher`\n * `multicheckboxes`: `multiselectsearcher`\n * `multigrouppicker`: `multiselectsearcher`\n * `multiselect`: `multiselectsearcher`\n * `multiuserpicker`: `userpickergroupsearcher`\n * `multiversion`: `versionsearcher`\n * `project`: `projectsearcher`\n * `radiobuttons`: `multiselectsearcher`\n * `readonlyfield`: `textsearcher`\n * `select`: `multiselectsearcher`\n * `textarea`: `textsearcher`\n * `textfield`: `textsearcher`\n * `url`: `exacttextsearcher`\n * `userpicker`: `userpickergroupsearcher`\n * `version`: `versionsearcher`\n\nIf no searcher is provided, the field isn't searchable. However, [Forge custom fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/#jira-custom-field-type--beta-) have a searcher set automatically, so are always searchable." enum: - com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher - com.atlassian.jira.plugin.system.customfieldtypes:daterange - com.atlassian.jira.plugin.system.customfieldtypes:datetimerange - com.atlassian.jira.plugin.system.customfieldtypes:exactnumber - com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher - com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher - com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher - com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher - com.atlassian.jira.plugin.system.customfieldtypes:numberrange - com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher - com.atlassian.jira.plugin.system.customfieldtypes:textsearcher - com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher - com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher type: string type: description: "The type of the custom field. These built-in custom field types are available:\n\n * `cascadingselect`: Enables values to be selected from two levels of select lists (value: `com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect`)\n * `datepicker`: Stores a date using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`)\n * `datetime`: Stores a date with a time component (value: `com.atlassian.jira.plugin.system.customfieldtypes:datetime`)\n * `float`: Stores and validates a numeric (floating point) input (value: `com.atlassian.jira.plugin.system.customfieldtypes:float`)\n * `grouppicker`: Stores a user group using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:grouppicker`)\n * `importid`: A read-only field that stores the ID the issue had in the system it was imported from (value: `com.atlassian.jira.plugin.system.customfieldtypes:importid`)\n * `labels`: Stores labels (value: `com.atlassian.jira.plugin.system.customfieldtypes:labels`)\n * `multicheckboxes`: Stores multiple values using checkboxes (value: ``)\n * `multigrouppicker`: Stores multiple user groups using a picker control (value: ``)\n * `multiselect`: Stores multiple values using a select list (value: `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes`)\n * `multiuserpicker`: Stores multiple users using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker`)\n * `multiversion`: Stores multiple versions from the versions available in a project using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:multiversion`)\n * `project`: Stores a project from a list of projects that the user is permitted to view (value: `com.atlassian.jira.plugin.system.customfieldtypes:project`)\n * `radiobuttons`: Stores a value using radio buttons (value: `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons`)\n * `readonlyfield`: Stores a read-only text value, which can only be populated via the API (value: `com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield`)\n * `select`: Stores a value from a configurable list of options (value: `com.atlassian.jira.plugin.system.customfieldtypes:select`)\n * `textarea`: Stores a long text string using a multiline text area (value: `com.atlassian.jira.plugin.system.customfieldtypes:textarea`)\n * `textfield`: Stores a text string using a single-line text box (value: `com.atlassian.jira.plugin.system.customfieldtypes:textfield`)\n * `url`: Stores a URL (value: `com.atlassian.jira.plugin.system.customfieldtypes:url`)\n * `userpicker`: Stores a user using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:userpicker`)\n * `version`: Stores a version using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:version`)\n\nTo create a field based on a [Forge custom field type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/#jira-custom-field-type--beta-), use the ID of the Forge custom field type as the value. For example, `ari:cloud:ecosystem::extension/e62f20a2-4b61-4dbe-bfb9-9a88b5e3ac84/548c5df1-24aa-4f7c-bbbb-3038d947cb05/static/my-cf-type-key`." type: string required: - name - type type: object PageBeanFieldProjectAssociation: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/FieldProjectAssociation' readOnly: true type: array type: object TaskProgressBeanObject: additionalProperties: false description: Details about a task. properties: description: description: The description of the task. type: string elapsedRuntime: description: The execution time of the task, in milliseconds. format: int64 type: integer finished: description: A timestamp recording when the task was finished. format: int64 type: integer id: description: The ID of the task. type: string lastUpdate: description: A timestamp recording when the task progress was last updated. format: int64 type: integer message: description: Information about the progress of the task. type: string progress: description: The progress of the task, as a percentage complete. format: int64 type: integer result: description: The result of the task execution. self: description: The URL of the task. format: uri type: string started: description: A timestamp recording when the task was started. format: int64 type: integer status: description: The status of the task. enum: - ENQUEUED - RUNNING - COMPLETE - FAILED - CANCEL_REQUESTED - CANCELLED - DEAD type: string submitted: description: A timestamp recording when the task was submitted. format: int64 type: integer submittedBy: description: The ID of the user who submitted the task. format: int64 type: integer required: - elapsedRuntime - id - lastUpdate - progress - self - status - submitted - submittedBy type: object UpdatedProjectCategory: additionalProperties: false description: A project category. properties: description: description: The name of the project category. readOnly: true type: string id: description: The ID of the project category. readOnly: true type: string name: description: The description of the project category. readOnly: true type: string self: description: The URL of the project category. readOnly: true type: string type: object PageBeanContext: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/Context' readOnly: true type: array type: object FieldLastUsed: additionalProperties: false description: Information about the most recent use of a field. properties: type: description: "Last used value type:\n\n * *TRACKED*: field is tracked and a last used date is available.\n * *NOT\\_TRACKED*: field is not tracked, last used date is not available.\n * *NO\\_INFORMATION*: field is tracked, but no last used date is available." enum: - TRACKED - NOT_TRACKED - NO_INFORMATION type: string value: description: The date when the value of the field last changed. format: date-time type: string type: object Context: additionalProperties: false description: A context. properties: id: description: The ID of the context. format: int64 readOnly: true type: integer name: description: The name of the context. readOnly: true type: string scope: allOf: - $ref: '#/components/schemas/Scope' description: The scope of the context. type: object Field: additionalProperties: false description: Details of a field. properties: contextsCount: description: Number of contexts where the field is used. format: int64 type: integer description: description: The description of the field. type: string id: description: The ID of the field. type: string isLocked: description: Whether the field is locked. type: boolean isUnscreenable: description: Whether the field is shown on screen or not. type: boolean key: description: The key of the field. type: string lastUsed: $ref: '#/components/schemas/FieldLastUsed' name: description: The name of the field. type: string projectsCount: description: Number of projects where the field is used. format: int64 type: integer schema: $ref: '#/components/schemas/JsonTypeBean' screensCount: description: Number of screens where the field is used. format: int64 type: integer searcherKey: description: The searcher key of the field. Returned for custom fields. type: string stableId: description: The stable ID of the field. type: string translatedDescription: description: The translated (i18n) description of the field for the current locale. Returned for custom fields. type: string translatedName: description: The translated (i18n) name of the field for the current locale. Returned for custom fields. type: string typeDisplayName: description: The display name of the field type type: string required: - id - name - schema type: object JsonTypeBean: additionalProperties: false description: The schema of a field. properties: configuration: additionalProperties: readOnly: true description: If the field is a custom field, the configuration of the field. readOnly: true type: object custom: description: If the field is a custom field, the URI of the field. readOnly: true type: string customId: description: If the field is a custom field, the custom ID of the field. format: int64 readOnly: true type: integer items: description: When the data type is an array, the name of the field items within the array. readOnly: true type: string system: description: If the field is a system field, the name of the field. readOnly: true type: string type: description: The data type of the field. readOnly: true type: string required: - type 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