Jira Knowledge Base API

openapi: 3.2.0
info:
  description: Public REST API for Jira Service Management
  termsOfService: https://www.atlassian.com/legal/customer-agreement
  title: Service Management Public REST Knowledgebase API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:
- name: Knowledge Base
paths:
  /rest/servicedeskapi/knowledgebase/article:
    get:
      deprecated: false
      description: 'Returns articles which match the given query string across all service desks.


        **Permissions required**: Permission to access the customer portal.'
      operationId: getArticles
      parameters:
      - description: The string used to filter the articles (required).
        in: query
        name: query
        required: true
        schema:
          type: string
      - description: 'If set to true matching query term in the title and excerpt will be highlighted using the `@@@hl@@@term@@@endhl@@@` syntax. Default: false.'
        in: query
        name: highlight
        required: true
        schema:
          default: false
          type: boolean
      - description: '(Deprecated) The starting index of the returned objects. Base index: 0.'
        in: query
        name: start
        schema:
          format: int32
          type: integer
      - description: 'The maximum number of items to return per page. Default: 50.'
        in: query
        name: limit
        schema:
          format: int32
          type: integer
      - description: Pointer to a set of search results, returned as part of the next or prev URL from the previous search call.
        in: query
        name: cursor
        schema:
          type: string
      - description: Should navigate to the previous page. Defaulted to false. Set to true as part of prev URL from the previous search call.
        in: query
        name: prev
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              example: '{"_expands":[],"size":2,"start":2,"limit":2,"isLastPage":false,"_links":{"base":"https://your-domain.atlassian.net/rest/servicedeskapi","context":"context","next":"https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article?start=4&limit=2","prev":"https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article?start=0&limit=2"},"values":[{"title":"Stolen computer","excerpt":"assuming your computer was stolen","source":{"type":"confluence","pageId":"8786177","spaceKey":"IT"},"content":{"iframeSrc":"https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8786177"}},{"title":"Upgrading computer","excerpt":"each computer older then 3 years can be upgraded","source":{"type":"confluence","pageId":"8785228","spaceKey":"IT"},"content":{"iframeSrc":"https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8785228"}}]}'
              schema:
                $ref: '#/components/schemas/PagedDTOArticleDTO'
          description: Returns the articles, on the specified page of the results.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'Returned if the request is invalid. For example: missing query parameter.'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user is not logged in.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Returned if the user does not have permission to complete this request.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error.
      security:
      - OAuth2:
        - read:servicedesk-request
      summary: Get articles
      tags:
      - Knowledge Base
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:servicedesk-request
        state: Current
      - scheme: OAuth2
        scopes:
        - read:knowledgebase:jira-service-management
        state: Beta
      x-atlassian-connect-scope: READ
