Salesforce Knowledge Developer Guide

Develop with Salesforce Knowledge
Salesforce Knowledge SOAP API
Salesforce Knowledge REST APIs
Manage Knowledge with REST APIs
Archive the Master Version of an Article
Assign a Task Related to a Master Article
Assign a Task Related to a Translation
Delete a Master Version of an Article
Delete a Translated Version of an Article
Edit an Online Version of a Master Article
Get a List of Site and Community URLs for an Online Article
Publish the Master Version of an Article
Restore an Archived Version of an Article
Retrieve Article Metadata
Retrieve Knowledge Language Settings
Retrieve a Version of an Article
Search for Metadata Elements of a Master Version
Search for Metadata Elements of a Translated Version
Set a Translated Article Version to Complete
Set a Translated Article Version to Incomplete
Submit an Article for Translation
Unpublish the Master Version of an Article
Unpublish the Online Version of a Translated Article
Parameterized Search
Search
Search Scope and Order
Search Result Layouts
Search for Records Suggested by Autocomplete and Instant Results
Search Suggested Article Title Matches
Search Suggested Queries
Support Knowledge with REST API
Salesforce Knowledge Metadata API
Salesforce Knowledge with SOQL and SOSL
Salesforce Knowledge, Apex, and Visualforce
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Get a List of Site and Community URLs for an Online Article

Returns a list of article URLs in sites, communities, or both. Article URLs from sites are returned if the article is visible in public knowledge base. Article URLs from communities are returned if the article is visible to partners or customers. This API creates the URLs for the Insert URL into Email Lightning action.

The org must have Lightning Knowledge enabled, and Allow users to share articles via public URLs enabled in Knowledge Settings. In addition, the API user must have read access on Knowledge.

Available in API versions 46.0 and later.

Syntax

URI
1/services/data/v46.0/knowledgeManagement/articles/siteListForOnlineArticle?articleId=articleId&language=xx_XX
Formats
JSON, XML
HTTP Method
GET
Authentication
Authorization: OAuth accesstoken
Parameters
Parameter Description
articleId Either the 15– or 18–digit version of the article version ID.
language Language for the selected article.
Input
None