{
  "opencollection": "1.0.0",
  "info": {
    "name": "Salesforce Knowledge Management REST API",
    "version": "59.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://login.salesforce.com/services/oauth2/authorize",
      "accessTokenUrl": "https://login.salesforce.com/services/oauth2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Articles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Knowledge Articles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/sobjects/KnowledgeArticle",
            "params": [
              {
                "name": "queryLocator",
                "value": "",
                "type": "query",
                "description": "Locator for paginating through large result sets"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results per page (max 100)"
              }
            ]
          },
          "docs": "Retrieves a list of knowledge articles available in the org, including their metadata, publication status, and associated article types."
        },
        {
          "info": {
            "name": "Get Knowledge Article",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/sobjects/KnowledgeArticle/:articleId",
            "params": [
              {
                "name": "articleId",
                "value": "",
                "type": "path",
                "description": "The Salesforce ID of the KnowledgeArticle record"
              }
            ]
          },
          "docs": "Retrieves details for a specific knowledge article including its current publication status, version, and metadata."
        },
        {
          "info": {
            "name": "Get Knowledge Article Detail",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/support/knowledgeArticles/:articleId",
            "params": [
              {
                "name": "articleId",
                "value": "",
                "type": "path",
                "description": "The Salesforce ID of the article"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "The channel context for the article view"
              }
            ]
          },
          "docs": "Retrieves the full content and metadata for a specific knowledge article, including all article body fields and channel visibility settings."
        },
        {
          "info": {
            "name": "Create Knowledge Article",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/sobjects/KnowledgeArticleVersion",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new knowledge article draft. The article must be published separately after creation."
        },
        {
          "info": {
            "name": "Update Knowledge Article",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/sobjects/KnowledgeArticleVersion/:versionId",
            "params": [
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "The Salesforce ID of the KnowledgeArticleVersion record"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates fields on a knowledge article version. Only draft articles can be updated; published articles must be cloned first."
        },
        {
          "info": {
            "name": "Delete Knowledge Article",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/sobjects/KnowledgeArticleVersion/:versionId",
            "params": [
              {
                "name": "versionId",
                "value": "",
                "type": "path",
                "description": "The Salesforce ID of the KnowledgeArticleVersion record"
              }
            ]
          },
          "docs": "Deletes a knowledge article version. Only draft articles can be deleted. Published articles must be archived before deletion."
        },
        {
          "info": {
            "name": "Publish Knowledge Articles",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/actions/standard/publishKnowledgeArticles",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Publishes one or more knowledge article versions, making them visible to the configured channels."
        }
      ]
    },
    {
      "info": {
        "name": "Search",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search Knowledge Articles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/support/knowledgeArticles",
            "params": [
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "The channel to filter articles by"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query",
                "description": "Map of category group to category value for filtering"
              },
              {
                "name": "queryMethod",
                "value": "",
                "type": "query",
                "description": "Method used to query the articles"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort field for results"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Sort order"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of articles per page"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number to retrieve"
              }
            ]
          },
          "docs": "Searches and retrieves knowledge articles visible to the specified channel (internal, public site, or community). Supports keyword search, filtering by article type, and category filters."
        }
      ]
    },
    {
      "info": {
        "name": "Categories",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Data Category Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/support/dataCategoryGroups",
            "params": [
              {
                "name": "sObjectName",
                "value": "",
                "type": "query",
                "description": "The SObject type to filter categories for"
              }
            ]
          },
          "docs": "Returns a list of data category groups available for categorizing knowledge articles."
        },
        {
          "info": {
            "name": "List Data Categories",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/support/dataCategoryGroups/:group/dataCategories",
            "params": [
              {
                "name": "group",
                "value": "",
                "type": "path",
                "description": "The data category group API name"
              }
            ]
          },
          "docs": "Returns the categories within a specific data category group, including the category hierarchy."
        }
      ]
    },
    {
      "info": {
        "name": "Suggestions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Suggested Articles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.salesforce.com/services/data/v59.0/support/suggestedArticles",
            "params": [
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "The channel for the suggested articles"
              },
              {
                "name": "subject",
                "value": "",
                "type": "query",
                "description": "Case subject text used for article suggestion"
              },
              {
                "name": "description",
                "value": "",
                "type": "query",
                "description": "Case description text used for article suggestion"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of suggestions to return"
              }
            ]
          },
          "docs": "Returns knowledge article suggestions based on case subject, description, or a search query. Used to surface relevant articles during case creation."
        }
      ]
    }
  ],
  "bundled": true
}