components:
  schemas:
    SourceDTO:
      additionalProperties: true
      properties:
        type:
          description: Type of the knowledge base source
          enum:
          - confluence
          type: string
      type: object
    PagedLinkDTO:
      additionalProperties: false
      properties:
        base:
          description: Base URL for the REST API calls.
          format: uri
          type: string
        context:
          type: string
        next:
          description: REST API URL for the next page, if there is one.
          format: uri
          type: string
        prev:
          description: REST API URL for the previous page, if there is one.
          format: uri
          type: string
        self:
          description: REST API URL for the current page.
          format: uri
          type: string
      type: object
    ErrorResponse:
      additionalProperties: false
      properties:
        errorMessage:
          type: string
        i18nErrorMessage:
          $ref: '#/components/schemas/I18nErrorMessage'
      type: object
    ContentDTO:
      additionalProperties: false
      properties:
        iframeSrc:
          description: Url containing the body of the article (without title), suitable for rendering in an iframe
          type: string
      type: object
    I18nErrorMessage:
      additionalProperties: false
      properties:
        i18nKey:
          type: string
        parameters:
          items:
            type: string
          type: array
      type: object
    ArticleDTO:
      additionalProperties: false
      properties:
        content:
          $ref: '#/components/schemas/ContentDTO'
        excerpt:
          description: Excerpt of the article which matches the given query string.
          type: string
        source:
          allOf:
          - $ref: '#/components/schemas/SourceDTO'
          description: Source of the article.
        title:
          description: Title of the article.
          type: string
      type: object
    PagedDTOArticleDTO:
      additionalProperties: false
      properties:
        _expands:
          items:
            type: string
          type: array
        _links:
          allOf:
          - $ref: '#/components/schemas/PagedLinkDTO'
          description: List of the links relating to the page.
        isLastPage:
          description: Indicates if this is the last page of records (true) or not (false).
          type: boolean
        limit:
          description: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
          format: int32
          type: integer
        size:
          description: Number of items returned in the page.
          format: int32
          type: integer
        start:
          description: Index of the first item returned in the page.
          format: int32
          type: integer
        values:
          description: Details of the items included in the page.
          items:
            $ref: '#/components/schemas/ArticleDTO'
          type: array
      type: object
  securitySchemes:
    OAuth2:
      description: OAuth2 scopes for Jira
      flows:
        authorizationCode:
          authorizationUrl: https://auth.atlassian.com/authorize
          scopes:
            delete:organization.property:jira-service-management: Allows the app to delete organisation entity properties
            delete:organization.user:jira-service-management: Allows the app to remove members from organisations
            delete:organization:jira-service-management: Allows the app to delete organisations
            delete:request.feedback:jira-service-management: Allows the app to remove feedback data from requests
            delete:request.notification:jira-service-management: Allows the app to remove the subscription status of the user from requests
            delete:request.participant:jira-service-management: Allows the app to remove participants (user) data from requests
            delete:requesttype.property:jira-service-management: Allows the app to delete request type entity properties
            delete:servicedesk.customer:jira-service-management: Allows the app the delete customers from service desks
            delete:servicedesk.organization:jira-service-management: Allows the app the delete organisations from service desks
            delete:servicedesk.property:jira-service-management: Allows the app to delete service desk entity properties
            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.
            manage:servicedesk-customer: Manage Jira Service Management customers and organizations | Create, manage and delete customers and organizations.<br>Add and remove customers and organizations from service desks.
            read:customer:jira-service-management: Allows the app to read customer accounts information
            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:knowledgebase:jira-service-management: Allows the app to search and list KB articles
            read:mail-logs.connectivity:jira-service-management: Allows the app to read email connectivity logs
            read:mail-logs.processing:jira-service-management: Allows the app to read incoming email processing logs
            read:organization.property:jira-service-management: Allows the app to read organisation entity properties
            read:organization.user:jira-service-management: Allows the app to read organisation membership information
            read:organization:jira-service-management: Allows the app to read organisation information
            read:queue:jira-service-management: Allows the app to list queues
            read:request.action:jira-service-management: Allows the app to read which actions can be performed on requests
            read:request.approval:jira-service-management: Allows the app to read approval data from requests
            read:request.attachment:jira-service-management: Allows the app to read attachment data from requests
            read:request.comment:jira-service-management: Allows the app to read comment data from requests
            read:request.feedback:jira-service-management: Allows the app to read feedback data from requests
            read:request.notification:jira-service-management: Allows the app to read the subscription status of the user for requests
            read:request.participant:jira-service-management: Allows the app to read participant (user) data from requests
            read:request.sla:jira-service-management: Allows the app to read SLA data from requests
            read:request.status:jira-service-management: Allows the app to read status/transition data from requests
            read:request:jira-service-management: Allows the app to list & search requests
            read:requesttype.property:jira-service-management: Allows the app to read request type desk entity properties
            read:requesttype:jira-service-management: Allows the app to list & search request types
            read:servicedesk-request: Read customer request data, including approvals, attachments, comments, request participants, and status/transitions.<br>Read service desk and request types, including searching for request types and reading request type fields, properties and groups.
            read:servicedesk.customer:jira-service-management: Allows the app the list customers of service desks
            read:servicedesk.organization:jira-service-management: Allows the app to list organisations to service desks
            read:servicedesk.property:jira-service-management: Allows the app to read service desk entity properties
            read:servicedesk:jira-service-management: Allows the app to list & search service desks
            write:customer:jira-service-management: Allows the app to create customer accounts (user)
            write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues.
            write:organization.property:jira-service-management: Allows the app to write organisation entity properties
            write:organization.user:jira-service-management: Allows the app to add members to organisations
            write:organization:jira-service-management: Allows the app to create organisations
            write:request.approval:jira-service-management: Allows the app to act on approvals of requests (e.g approve, deny, …)
            write:request.attachment:jira-service-management: Allows the app to add attachments to requests
            write:request.comment:jira-service-management: Allows the app to add comments to requests
            write:request.feedback:jira-service-management: Allows the app to write feedback data on requests
            write:request.notification:jira-service-management: Allows the app to change the subscription status of the user for requests
            write:request.participant:jira-service-management: Allows the app to add participants (user) data from requests
            write:request.status:jira-service-management: Allows the app to execute transitions on requests
            write:request:jira-service-management: Allows the app to create requests
            write:requesttype.property:jira-service-management: Allows the app to write request type entity properties
            write:requesttype:jira-service-management: Allows the app to create or modify request types
            write:servicedesk-request: Create and manage Jira Service Management requests | Create and edit customer requests, including add comments and attachments, approve, share (add request participants), subscribe, and transition.
            write:servicedesk.customer:jira-service-management: Allows the app the add customers to service desks
            write:servicedesk.organization:jira-service-management: Allows the app the add organisations to service desks
            write:servicedesk.property:jira-service-management: Allows the app to write service desk entity properties
            write:servicedesk:jira-service-management: Allows the app the add organisations, customers and request types to service desks
          tokenUrl: https://auth.atlassian.com/oauth/token
      type: oauth2
    basicAuth:
      description: You can access this resource via basic auth.
      scheme: basic
      type: http
