younifyd
Menu

Search Articles

Search for articles

GET/articles/search

Use it in a workflow

  1. Add a step and choose the Intercom connector.
  2. Pick the Search Articles action (under Articles).
  3. Fill in the fields below, then reference the result from later steps as {{searchArticles.response.data}}.

Request

Query parameters

phrasestring

The phrase within your articles to search for.

statestring

The state of the Articles returned. One of `published`, `draft` or `all`.

help_center_idinteger

The ID of the Help Center to search in.

highlightboolean

Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.

Headers

Intercom-Versionstring

Intercom API version.</br>By default, it's equal to the version set in the app package.

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Response

Returns 200 with an object. Read it in later steps with {{searchArticles.response.data.<field>}}.

typestring

The type of the object - `list`.

One oflist

total_countinteger

The total number of Articles matching the search query

dataobject

An object containing the results of the search.

articlesarray<object>1 fields

An array of Article objects

highlightsarray<object>3 fields

A corresponding array of highlighted Article content

pagesobject

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

typestring

the type of object `pages`.

One ofpages

pageinteger

The current page

nextobject2 fields
per_pageinteger

Number of results per page

total_pagesinteger

Total number of pages

json
{
  "type": "list",
  "total_count": 5,
  "data": {
    "articles": [
      {
        "statistics": {
          "type": "article_statistics",
          "views": 10,
          "conversions": 0,
          "reactions": 10,
          "happy_reaction_percentage": 40,
          "neutral_reaction_percentage": 40,
          "sad_reaction_percentage": 0,
          "fin_involvements": 10,
          "fin_resolutions": 8,
          "fin_resolution_rate": 80
        }
      }
    ],
    "highlights": [
      {
        "article_id": "123",
        "highlighted_title": [
          {
            "type": "The highlight is ",
            "text": "my query"
          }
        ],
        "highlighted_summary": [
          [
            {
              "type": null,
              "text": null
            }
          ]
        ]
      }
    ]
  },
  "pages": {
    "type": "pages",
    "page": 1,
    "next": {
      "per_page": 2,
      "starting_after": "your-cursor-from-response"
    },
    "per_page": 2,
    "total_pages": 13
  }
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.