Sign in
Basic

Retrieve all articles

Changed on

Retrieve a list of articles from the knowledge base. This endpoint allows filtering and sorting articles based on creation and update timestamps, state, language, and other attributes. It supports pagination and can include additional details such as the article body and translations.

get/cms/knowledge-base/2027-03-beta/articles

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.settings.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.articles.publish)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.articles.write)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.articles.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.settings.write)

Query parameters

afterstring

A pagination cursor. Pass the value from the previous response’s paging.next.after to retrieve the next page.

archivedInDashboardboolean

Filter articles based on whether they are archived in the dashboard.

categoryIdstring[]

Filter to articles belonging to the specified category ID(s). Accepts multiple values, repeated as separate query parameters.

createdAfterstring date-time

Filter to articles created after the specified date-time. Accepts an ISO-8601 timestamp (e.g., 2026-09-20T00:00:00Z) or a plain date (e.g., 2026-09-20).

createdAtstring date-time

Filter articles to those with this exact creation timestamp. Accepts an ISO-8601 timestamp (e.g., 2026-09-20T00:00:00Z) or a plain date (e.g., 2026-09-20).

createdBeforestring date-time

Filter to articles created before the specified date-time. Accepts an ISO-8601 timestamp (e.g., 2026-09-20T00:00:00Z) or a plain date (e.g., 2026-09-20).

includeBodyboolean

A boolean indicating whether to include each article’s HTML content (the body field) in the response. Defaults to true.

includeTranslationsboolean

A boolean indicating whether to include a summary of each article’s translations (id, title, and state per language) in the response. Defaults to true.

knowledgeBaseIdstring[]

Filter to articles belonging to the specified knowledge base ID(s). Accepts multiple values, repeated as separate query parameters.

languagestring[]

Filter articles by a specific language. Accepts an ISO 639 language code (e.g., en, es), optionally with a region subtag (e.g., en-US). Accepts multiple values, repeated as separate query parameters.

limitinteger

The number of results to display per page. Default is 25, maximum is 100.

sortstring[]

Specify how to sort results. Accepts name, createdAt, or updatedAt; prefix a field with - for descending order (e.g., -createdAt). Defaults to createdAt descending (newest first).

statestring

Filter to articles in the specified state. Accepted values are DRAFT or PUBLISHED.

updatedAfterstring date-time

Filter to articles updated after the specified date-time. Accepts an ISO-8601 timestamp (e.g., 2026-09-20T00:00:00Z) or a plain date (e.g., 2026-09-20).

updatedAtstring date-time

Filter articles to those with this exact update timestamp. Accepts an ISO-8601 timestamp (e.g., 2026-09-20T00:00:00Z) or a plain date (e.g., 2026-09-20).

updatedBeforestring date-time

Filter to articles updated before the specified date-time. Accepts an ISO-8601 timestamp (e.g., 2026-09-20T00:00:00Z) or a plain date (e.g., 2026-09-20).

Response

successful operation

Example response

{
  "paging": {
    "next": {
      "after": "{ \"after\": \"Mg%3D%3D\" }",
      "link": "{ \"link\": \"https://api.hubapi.com/cms/knowledge-base/2027-03-beta/tags?after=Mg%3D%3D\" }"
    }
  }
}

Changes

  • 2027-03-beta2eff3dd6fefaRevision changes
    • ○

      the security scope cms.knowledge_base.settings.read was added to the endpoint's security scheme oauth2

    • ○

      the security scope cms.knowledge_base.settings.write was removed from the endpoint's security scheme oauth2

  • 2027-03-betaf542018e1a93Revision changes
    • ○

      the security scope cms.knowledge_base.settings.read was added to the endpoint's security scheme oauth2

    • ○

      the security scope cms.knowledge_base.settings.write was removed from the endpoint's security scheme oauth2