Salesforce Knowledge Management Search API

openapi: 3.1.0
info:
  title: Salesforce Knowledge Management REST Articles Search API
  description: REST API for accessing and managing Salesforce Knowledge articles, categories, and knowledge base content. Enables creating, reading, updating, publishing, and archiving knowledge articles for customer self-service and agent-assisted support scenarios.
  version: 59.0.0
  termsOfService: https://www.salesforce.com/company/legal/agreements/
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Master Subscription Agreement
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v59.0
  description: Salesforce Production or Developer Edition
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance identifier
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Search
  description: Knowledge article search operations
paths:
  /support/knowledgeArticles:
    get:
      operationId: searchKnowledgeArticles
      summary: Search Knowledge Articles
      description: 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.
      tags:
      - Search
      parameters:
      - name: channel
        in: query
        required: false
        description: The channel to filter articles by
        schema:
          type: string
          enum:
          - App
          - Pkb
          - Csp
          - Prm
          - AllChannels
          default: App
      - name: categories
        in: query
        required: false
        description: Map of category group to category value for filtering
        schema:
          type: string
      - name: queryMethod
        in: query
        required: false
        description: Method used to query the articles
        schema:
          type: string
          enum:
          - AT
          - BELOW
          - ABOVE
          - ABOVE_OR_BELOW
      - name: sort
        in: query
        required: false
        description: Sort field for results
        schema:
          type: string
          enum:
          - LastPublishedDate
          - CreatedDate
          - Title
          - ViewScore
      - name: order
        in: query
        required: false
        description: Sort order
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - name: pageSize
        in: query
        required: false
        description: Number of articles per page
        schema:
          type: integer
          default: 25
      - name: pageNumber
        in: query
        required: false
        description: Page number to retrieve
        schema:
          type: integer
          default: 1
      responses:
        '200':
          description: Successfully retrieved knowledge articles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KnowledgeArticleSearchResponse'
        '400':
          description: Invalid query parameters
components:
  schemas:
    KnowledgeArticleSearchResponse:
      type: object
      properties:
        currentPageUrl:
          type: string
        nextPageUrl:
          type: string
        articles:
          type: array
          items:
            $ref: '#/components/schemas/KnowledgeArticleSummary'
    KnowledgeArticleSummary:
      type: object
      properties:
        Id:
          type: string
        KnowledgeArticleId:
          type: string
        Title:
          type: string
        UrlName:
          type: string
        PublishStatus:
          type: string
          enum:
          - Online
          - Draft
          - Archived
        Language:
          type: string
        VersionNumber:
          type: integer
        LastPublishedDate:
          type: string
          format: date-time
        CreatedDate:
          type: string
          format: date-time
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Access and manage your data
            full: Full access
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Salesforce Knowledge REST API Developer Guide
  url: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/