Salesforce Knowledge Developer Guide
jSummer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Archive the Primary Version of an Article
Assign a Task Related to a Primary Article
Assign a Task Related to a Translation
Delete a Primary Version of an Article
Delete a Translated Version of an Article
Edit an Online Version of a Primary Article
Get a List of Salesforce Site and Experience Cloud Site URLs for an Online Article
Publish the Primary Version of an Article
Restore an Archived Version of an Article
Retrieve Article Metadata
Get Knowledge Language Settings
Retrieve a Version of an Article
Search for Metadata Elements of a Primary 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 Primary 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
Manage Knowledge with REST APIs
REST APIs provide programmatic access to many actions you can perform on your Knowledge
base, an article, and its translations.
-
Archive the Primary Version of an Article
Archives the primary version of an article. The actions are defined by the field change you request on the resource. To archive the primary version, use "publishStatus":"Archived". To schedule a date for archiving, use "archiveScheduleDate" : <date>. -
Assign a Task Related to a Primary Article
Assigns a task to a user for a primary article, including due date and instructions. The actions are defined by the field change you request on the resource. -
Assign a Task Related to a Translation
Assigns a task to a user for a translated article, including due date and instructions. The actions are defined by the field change you request on the resource. -
Delete a Primary Version of an Article
Deletes the primary version of an article. -
Delete a Translated Version of an Article
Deletes a translated version of an article. -
Edit an Online Version of a Primary Article
Creates a draft copy of the online version of a primary article. This does not unpublish the online version. -
Get a List of Salesforce Site and Experience Cloud Site URLs for an Online Article
Returns a list of article URLs in Salesforce Sites, Experience Cloud sites, or both. Article URLs from Salesforce Sites are returned if the article is visible in a public knowledge base. Article URLs from Experience Cloud sites are returned if the article is visible to partners or customers. This API creates the URLs for the Insert URL into Email Lightning action. -
Publish the Primary Version of an Article
Publishes the primary version of an article. -
Restore an Archived Version of an Article
Restores an archived version of the article. If versionNumber isn’t specified, restores the latest version of the archived article. -
Retrieve Article Metadata
Retrieves the metadata of an article. -
Get Knowledge Language Settings
Gets the existing Knowledge language settings, including the default knowledge language and a list of supported Knowledge language information. This resource can be used in API version 31.0 and later. -
Retrieve a Version of an Article
Retrieves the version ID of an article. -
Search for Metadata Elements of a Primary Version
Searches for metadata elements of the online primary version of an article. -
Search for Metadata Elements of a Translated Version
Searches for metadata elements of a translated version of an article. -
Set a Translated Article Version to Complete
Sets a translated article version to complete. -
Set a Translated Article Version to Incomplete
Sets a translated article version to incomplete. -
Submit an Article for Translation
Submits an article for translation for multiple languages and blocks translations for inactive languages. -
Unpublish the Primary Version of an Article
Unpublishes the online primary version of an article when there isn’t an existing draft article. -
Unpublish the Online Version of a Translated Article
Unpublishes the online version of a translated article. -
Parameterized Search
Executes a simple REST search using parameters instead of a SOSL clause. Indicate parameters in the URI with the GET method. Or, use the POST method to create complex searches in a request body. -
Search
Executes the specified SOSL search. The search string must be URL-encoded. -
Search Scope and Order
Returns an ordered list of objects in the default global search scope of a logged-in user. Global search keeps track of which objects the user interacts with and how often, and arranges the search results accordingly. Objects used most frequently appear at the top of the list. -
Search Result Layouts
Returns search result layout information for the objects in the query string. For each object, this call returns the list of fields displayed on the search results page as columns, the number of rows displayed on the first page, and the label used on the search results page. -
Search for Records Suggested by Autocomplete and Instant Results
Returns a list of suggested records whose names match the user’s search string. The suggestions resource provides autocomplete results and instant results for users to navigate directly to likely relevant records, before performing a full search. This resource is available in REST API version 32.0 and later. -
Search Suggested Article Title Matches
Returns a list of Salesforce Knowledge article titles that match the user’s search query string. Provides a shortcut to navigate directly to likely relevant articles before the user performs a search. This resource is available in REST API version 30.0 and later. -
Search Suggested Queries
Returns a list of suggested searches based on the user’s query string text matching searches that other users have performed in Salesforce Knowledge. Provides a way to improve search effectiveness, before the user performs a search. This resource is available in REST API version 30.0 and later.