x-atlassian-narrative:
  documents:
  - anchor: about
    body: 'The REST APIs are for developers who want to integrate Jira Service Management with other applications or administrators who want to automate their workflows and processes.

      '
    title: About
  - anchor: jira-cloud-platform-apis
    body: "Jira Service Management is built upon the Jira platform. As such, in Jira Service Management you have access to the Jira platform REST APIs.\n\n * [Browse the Jira platform REST APIs](/cloud/jira/platform/rest/)\n"
    title: Jira Cloud Platform APIs
  - anchor: permissions
    body: 'Permissions control the level of a user''s access to the Jira Service Management instance, while roles are how the permissions are assigned to individual users.


      For detailed information on roles and permissions, see [Permissions overview](https://support.atlassian.com/jira-service-management-cloud/docs/overview-of-jira-cloud-permissions/)

      and [Setting up service management users](https://support.atlassian.com/jira-service-management-cloud/docs/set-up-service-desk-users-to-work-on-requests/).

      '
    title: Permissions and roles
  - anchor: authentication
    body: 'The Jira Service Management REST API uses the same authentication methods as Jira Cloud platform.


      ### Forge apps


      Forge apps use [REST API scopes](https://developer.atlassian.com/cloud/jira/service-desk/scopes-for-oauth-2-3LO-and-forge-apps/) when authenticating with Jira Service Management Cloud. For details see [Add scopes to call an Atlassian REST API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/).


      The URIs for Forge app REST API calls have this structure:


      `https://<site-url>/rest/servicedeskapi/<resource-name>`


      For example, `https://<site-url>/rest/servicedeskapi/request/DEMO-1`



      ### Connect apps


      For Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either scopes (shown as App scope required for operations on this page) or user impersonation. For details, see [Security for Connect apps](https://developer.atlassian.com/cloud/jira/service-desk/security-for-connect-apps/).


      The URIs for Connect app REST API calls have this structure:


      `https://<site-url>/rest/servicedeskapi/<resource-name>`


      For example, `https://<site-url>/rest/servicedeskapi/request/DEMO-1`


      ### Other integrations

      For integrations that are not Forge or Connect apps, use OAuth 2.0 authorization code grants (3LO) for security (3LO scopes are shown as for operations OAuth scopes required). For details, see [OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/service-desk/oauth-2-authorization-code-grants-3lo-for-apps/).


      The URIs for OAuth 2.0 (3LO) app REST API calls have this structure:


      `https://api.atlassian.com/ex/jira/<cloudId>/rest/servicedeskapi/<resource-name>`


      For example, `https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/servicedeskapi/request/DEMO-1`



      ### Ad-hoc API calls


      For personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. For details, see [Basic auth for REST APIs](https://developer.atlassian.com/cloud/jira/service-desk/basic-auth-for-rest-apis/).


      The URIs for basic authentication REST API calls have this structure:


      `https://<site-url>/rest/servicedeskapi/<resource-name>`


      For example, `https://your-domain.atlassian.net/rest/servicedeskapi/request/DEMO-1`



      '
    title: Authentication and authorization
  - anchor: scopes
    body: 'Your app can request access to the Jira Service Management REST APIs by using the correct scopes.




      * [Scopes for Forge and 3LO apps](https://developer.atlassian.com/cloud/jira/service-desk/scopes-for-oauth-2-3LO-and-forge-apps/)

      * [Scopes for Connect apps](https://developer.atlassian.com/cloud/jira/service-desk/scopes-for-connect-apps/).

      '
    title: Scopes
  - anchor: desks
    body: "It is also worth noting that the ability of Customers to raise Requests depends on the service desk type, which can be:\n\n -   Public (sign up): Anyone who has the service desk URL can submit requests, and a user (customer) is created for them when a request is submitted.\n -   Open: Any user in the system can submit requests, they don’t need to be associated with the service desk.\n -   Closed: Only users associated with the service desk can submit requests.\n\nFor more details, see [How to manage access to your Jira Service Management Cloud](https://confluence.atlassian.com/jirakb/how-to-manage-access-to-your-jira-service-desk-cloud-967872675.html) in the Jira Service Management Cloud documentation.\n\n"
    title: Service desk types
  - anchor: status
    body: "\n -   <span class=\"aui-lozenge aui-lozenge-success\">Status 200</span> Returned if the requested content (GET) is returned or content is updated (PUT).\n -   <span class=\"aui-lozenge aui-lozenge-success\">Status 201</span> Returned if new records are created (PUT).\n -   <span class=\"aui-lozenge aui-lozenge-success\">Status 204</span> Returned where the request may or may not have been actioned, but the outcome is as expected. For example, the request was to remove a customer from an organization, but the customer was not associated with the organization.\n -   <span class=\"aui-lozenge aui-lozenge-error\">Status 400</span> Returned if the request was invalid.\n -   <span class=\"aui-lozenge aui-lozenge-error\">Status 401</span> Returned if the user is not logged in. Resolve by logging the user in and reissuing the call.\n -   <span class=\"aui-lozenge aui-lozenge-error\">Status 403</span> Returned if the user does not have the necessary permission to access the resource or run the method.\n -   <span class=\"aui-lozenge aui-lozenge-error\">Status 404</span> Returned if the passed path parameters do not correspond to an object in the instance, for example, no Organization exists for a passed ID.\n -   <span class=\"aui-lozenge aui-lozenge-error\">Status 412</span> Returned if the API is experimental but the `X-ExperimentalApi: opt-in` header was not passed. For more details, see [Experimental methods](#experimental).\n\nResources will return a response body in addition to the error status codes. The returned entity for errors is as follows:\n\n```json\n{\n  \"errorMessage\": \"Here is an error message\",\n  \"i18nErrorMessage\": {\n    \"i18nKey\": \"some.error.key\",\n    \"parameters\": []\n  }\n}\n```\n"
    title: Status codes and responses
  - anchor: experimental
    body: 'Methods marked as <span class="aui-lozenge aui-lozenge-subtle aui-lozenge-current">experimental</span> may change without notice. To use experimental methods, you must include the `X-ExperimentalApi: opt-in` header in your requests. Use of this header indicates that you are opting into the experimental preview. Once a resource or method moves out of the experimental phase, then the header will no longer be required or checked.


      Feedback on the experimental APIs is welcome and can be provided by submitting a feature request or suggestion through the [Atlassian Ecosystem Help Center](https://ecosystem.atlassian.net/servicedesk/customer/portals) or the [Jira Service Management Ecosystem](https://ecosystem.atlassian.net/browse/JSDECO).

      '
    title: Experimental methods
  - anchor: expansion
    body: "The Jira Service Management REST API uses resource expansion, which means that some parts of a resource are not returned unless specified in the request. This simplifies responses and minimizes network traffic.\n\nUse the `expand` query parameter to specify the list of entities that you want to be expanded, identifying each of them by name. For example, appending `?expand=serviceDesk&expand=requestType` to a request’s URI results in the inclusion of the service desk and request type details in the response. The following URL would be used to get that information for the request with the ID JSD-1:\n```\nhttp://host:port/context/rest/servicedeskapi/request/JSD-1?expand=serviceDesk&expand=requestType\n```\n\nAlternatively, you can pass the list of entities you want to be expanded as a single comma-separated parameter, as in:\n\n```\nhttp://host:port/context/rest/servicedeskapi/request/JSD-1?expand=serviceDesk,requestType\n```\n\nTo discover the expansion identifiers for each entity, look at the `_expands` property in the parent object. In the JSON example below, the resource declares `participant`, `status`, `sla`, `requestType`, and `serviceDesk` as expandable.\n\n```json\n{\n    \"_expands\": [\n        \"participant\",\n        \"status\",\n        \"sla\",\n        \"requestType\",\n        \"serviceDesk\"\n    ],\n    \"issueId\": \"107001\",\n    \"issueKey\": \"HELPDESK-1\",\n    \"requestTypeId\": \"11001\",\n    \"serviceDeskId\": \"10001\",\n    ...\n```\n\n"
    title: Expansion
  - anchor: pagination
    body: "The Jira Service Management REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large collection of items. When you make a request to a paginated resource, the response wraps the returned array of values in a JSON object with paging metadata as follows:\n**Request**\n\n```\nhttp://host:port/context/rest/api-name/resource-name?start=0&limit=10\n```\n\n**Response**\n\n```json\n{\n    \"start\" : 0,\n    \"limit\" : 10,\n    \"size\" : 7,\n    \"isLastPage\" : true,\n    \"values\": [\n        { /* result 0 */ },\n        { /* result 1 */ },\n        { /* result 2 */ }\n        { /* result 3 */ }\n        { /* result 4 */ }\n        { /* result 5 */ }\n        { /* result 6 */ }\n    ]\n}\n```\n\nWhere:\n\n - `start` is the index of the first item returned in the page of results.\n - `limit` is the total number of items that could be returned per page, subject to the maximum server enforced limit for the resource’s method. If `limit` isn’t specified the default value of the resource is used.\n - `size` is the number of items returned on this page.\n - `isLastPage` indicates whether the page is the last page of results.\n\nClients can use the `start`, `limit`, and `size` parameters to retrieve the desired number of results. Each resource or method has a unique limit on the maximum number of items returned, which cannot be exceeded. If you request `size` which is larger than the limit, the number of items returned will be capped at the limit for that resource’s method. This behavior can be identified when the first page shows `size` is less than `limit` and `isLastPage` is `false`.\n\nThe limits set for each resource’s method is an implementation detail and may be changed.\n"
    title: Pagination
  - anchor: request-language
    body: "By default, responses are translated based on the requesting user's language preference, or the Jira site default \nlanguage if anonymous.\n\nUse the `requestLanguage` query parameter to have responses translated in a specific language, providing an \n[IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag in the form `(language code)-(country code)` as the value. \nE.g. `?requestLanguage=en-US` for English (United States). Both static text (e.g. error messages) and dynamic \nuser-entered text (e.g. workflow status names) will be translated, if available.\n\nThe languages available are based on the installed languages in Jira. If the language tag specified does not match one \nof Jira's languages, then the query parameter will have no effect.\n\nDynamic user-entered translations can be edited in Jira administration for global objects (e.g. priority names) and \nin **Language support** under project administration for Service Desk projects (e.g. request type names)."
    title: Request language
  - anchor: special-headers
    body: "The following request and response headers define important metadata for the Jira Service Management REST API resources.\n\n -   **X-Atlassian-Token** (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check` header in requests.\nOtherwise the request will be blocked by XSRF protection.\n -   **X-ExperimentalApi** (request): Experimental operations must include the `X-ExperimentalApi: opt-in` header in requests.\n Otherwise the request will not be processed. See [Experimental methods](#experimental) for more details.\n-   **X-AACCOUNTID** (response): This response header contains the Atlassian account ID of the authenticated user.\n"
    title: Special headers
  - anchor: project-identifiers
    body: "For convenience, any of the resources that require a `{serviceDeskId}` path parameter also accept other identifiers.\n\nFor example, if a `ServiceDesk(id: 15)` corresponds to a `Project(id: 10012, key: ABC)`, then issuing a request to any of:\n\n    /rest/servicedeskapi/servicedesk/ABC\n\n    /rest/servicedeskapi/servicedesk/projectKey:ABC\n\n    /rest/servicedeskapi/servicedesk/projectId:10012\n\n    /rest/servicedeskapi/servicedesk/serviceDeskId:15\n\nis equivalent to issuing a request to:\n\n    /rest/servicedeskapi/servicedesk/15\n"
    title: Using project identifiers


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-knowledge-base-api-openapi.yml