---
sourceDocument: Yokohama API Reference
sourceDocumentLink: https://www.servicenow.com/docs/r/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Knowledge Management REST API

# Knowledge Management REST API {#ariaid-title1}

* Release version: Yokohama
* 
* Updated January 30, 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 23 minutes to read

The Knowledge Management API provides endpoints for searching, viewing, and fetching lists of the most-viewed and featured knowledge articles.

You can only use this API when the Knowledge API (sn_km_api) plugin is activated. The Knowledge Management REST API was originally released in Orlando using the Knowledge API app available in the ServiceNow Store.  
Note:  
The Knowledge Management REST API is publicly accessible and makes any knowledge base that is publicly accessible available to all users, including unauthenticated users. For version 1.0.1 and later, the API was made editable, allowing admins to configure each endpoint to disallow unauthenticated access by selecting the Requires Authentication flag on the Scripted REST Service Security tab associated with the API.

To enable other domains to use Knowledge Management REST API endpoints,
define a Cross-Origin Resource Sharing (CORS) rule. For more information, see [Define a CORS rule](https://www.servicenow.com/docs/GUuYHh9hUgILxz1xR4~3TA "You can define a CORS rule to control which domains can access REST API endpoints and other web resources.").

To view an article from the scoped knowledge base using this REST API, allow the sn_km_api
scope read access from the requesting scope in the Restricted Caller Access Privileges
\[sys_restricted_caller_access\] table. For more information, see [Define cross-scope access to an application
resource](https://www.servicenow.com/docs/access?context=set-RCA-level&version=yokohama&pubname=yokohama-application-development&ft:locale=en-US).

By default, this API has a rate limit of 500 per hour for unauthenticated and snc_external
users. For more information about rate limiting, see [Inbound REST API rate limiting](https://www.servicenow.com/docs/t6hg0aS~DLhfIqbnbnwDBw "To prevent excessive inbound REST API requests, set rules that limit the number of inbound REST API requests processed per hour. You can create rules to limit requests for specific users, users with specific roles, or all users.").

## Knowledge Management - GET /knowledge/articles {#ariaid-title2}

Returns a list of knowledge base (KB) articles which can be searched and filtered using
various parameters.

### URL format {#knowledge-GET-articles__section_anz_bcv_1mb}

Versioned URL:
/api/sn_km_api/{api_version}/knowledge/articles

Default URL:
/api/sn_km_api/knowledge/articles  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#knowledge-GET-articles__entry__2}{#knowledge-GET-articles__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 1. Path parameters]

{#knowledge-GET-articles__entry__6}{#knowledge-GET-articles__km-api-parm-lang}{#knowledge-GET-articles__km-api-parm-off}

| Name | Description |
|-|-|
| filter | Encoded query to use to filter the result set. Syntax: `filter=<attr><operator><value>`. * `<attr>`: Name of the table column. * `<operator>`: Valid values: * =: Exactly matches \<value\>. * !=: Does not match \<value\>. * \^: Enables you to specify more than one condition and logically AND them. * \^OR: Enables you to specify more than one condition and logically OR them. * LIKE: \<attr\> contains the specified string. Only works for \<attr\> fields whose data type is string. * STARTSWITH: \<attr\> starts with the specified string. Only works for \<attr\> fields whose data type is string. * ENDSWITH: \<attr\> ends with the specified string. Only works for \<attr\> fields whose data type is string. {#knowledge-GET-articles__ul_zkb_jpy_mgb} * `<value>`: Value to match against. {#knowledge-GET-articles__ul_aj4_rpt_xkb} All parameters are case-sensitive. Query can contain more than one entry, such as `filter=<attr><operator><value>[<operator><attr><operator><value>]`. Data type: String Default: empty |
| fields | Comma-separated list of fields from the Knowledge \[kb_knowledge\] table to show details in results. Data type: String Default: None |
| kb | Comma-separated list of knowledge base sys_ids from the Knowledge Bases \[kb_knowledge_base\] table to restrict results to. Data type: String |
| language | List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. Data type: String Default: User's session language or en |
| limit | Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the offset parameter to paginate record retrieval. Data type: Number Default: 30 |
| offset | Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time this endpoint is called, offset is set to "0". To page through all available records, use `offset=offset+limit` until the end of the all records is reached. Data type: Number Default: 0 |
| query | Text to search for, can be empty. Data type: String |
[Table 2. Query parameters]

{#knowledge-GET-articles__entry__22}

| Name | Description |
|-|-|
| None |   |
[Table 3. Request body parameters (XML or JSON)]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#knowledge-GET-articles__entry__26}{#knowledge-GET-articles__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 4. Request headers]

{#knowledge-GET-articles__entry__30}

| Header | Description |
|-|-|
| None |   |
[Table 5. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#knowledge-GET-articles__entry__34}{#knowledge-GET-articles__entry-200-status-code}{#knowledge-GET-articles__entry-401-status-code}{#knowledge-GET-articles__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. |
[Table 6. Status codes]

### Response body parameters (JSON or XML)

{#knowledge-GET-articles__entry__42}{#knowledge-GET-articles__km-resp-fields}{#knowledge-GET-articles__km-resp-fields_fieldname}{#knowledge-GET-articles__km-resp-fieldName-display}{#knowledge-GET-articles__km-resp-fieldName-label}{#knowledge-GET-articles__km-resp-fieldName-name}{#knowledge-GET-articles__km-resp-fieldName-type}{#knowledge-GET-articles__km-resp-fields-fieldName-val}{#knowledge-GET-articles__km_kb_id}{#knowledge-GET-articles__km_kb_sdesc}

| Name | Description |
|-|-|
| articles | List of articles returned in response. Data type: Array "articles": [ { "fields": {Object}, "link": "String", "id": "String", "number": "String", "rank": Number, "score": Number, "snippet": "String", "title": "String" } ] |
| articles.fields | Values of requested fields, if any. Data type: Object "fields": { "<field_name>": {Object} } |
| articles.fields.\<field_name\> | Lists each field requested using the fields parameter, if any. Data type: Object "<field_name>": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } |
| articles.fields.\<field_name\>.display_value | Display value of the requested field. Data type: String |
| articles.fields.\<field_name\>.label | Label representing the requested field. For example, Knowledge. Data type: String |
| articles.fields.\<field_name\>.name | Name of the requested field. Matches \<field_name\>. Data type: String |
| articles.fields.\<field_name\>.type | Data type of requested field. Data type: String |
| articles.fields.\<field_name\>.value | Value of the requested field. Data type: String |
| articles.id | Knowledge article sys_id from the Knowledge \[kb_knowledge\] table. Data type: String |
| articles.link | Link to the article. Data type: String |
| articles.number | Knowledge article number. Data type: String |
| articles.rank | Search rank of article specific to this search. Data type: Number (Float) |
| articles.snippet | Text showing a small portion of the knowledge article. Data type: String |
| articles.score | Relevancy score, results sorted in descending order by score. Data type: String |
| articles.title | Short description or title of the knowledge article. Data type: String |
| meta | Meta information of the results and request parameters. Data type: Object "meta": { "count": Number, "end": Number, "fields": "String", "filter": "String", "kb": "String", "language": "String", "query": "String", "start": Number, "status": {Object}, "ts_query_id": "String" } |
| meta.count | Number of available KB articles. Data type: Number |
| meta.end | Ending index of the result set. Data type: Number |
| meta.fields | Fields in the article. Data type: String |
| meta.filter | Filter used to acquire the data. Data type: String |
| meta.kb | List of knowledge base article sys_ids. Data type: String |
| meta.language | List of comma-separated languages of the KB articles that were requested. Data type: String |
| meta.query | Specified request query. Data type: String |
| meta.start | Starting index of result set. Data type: Number |
| meta.status | Status of the call. Data type: String |
| meta.ts_query_id | Sys_id of the query. Data type: String |
[ ]

### cURL request

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles?query=Windows&limit=2&fields=short_description&fields=sys_class_name" \
    --request GET \
    --header "Accept:application/xml" \
    --user "username":"password"

    {
      "result": {
        "meta": {
          "start": 0,
          "end": 2,
          "fields": "short_description,sys_class_name",
          "query": "Windows",
          "filter": "",
          "kb": "",
          "language": "en",
          "count": 19,
          "ts_query_id": "7976f36129c30410f877796e70786991",
          "status": {
            "code": 200
          }
        },
        "articles": [
          {
            "link": "?sys_kb_id=9e528db1474321009db4b5b08b9a71a6&id=kb_article_view&sysparm_rank=1&sysparm_tsqueryId=7976f36129c30410f877796e70786991",
            "rank": 1,
            "id": "kb_knowledge:9e528db1474321009db4b5b08b9a71a6",
            "title": "Windows: Should I upgrade to Windows 8.x?",
            "snippet": "    Should I upgrade to <B>Windows</B> 8.x? <B>Windows</B> 8.x is designed for using touch, mouse, and keyboard the <B>Windows</B> Store and access apps such as Calendar, Mail, and Messaging. By most accounts, <B>Windows</B> boot times, smaller memory footprint, and more free memory for the programs you run. <B>Windows</B>",
            "score": 14.869,
            "number": "KB0000020",
            "fields": {
              "short_description": {
                "display_value": "Windows: Should I upgrade to Windows 8.x?\n\t\t",
                "name": "short_description",
                "label": "Short description",
                "type": "string",
                "value": "Windows: Should I upgrade to Windows 8.x?\n\t\t"
              },
              "sys_class_name": {
                "display_value": "Knowledge",
                "name": "sys_class_name",
                "label": "Class",
                "type": "sys_class_name",
                "value": "kb_knowledge"
              }
            }
          },
          {
            "link": "?sys_kb_id=3b07857187032100deddb882a2e3ec20&id=kb_article_view&sysparm_rank=2&sysparm_tsqueryId=7976f36129c30410f877796e70786991",
            "rank": 2,
            "id": "kb_knowledge:3b07857187032100deddb882a2e3ec20",
            "title": "What is the Windows key?",
            "snippet": "What is the <B>Windows</B> key? The <B>Windows</B> key is a standard key on most keyboards on computers built to use a <B>Windows</B> operating system. It is labeled with a <B>Windows</B> logo, and is usually placed between on the right side as well. Pressing Win (the <B>Windows</B> key) on its own will do the following: <B>Windows</B> 8.x: Toggle",
            "score": 13.4826,
            "number": "KB0000017",
            "fields": {
              "short_description": {
                "display_value": "What is the Windows key?\t\t",
                "name": "short_description",
                "label": "Short description",
                "type": "string",
                "value": "What is the Windows key?\t\t"
              },
              "sys_class_name": {
                "display_value": "Knowledge",
                "name": "sys_class_name",
                "label": "Class",
                "type": "sys_class_name",
                "value": "kb_knowledge"
              }
            }
          }
        ]
      }
    }

## Knowledge Management - GET
/knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id} {#ariaid-title3}

Returns a knowledge article attachment as a file.

### URL format {#knowledge-GET-articles-attachments__section_rsz_rc4_bmb}

Versioned URL:
/api/sn_km_api/{api_version}/knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id}

Default URL:
/api/sn_km_api/knowledge/articles/{article_sys_id}/attachments/{attachment_sys_id}  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#knowledge-GET-articles-attachments__entry__2}{#knowledge-GET-articles-attachments__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| article_sys_id | Sys_id of the knowledge article with the attachment you intend to retrieve. Data type: String Table: Knowledge Bases \[kb_knowledge\] |
| attachment_sys_id | Sys_id of record to which the attachment belongs. Data type: String |
[Table 7. Path parameters]

{#knowledge-GET-articles-attachments__entry__10}

| Name | Description |
|-|-|
| None |   |
[Table 8. Query parameters]

{#knowledge-GET-articles-attachments__entry__14}

| Name | Description |
|-|-|
| None |   |
[Table 9. Request body parameters (XML or JSON)]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#knowledge-GET-articles-attachments__entry__18}{#knowledge-GET-articles-attachments__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 10. Request headers]

{#knowledge-GET-articles-attachments__entry__22}

| Header | Description |
|-|-|
| Content-Type | The content type of the response, for example, <kbd class="ph userinput">image/gif</kbd> or <kbd class="ph userinput">*/*</kbd>. |
[Table 11. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#knowledge-GET-articles-attachments__entry__26}{#knowledge-GET-articles-attachments__entry-200-status-code}{#knowledge-GET-articles-attachments__entry-401-status-code}{#knowledge-GET-articles-attachments__entry-404-status-code}{#knowledge-GET-articles-attachments__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 404 | Not found. The requested item wasn't found. |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 12. Status codes]

### Response body parameters

{#knowledge-GET-articles-attachments__entry__36}

| Name | Description |
|-|-|
| File is returned as a response. |   |
[ ]

### Sample cURL request

    curl "https://instance.service-now.com/api/sn_km_api/knowledge/articles/0b48fd75474321009db4b5b08b9a71c2/attachments/fedf5614294f4010f877796e70786956" \
    --request GET \
    --header "Accept:*/*" \
    --user "username":"password"

    Binary response not shown (file is returned as a response).

## Knowledge Management - GET /knowledge/articles/featured {#ariaid-title4}

Returns a list of the most-viewed knowledge articles and featured knowledge
articles.

### URL format {#knowledge-GET-articles-featured__section_ayw_2gv_1mb}

Versioned URL:
/api/sn_km_api/{api_version}/knowledge/articles/featured

Default URL:
/api/sn_km_api/knowledge/articles/featured  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#knowledge-GET-articles-featured__entry__2}{#knowledge-GET-articles-featured__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 13. Path parameters]

{#knowledge-GET-articles-featured__entry__6}{#knowledge-GET-articles-featured__km-api-parm-fields}{#knowledge-GET-articles-featured__km-api-parm-kb}{#knowledge-GET-articles-featured__km-api-parm-lang}{#knowledge-GET-articles-featured__km-api-parm-limit}{#knowledge-GET-articles-featured__km-api-parm-off}

| Name | Description |
|-|-|
| fields | Comma-separated list of fields from the Knowledge \[kb_knowledge\] table to show details in results. Data type: String Default: None |
| kb | Comma-separated list of knowledge base sys_ids from the Knowledge Bases \[kb_knowledge_base\] table to restrict results to. Data type: String |
| language | List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. Data type: String Default: User's session language or en |
| limit | Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the offset parameter to paginate record retrieval. Data type: Number Default: 30 |
| offset | Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time this endpoint is called, offset is set to "0". To page through all available records, use `offset=offset+limit` until the end of the all records is reached. Data type: Number Default: 0 |
[Table 14. Query parameters]

{#knowledge-GET-articles-featured__entry__18}

| Name | Description |
|-|-|
| None |   |
[Table 15. Request body parameters (XML or JSON)]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#knowledge-GET-articles-featured__entry__22}{#knowledge-GET-articles-featured__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 16. Request headers]

{#knowledge-GET-articles-featured__entry__26}

| Header | Description |
|-|-|
| None |   |
[Table 17. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#knowledge-GET-articles-featured__entry__30}{#knowledge-GET-articles-featured__entry-200-status-code}{#knowledge-GET-articles-featured__entry-401-status-code}{#knowledge-GET-articles-featured__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. |
[Table 18. Status codes]

### Response body parameters (JSON or XML)

{#knowledge-GET-articles-featured__entry__38}{#knowledge-GET-articles-featured__km-resp-fields}{#knowledge-GET-articles-featured__km-resp-fields_fieldname}{#knowledge-GET-articles-featured__km-resp-fieldName-display}{#knowledge-GET-articles-featured__km-resp-fieldName-name}{#knowledge-GET-articles-featured__km-resp-fieldName-label}{#knowledge-GET-articles-featured__km-resp-fieldName-type}{#knowledge-GET-articles-featured__km-resp-fields-fieldName-val}{#knowledge-GET-articles-featured__km_kb_id}{#knowledge-GET-articles-featured__km_kb_sdesc}

| Name | Description |
|-|-|
| articles | List of articles returned in response. Data type: Array "articles":[ { "fields": {Object}, "id": "String", "link": "String", "number": "String", "rank": Number, "score": Number, "snippet": "String", "title": "String" } ] |
| articles.fields | Values of requested fields, if any. Data type: Object "fields": { "<field_name>": {Object} } |
| articles.fields.\<field_name\> | Lists each field requested using the fields parameter, if any. Data type: Object "<field_name>": { "display_value": "String", "name": "String", "label": "String", "type": "String", "value": "String" } |
| articles.fields.\<field_name\>.display_value | Display value of the requested field. Data type: String |
| articles.fields.\<field_name\>.name | Name of the requested field. Matches \<field_name\>. Data type: String |
| articles.fields.\<field_name\>.label | Label representing the requested field. For example, Knowledge. Data type: String |
| articles.fields.\<field_name\>.type | Data type of requested field. Data type: String |
| articles.fields.\<field_name\>.value | Value of the requested field. Data type: String |
| articles.id | Knowledge article sys_id from the Knowledge \[kb_knowledge\] table. Data type: String |
| articles.link | Link to the article. Data type: String |
| articles.number | Knowledge article number. Data type: String |
| articles.rank | Search rank of article specific to this search. Data type: Number (Float) |
| articles.score | Relevancy score, results sorted in descending order by score. Data type: String |
| articles.snippet | Text showing a small portion of the knowledge article. Data type: String |
| articles.title | Short description or title of the knowledge article. Data type: String |
| meta | Meta information of the results and request parameters. Data type: Object "meta": { "count": Number, "end": Number, "fields": "String", "filter": "String", "kb": "String", "language": "String", "query": "String", "start": Number, "status": {Object}, "ts_query_id": "String" } |
| meta.count | Number of available KB articles. Data type: Number |
| meta.end | Ending index of the result set. Data type: Number |
| meta.fields | Fields in the article. Data type: String |
| meta.filter | Filter used to acquire the data. Data type: String |
| meta.kb | List of knowledge base article sys_ids. Data type: String |
| meta.language | List of comma-separated languages of the KB articles that were requested. Data type: String |
| meta.query | Specified request query. Data type: String |
| meta.start | Starting index of result set. Data type: Number |
| meta.status | HTTP status of the call. Data type: String |
| meta.ts_query_id | Sys_id of the query. Data type: String |
[ ]

### cURL request

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles/featured?fields=short_description&limit=3" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

    {
      "result": {
        "meta": {
          "start": 0,
          "end": 3,
          "fields": "short_description",
          "query": "homepage",
          "filter": "",
          "kb": "",
          "language": "en",
          "status": {
            "code": 200
          },
          "count": 2
        },
        "articles": [
          {
            "link": "?id=kb_article_view&sys_kb_id=f27d7f79c0a8011b0018f9d700d2b9aa",
            "id": "kb_knowledge:f27d7f79c0a8011b0018f9d700d2b9aa",
            "title": "Email Interruption Tonight at 11:00 PM Eastern",
            "snippet": " If the site is UP but you cant access the page, try one of the below solutions: Browser Related Problems Force a full refresh for the site. This can be achieved by pressing CTRL + F5 keys at the same time on your favourite browser (Firefox, Chrome, Explorer, etc.) Try alternative urls such as m.outlook.com Clear the temporary cache and cookies ",
            "score": -1,
            "number": "KB0000002",
            "fields": {
              "short_description": {
                "display_value": "Email Interruption Tonight at 11:00 PM Eastern\n\t\t",
                "name": "short_description",
                "label": "Short description",
                "type": "string",
                "value": "Email Interruption Tonight at 11:00 PM Eastern\n\t\t"
              }
            }
          },
          {
            "link": "?id=kb_article_view&sys_kb_id=f2765f9fc0a8011b0120ec1b352bf09b",
            "id": "kb_knowledge:f2765f9fc0a8011b0120ec1b352bf09b",
            "title": "Sales Force Automation is DOWN",
            "snippet": "  On Friday, January 20th, we experienced a widespread outage that affected all Zoho services. The outage started around 8:13 am Pacific Time. Zoho services started coming back online for customer use at 3:49 pm, and all services were fully restored at 6:22 pm PST. We absolutely realize how important our services are for businesses and users who",
            "score": -1,
            "number": "KB0000001",
            "fields": {
              "short_description": {
                "display_value": "Sales Force Automation is DOWN",
                "name": "short_description",
                "label": "Short description",
                "type": "string",
                "value": "Sales Force Automation is DOWN"
              }
            }
          }
        ]
      }
    }

## Knowledge Management - GET /knowledge/articles/{id} {#ariaid-title5}

Returns specific knowledge article content and its field values.

### URL format {#knowledge-GET-articles-id__section_tx3_phv_1mb}

Versioned URL:
/api/sn_km_api/{api_version}/knowledge/articles/{id}

Default URL:
/api/sn_km_api/knowledge/articles/{id}  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#knowledge-GET-articles-id__entry__2}{#knowledge-GET-articles-id__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
| id | Sys_id or knowledge base (KB) number of a knowledge article. Data type: String Table: Knowledge \[kb_knowledge\] |
[Table 19. Path parameters]

{#knowledge-GET-articles-id__entry__8}{#knowledge-GET-articles-id__km-api-parm-fields}

| Name | Description |
|-|-|
| fields | Comma-separated list of fields from the Knowledge \[kb_knowledge\] table to show details in results. Data type: String Default: None |
| language | Two letter ISO 639-1 language code; for example, "fr" for French. Results display only when searches use the knowledge article KB number as the id and a translated version of the article is available in the language specified. Note: Only valid when setting the id parameter as a KB number (not sys_id). Data type: String |
| search_id | Optional unless using search_rank. Unique identifier of search that returned this article. You can retrieve search_id using one of the following APIs that returns the articles.id element: * [Knowledge Management - GET /knowledge/articles](https://www.servicenow.com/docs/TjVdPpBJVWl33nk2jvn0Lw#knowledge-GET-articles "Returns a list of knowledge base (KB) articles which can be searched and filtered using various parameters.") * [Knowledge Management - GET /knowledge/articles/featured](https://www.servicenow.com/docs/TjVdPpBJVWl33nk2jvn0Lw#knowledge-GET-articles-featured "Returns a list of the most-viewed knowledge articles and featured knowledge articles.") * [Knowledge Management - GET knowledge/articles/most_viewed](https://www.servicenow.com/docs/TjVdPpBJVWl33nk2jvn0Lw#knowledge-GET-articles-most-viewed "Returns a list of knowledge articles prioritized by most-viewed.") {#knowledge-GET-articles-id__ul_g5c_1v1_ykb} Passing the search_id and search_rank parameter increments the article view count and records an entry for the article in the Knowledge Use \[kb_use\] table. You can also verify incremented view counts in Knowledge Base \[kb_view2\] page. Data type: String |
| search_rank | Optional unless using search_id. Article [search rank](https://www.servicenow.com/docs/access?context=c_DocumentScoring&version=yokohama&pubname=yokohama-platform-administration&ft:locale=en-US) by click-rate that you can retrieve using one of the following APIs that returns the articles.rank element: * [Knowledge Management - GET /knowledge/articles](https://www.servicenow.com/docs/TjVdPpBJVWl33nk2jvn0Lw#knowledge-GET-articles "Returns a list of knowledge base (KB) articles which can be searched and filtered using various parameters.") * [Knowledge Management - GET /knowledge/articles/featured](https://www.servicenow.com/docs/TjVdPpBJVWl33nk2jvn0Lw#knowledge-GET-articles-featured "Returns a list of the most-viewed knowledge articles and featured knowledge articles.") * [Knowledge Management - GET knowledge/articles/most_viewed](https://www.servicenow.com/docs/TjVdPpBJVWl33nk2jvn0Lw#knowledge-GET-articles-most-viewed "Returns a list of knowledge articles prioritized by most-viewed.") {#knowledge-GET-articles-id__ul_bhl_zt1_ykb} Data type: Number |
| update_view | Update view count and record an entry for the article in the Knowledge Use \[kb_use\] table. True whether present as a standalone parameter or set to true. Note: If you pass update_view with search_id and search_rank, update_view is ignored because the view count will already be incremented. Data type: Boolean that is always handled as true when passed whether set to <kbd class="ph userinput">"true"</kbd>, <kbd class="ph userinput">"false"</kbd>, or not set at all. |
[Table 20. Query parameters]

{#knowledge-GET-articles-id__entry__20}

| Name | Description |
|-|-|
| None |   |
[Table 21. Request body parameters (XML or JSON)]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#knowledge-GET-articles-id__entry__24}{#knowledge-GET-articles-id__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 22. Request headers]

{#knowledge-GET-articles-id__entry__28}

| Header | Description |
|-|-|
| None |   |
[Table 23. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#knowledge-GET-articles-id__entry__32}{#knowledge-GET-articles-id__entry-200-status-code}{#knowledge-GET-articles-id__entry-401-status-code}{#knowledge-GET-articles-id__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. |
[Table 24. Status codes]

### Response body parameters (JSON or XML)

{#knowledge-GET-articles-id__entry__40}

| Name | Description |
|-|-|
| attachments | Provides attachment details for each instance if attachment exists. Only displays if `display_attachments = true`. Data type: Array of Objects "attachments": [ { "file_name": "String", "size_bytes": "String", "state": "String", "sys_id": "String" } ] |
| attachments.file_name | File name of attachment. Data type: String |
| attachments.size_bytes | File size. Data type: String Unit: Bytes |
| attachments.state | State. Possible values: * available * available_conditionally * not_available * pending {#knowledge-GET-articles-id__ul_ipc_gc3_3mb} Data type: String |
| attachments.sys_id | Sys_id of the attachment. Data type: String |
| content | Entire HTML content of the article. Data type: String |
| display_attachments | Flag that indicates whether the display_attachments flag is active for that article. Attachments are returned only if display_attachments is true (active) in the knowledge article record. * true: display_attachments is active. * false: display_attachments is inactive. {#knowledge-GET-articles-id__ul_ftq_lws_xkb} Data type: Boolean |
| embedded_content | Lists each attachment containing embedded content by sys_id and includes relevant attachment information. Only displays if `display_attachments = true`. Data type: Array of Objects "attachments": [ { "file_name": "String", "size_bytes": "String", "state": "String", "sys_id": "String" } ] |
| embedded_content.file_name | File name of the attachment. Data type: String |
| embedded_content.size_bytes | Size of the attachment. Data type: String Unit: Bytes |
| embedded_content.state | State of the attachment. Possible values: * available * available_conditionally * not_available * pending {#knowledge-GET-articles-id__ul_zd1_zvv_mmb} Data type: String |
| embedded_content.sys_id | Sys_id of the attachment. Data type: String |
| fields | Values of requested fields (if any). Data type: Object "fields": { "<field_name>": {Object} } |
| fields.\<field_name\> | Lists each field requested using the fields parameter, if any. Data type: Object "<field_name>": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } |
| fields.\<field_name\>.display_value | Display value of the requested field. Data type: String |
| fields.\<field_name\>.label | Label representing the requested field. For example, Knowledge. Data type: String |
| fields.\<field_name\>.name | Name of the requested field. Matches \<field_name\>. Data type: String |
| fields.\<field_name\>.type | Data type of requested field. Data type: String |
| fields.\<field_name\>.value | Value of the requested field. Data type: String |
| language | Two-letter ISO 639-1 language code for the current article (if translation is available). Data type: String |
| languages | For each translated version of a knowledge article (if translated): "languages": [ { "label": "String", "language": "String", "sys_id": "String" } ] Data type: Array |
| languages.label | String representation for language. Data type: String |
| languages.language | Two-letter ISO 639-1 code language. Data type: String |
| languages.sys_id | Unique identifier for translated version of knowledge article. Data type: String |
| number | Article number. Data type: String |
| short_description | Short description or title of the knowledge article. Data type: String |
| sys_id | Knowledge article sys_id from the Knowledge \[kb_knowledge\] table. Data type: String |
| template | Flag that indicates whether a returned article is a template. Possible values: * true: Article is a template. * false: Article is not a template. {#knowledge-GET-articles-id__ul_e3d_gws_xkb} Data type: Boolean |
| template_table | Name of template table, only returns if knowledge article is a template. Data type: String |
[ ]

### cURL request

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles/0b48fd75474321009db4b5b08b9a71c2?search_id=spam&search_rank=26.426" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

    {
      "result": {
        "content": "<p><span style=\"font-size: 18pt;\"><strong>How to Deal with Spam</strong></span></p>\r\n<p>Spam has increasingly become a problem on the Internet. While every Internet user receives some spam, email  addresses posted to web sites or in newsgroups and chat rooms attract the most spam.</p>\r\n<p>To reduce the amount of spam you receive:</p>\r\n<p>
        "template": false,
        "number": "KB0000011",
        "sys_id": "0b48fd75474321009db4b5b08b9a71c2",
        "short_description": "How to Deal with Spam",
        "display_attachments": true,
        "attachments": [
          {
            "sys_id": "dc27ae18294f4010f877796e707869c8",
            "file_name": "image.jpg",
            "size_bytes": "66792",
            "state": "available_conditionally"
          },
          {
            "sys_id": "fedf5614294f4010f877796e70786956",
            "file_name": "attachment.txt",
            "size_bytes": "75",
            "state": "available_conditionally"
          }
        ],
        "embedded_content": []
      }
    }

### Sample cURL request (update_view)

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/KB0000020?update_view=' \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

    {
      "result": {
        "content": "<p> </p>\r\n<p> </p>\r\n<p><strong><span style=\"font-size: 18pt;\">Should I upgrade to Windows 8.x?</span></strong></p>\r\n<p>Windows 8.x is designed for using touch, mouse, and keyboard together, on hardware ranging from touch-enabled tablets and laptops to PCs and all-in-one computers...(intentionally truncated)</p>",
        "template": false,
        "number": "KB0000020",
        "sys_id": "9e528db1474321009db4b5b08b9a71a6",
        "short_description": "Windows: Should I upgrade to Windows 8.x?\t\t",
        "display_attachments": true,
        "attachments": [],
        "embedded_content": []
      }
    }

## Knowledge Management - GET knowledge/articles/most_viewed {#ariaid-title6}

Returns a list of knowledge articles prioritized by most-viewed.

### URL format {#knowledge-GET-articles-most-viewed__section_apz_541_bmb}

Versioned URL:
/api/sn_km_api/{api_version}/knowledge/articles/most_viewed

Default URL:
/api/sn_km_api/knowledge/articles/most_viewed  
Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/VV5d3pcHRv4pFxM~yEJQZA "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/cpRBis~pwSIJPZVsP8Hkxw "The scripted REST API feature allows application developers to build custom web service APIs.").

### Supported request parameters

{#knowledge-GET-articles-most-viewed__entry__2}{#knowledge-GET-articles-most-viewed__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 25. Path parameters]

{#knowledge-GET-articles-most-viewed__entry__6}{#knowledge-GET-articles-most-viewed__km-api-parm-fields}{#knowledge-GET-articles-most-viewed__km-api-parm-kb}{#knowledge-GET-articles-most-viewed__km-api-parm-lang}{#knowledge-GET-articles-most-viewed__km-api-parm-limit}{#knowledge-GET-articles-most-viewed__km-api-parm-off}

| Name | Description |
|-|-|
| fields | Comma-separated list of fields from the Knowledge \[kb_knowledge\] table to show details in results. Data type: String Default: None |
| kb | Comma-separated list of knowledge base sys_ids from the Knowledge Bases \[kb_knowledge_base\] table to restrict results to. Data type: String |
| language | List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. Data type: String Default: User's session language or en |
| limit | Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the offset parameter to paginate record retrieval. Data type: Number Default: 30 |
| offset | Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time this endpoint is called, offset is set to "0". To page through all available records, use `offset=offset+limit` until the end of the all records is reached. Data type: Number Default: 0 |
[Table 26. Query parameters]

{#knowledge-GET-articles-most-viewed__entry__18}

| Name | Description |
|-|-|
| None |   |
[Table 27. Request body parameters (XML or JSON)]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#knowledge-GET-articles-most-viewed__entry__22}{#knowledge-GET-articles-most-viewed__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 28. Request headers]

{#knowledge-GET-articles-most-viewed__entry__26}

| Header | Description |
|-|-|
| None |   |
[Table 29. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://www.servicenow.com/docs/aXidvjgEVmS~V~ZL0h85lQ "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#knowledge-GET-articles-most-viewed__entry__30}{#knowledge-GET-articles-most-viewed__entry-200-status-code}{#knowledge-GET-articles-most-viewed__entry-401-status-code}{#knowledge-GET-articles-most-viewed__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 500 | Internal server error. An unexpected error occurred while processing the request. |
[Table 30. Status codes]

### Response body parameters (JSON or XML)

{#knowledge-GET-articles-most-viewed__entry__38}{#knowledge-GET-articles-most-viewed__km-resp-fields}{#knowledge-GET-articles-most-viewed__km-resp-fields_fieldname}{#knowledge-GET-articles-most-viewed__km-resp-fieldName-display}{#knowledge-GET-articles-most-viewed__km-resp-fieldName-label}{#knowledge-GET-articles-most-viewed__km-resp-fieldName-name}{#knowledge-GET-articles-most-viewed__km-resp-fieldName-type}{#knowledge-GET-articles-most-viewed__km-resp-fields-fieldName-val}{#knowledge-GET-articles-most-viewed__km_kb_id}{#knowledge-GET-articles-most-viewed__km_kb_sdesc}

| Name | Description |
|-|-|
| articles | List of articles returned in response. Data type: Array [ { "fields": {Object}, "id": "String", "link": "String", "number": "String", "rank": Number, "score": Float, "snippet": "String", "title": "String" } ] |
| articles.fields | Values of requested fields (if any). Data type: Object "fields": { "<field_name>": {Object} } |
| articles.fields.\<field_name\> | Lists each field requested using the fields parameter, if any. Data type: Object "<field_name>": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } |
| articles.fields.\<field_name\>.display_value | Display value of the requested field. Data type: String |
| articles.fields.\<field_name\>.label | Label representing the requested field. For example, Knowledge. Data type: String |
| articles.fields.\<field_name\>.name | Name of the requested field. Matches \<field_name\>. Data type: String |
| articles.fields.\<field_name\>.type | Data type of requested field. Data type: String |
| articles.fields.\<field_name\>.value | Value of the requested field. Data type: String |
| articles.id | Knowledge article sys_id from the Knowledge \[kb_knowledge\] table. Data type: String |
| articles.link | Link to the article. Data type: String |
| articles.number | Knowledge article number. Data type: String |
| articles.rank | Search rank of article specific to this search. Data type: Float |
| articles.score | Relevancy score, results sorted in descending order by score. Data type: String |
| articles.snippet | Text showing a small portion of the knowledge article. Data type: String |
| articles.title | Short description or title of the knowledge article. Data type: String |
| meta | Meta information of the results and request parameters. Data type: Object "meta": { "count": Number, "end": Number, "fields": "String", "filter": "String", "kb": "String", "language": "String", "query": "String", "start": Number, "status": {Object}, "ts_query_id": "String" } |
| meta.count | Number of available KB articles. Data type: Number |
| meta.end | Ending index of the result set. Data type: Number |
| meta.fields | Fields in the article. Data type: String |
| meta.filter | Filter used to acquire the data. Data type: String |
| meta.kb | List of knowledge base article sys_ids. Data type: String |
| meta.language | List of comma-separated languages of the KB articles that were requested. Data type: String |
| meta.query | Specified request query. Data type: String |
| meta.start | Starting index of result set. Data type: Number |
| meta.status | HTTP status of the call. Data type: String |
| meta.ts_query_id | Sys_id of the query. Data type: String |
[ ]

### cURL request

    curl "https://instance.servicenow.com/api/sn_km_api/knowledge/articles/most_viewed?limit=5" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

    {
      "result": {
        "meta": {
          "start": 0,
          "end": 5,
          "fields": "",
          "query": "",
          "filter": "workflow_state=published^valid_to>=javascript:gs.beginningOfToday()^active=true^sys_class_name!=kb_knowledge_block^sys_view_count>0^ORDERBYDESCsys_view_count^ORDERBYshort_description",
          "kb": "",
          "count": 2,
          "status": {
            "code": 200
          },
          "language": "en"
        },
        "articles": [
          {
            "link": "?id=kb_article_view&sys_kb_id=0b48fd75474321009db4b5b08b9a71c2",
            "id": "kb_knowledge:0b48fd75474321009db4b5b08b9a71c2",
            "title": "How to Deal with Spam",
            "snippet": "How to Deal with Spam Spam has increasingly become a problem on the Internet. While every Internet user receives some spam, email addresses posted to web sites or in newsgroups and chat rooms attract the most spam. To reduce the amount of spam you receive: Don't reply to spam Be careful releasing your email address, and know how it will be used ",
            "score": 7,
            "tags": [],
            "number": "KB0000011"
          },
          {
            "link": "?id=kb_article_view&sys_kb_id=c85cd2519f77230088aebde8132e70c2",
            "id": "kb_knowledge:c85cd2519f77230088aebde8132e70c2",
            "title": "Microsoft Outlook Issues",
            "snippet": "Microsoft Outlook Issues This article explains how to use automatic replies in Outlook 2010 for Exchange accounts. Setting Up Automatic Replies Click the File tab. Click Automatic Replies. Select Send automatic replies. If desired, select the Only send during this time range check box to schedule when your out of office replies are active. If yo",
            "score": 6,
            "tags": [],
            "number": "KB99999999"
          }
        ]
      }
    }


