---
title: "Get articles"
method: GET
path: "/rest/servicedeskapi/knowledgebase/article"
tags: ["Knowledgebase"]
---

# Get articles

`GET /rest/servicedeskapi/knowledgebase/article`

Returns articles which match the given query string across all service desks.

**[Permissions](#permissions) required**: Permission to access the [customer portal](https://confluence.atlassian.com/servicedeskcloud/configuring-the-customer-portal-732528918.html).

## Query parameters

- `query` string, required
- `highlight` boolean, required
- `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.

---

[API](https://skmtc.net/atlassian/apis/service-management-public-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/service-management-public-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/service-management-public-rest-api/versions/d1dc1a13b783/schema)