---
title: "Get articles"
method: GET
path: "/rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article"
tags: ["Servicedesk"]
---

# Get articles

`GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article`

## Request

- Base URL: `https://your-domain.atlassian.net`
- URL: `https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article`
- Auth: OAuth 2
  - Authorization code: `https://auth.atlassian.com/authorize`
  - Token URL: `https://auth.atlassian.com/oauth/token` scopes: `read:knowledgebase:jira-service-management`

Returns articles which match the given query and belong to the knowledge base linked to the service desk.

**[Permissions](#permissions) required**: Permission to access the service desk.

## Path parameters

- `serviceDeskId` string, required

## Query parameters

- `query` string, required
- `highlight` boolean
- `start` integer
- `limit` integer
- `cursor` string
- `prev` boolean

## Response `200`

Returns the articles, on the specified page of the results.

- PagedDTOArticleDTO
  - `_expands` string[]
  - `_links` PagedLinkDTO
    - `base` string, uri: Base URL for the REST API calls.
    - `context` string
    - `next` string, uri: REST API URL for the next page, if there is one.
    - `prev` string, uri: REST API URL for the previous page, if there is one.
    - `self` string, uri: REST API URL for the current page.
  - `isLastPage` boolean: Indicates if this is the last page of records (true) or not (false).
  - `limit` integer: Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  - `size` integer: Number of items returned in the page.
  - `start` integer: Index of the first item returned in the page.
  - `values` ArticleDTO[]: Details of the items included in the page.
    - `content` ContentDTO
      - `iframeSrc` string: Url containing the body of the article (without title), suitable for rendering in an iframe
    - `excerpt` string: Excerpt of the article which matches the given query string.
    - `source` SourceDTO
      - `type` 'confluence': Type of the knowledge base source
    - `title` string: Title of the article.

## Other responses

- `400`: Returned if the request is invalid, for example: missing query parameter.
- `401`: Returned if the user is not logged in.
- `403`: Returned if the user does not have permission to complete this request.
- `500`: Internal Server Error.

## Changes

> 20 revisions in range; 3 not diffed.

- **2026-07-13** `bba7b3477d98`: 2 info
  - added the new optional `query` request parameter `cursor`
  - added the new optional `query` request parameter `prev`
- **2024-02-08** `7c79c3ffe305`: 1 breaking
  - the `query` request parameter `query` became required

[Operation history](https://skmtc.dev/atlassian/apis/service-management-public-rest-api/changes/rest/servicedeskapi/servicedesk/:serviceDeskId/knowledgebase/article/get.md)

---

[API](https://skmtc.dev/atlassian/apis/service-management-public-rest-api.md) - [All operations](https://skmtc.dev/atlassian/apis/service-management-public-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/atlassian/apis/service-management-public-rest-api/revisions/fe02b1260fc7?raw)
