USusepylon
articles

Get all articles in a knowledge base

Changed on

Returns a paginated list of articles for the specified knowledge base.

Rate limit: 120 requests per minute

get/knowledge-bases/{id}/articles

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/knowledge-bases/{id}/articles
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the knowledge base the articles are being fetched from.

Query parameters

cursorstring

The cursor to use for pagination.

limitinteger

The number of articles to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

languagestring

The language code to fetch articles in. If not provided, returns the default language.

media'all' | 'none'

Controls whether embedded media is included in article HTML. Valid values are all (default) and none. When set to none, embedded images, video, audio, and inline media are removed while descriptive text and standard links are preserved.

Response

request_idstring required

The request ID for tracking.

Example response

{
  "data": [
    {
      "tags": [
        {
          "object_type": "issue"
        }
      ],
      "visibility_config": {
        "customer_visibility_condition": {
          "subfilters": [
            {
              "field": "state",
              "operator": "equals",
              "value": "new"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • 8522e66913b4Revision changes
    • warning

      added the new not enum value to the //// response property for the response status

    • warning

      added the new time_is_in_last enum value to the //// response property for the response status

    • warning

      added the new time_is_in_next enum value to the //// response property for the response status

    • warning

      added the new time_is_not_in_last enum value to the //// response property for the response status

    • warning

      added the new time_is_not_in_next enum value to the //// response property for the response status

  • 94eafdd80c67Revision changes
    • info

      added the optional property /// to the response with the status