> ## Documentation Index > Fetch the complete documentation index at: https://deepline.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Intercom Search Articles: Inputs, Cost & CLI Example > Search for articles. Intercom Intercom Search Articles docs include request fields, response shape, pricing notes, and Deepline CLI examples. ## Run in Enrichment Spreadsheet Use this function as a column step in `deepline enrich`. ```bash theme={null} deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=intercom_search_articles:{}' --json ``` Map payload values to spreadsheet columns with `{{column_name}}` placeholders. ## Input Schema | Name | Type | Required | Default | Description | | ------------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | | `payload.phrase` | `string` | No | | The phrase within your articles to search for. | | `payload.state` | `string` | No | | The state of the Articles returned. One of `published`, `draft` or `all`. | | `payload.help_center_id` | `integer` | No | | The ID of the Help Center to search in. | | `payload.highlight` | `boolean` | No | | Return a highlighted version of the matching content within your articles. Refer to the response schema for more details. |
Show raw input schema ### Input JSON Schema ```json theme={null} { "type": "object", "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", "properties": { "phrase": { "type": "string", "description": "The phrase within your articles to search for." }, "state": { "type": "string", "description": "The state of the Articles returned. One of `published`, `draft` or `all`." }, "help_center_id": { "type": "integer", "description": "The ID of the Help Center to search in." }, "highlight": { "type": "boolean", "description": "Return a highlighted version of the matching content within your articles. Refer to the response schema for more details." } }, "required": [], "additionalProperties": false } ```
## Output Schema | Name | Type | Required | Default | Description | | ------------- | -------- | -------- | ------- | ---------------------------------------------- | | `result.data` | `object` | Yes | | The results of an Article search | | `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema ### Output JSON Schema ```json theme={null} { "type": "object", "description": "Standard tool result payload.", "properties": { "data": { "type": "object", "description": "The results of an Article search", "properties": { "type": { "type": "string", "description": "The type of the object - `list`.", "enum": [ "list" ] }, "total_count": { "type": "integer", "description": "The total number of Articles matching the search query" }, "data": { "type": "object", "description": "An object containing the results of the search.", "properties": { "articles": { "type": "array", "description": "An array of Article objects", "items": { "type": "object", "description": "The data returned about your articles when you list them.", "properties": { "type": { "type": "string", "description": "The type of object - `article`.", "default": "article", "enum": [ "article" ] }, "id": { "type": "string", "description": "The unique identifier for the article which is given by Intercom." }, "workspace_id": { "type": "string", "description": "The id of the workspace which the article belongs to." }, "title": { "type": "string", "description": "The title of the article. For multilingual articles, this will be the title of the default language's content." }, "description": { "type": [ "string", "null" ], "description": "The description of the article. For multilingual articles, this will be the description of the default language's content." }, "body": { "type": [ "string", "null" ], "description": "The body of the article in HTML. For multilingual articles, this will be the body of the default language's content." }, "author_id": { "type": "integer", "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.", "default": "draft", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.", "format": "date-time" }, "url": { "type": [ "string", "null" ], "description": "The URL of the article. For multilingual articles, this will be the URL of the default language's content." }, "parent_id": { "type": [ "integer", "null" ], "description": "The id of the article's parent collection or section. An article without this field stands alone." }, "parent_ids": { "type": "array", "description": "The ids of the article's parent collections or sections. An article without this field stands alone.", "items": { "type": "integer" } }, "parent_type": { "type": [ "string", "null" ], "description": "The type of parent, which can either be a `collection` or `section`." }, "default_locale": { "type": "string", "description": "The default locale of the help center. This field is only returned for multilingual help centers." }, "translated_content": { "type": [ "object", "null" ], "description": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - article_translated_content.", "enum": [ null, "article_translated_content" ] }, "ar": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "bg": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "bs": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "ca": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "cs": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "da": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "de": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "el": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "en": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "es": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "et": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "fi": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "fr": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "he": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "hr": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "hu": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "id": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "it": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "ja": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "ko": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "lt": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "lv": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "mn": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "nb": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "nl": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "pl": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "pt": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "ro": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "ru": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "sl": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "sr": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "sv": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "tr": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "vi": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "pt-BR": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "zh-CN": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false }, "zh-TW": { "type": [ "object", "null" ], "description": "The Content of an Article.", "properties": { "type": { "type": [ "string", "null" ], "description": "The type of object - `article_content` .", "enum": [ null, "article_content" ] }, "title": { "type": "string", "description": "The title of the article." }, "description": { "type": "string", "description": "The description of the article." }, "body": { "type": "string", "description": "The body of the article." }, "author_id": { "type": "integer", "description": "The ID of the author of the article." }, "state": { "type": "string", "description": "Whether the article is `published` or is a `draft` .", "enum": [ "published", "draft" ] }, "created_at": { "type": "integer", "description": "The time when the article was created (seconds).", "format": "date-time" }, "updated_at": { "type": "integer", "description": "The time when the article was last updated (seconds).", "format": "date-time" }, "url": { "type": "string", "description": "The URL of the article." } }, "additionalProperties": false } }, "additionalProperties": false }, "tags": { "type": "object", "description": "A list of tags objects associated with a conversation", "properties": { "type": { "type": "string", "description": "The type of the object", "enum": [ "tag.list" ] }, "tags": { "type": "array", "description": "A list of tags objects associated with the conversation.", "items": { "type": "object", "description": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.", "properties": { "type": { "type": "string", "description": "value is \"tag\"" }, "id": { "type": "string", "description": "The id of the tag" }, "name": { "type": "string", "description": "The name of the tag" }, "applied_at": { "type": [ "integer", "null" ], "description": "The time when the tag was applied to the object. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.", "format": "date-time" }, "applied_by": { "type": [ "object", "null" ], "description": "reference to another object", "properties": { "type": { "type": "string" }, "id": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } } }, "additionalProperties": false } }, "additionalProperties": false } }, "highlights": { "type": "array", "description": "A corresponding array of highlighted Article content", "items": { "type": "object", "description": "The highlighted results of an Article search. In the examples provided my search query is always \"my query\".", "properties": { "article_id": { "type": "string", "description": "The ID of the corresponding article." }, "highlighted_title": { "type": "array", "description": "An Article title highlighted.", "items": { "type": "object", "description": "A highlighted article title.", "properties": { "type": { "type": "string", "description": "The type of text - `highlight` or `plain`.", "enum": [ "highlight", "plain" ] }, "text": { "type": "string", "description": "The text of the title." } }, "additionalProperties": false } }, "highlighted_summary": { "type": "array", "description": "An Article description and body text highlighted.", "items": { "type": "array", "description": "An array containing the highlighted summary text split into chunks of plain and highlighted text.", "items": { "type": "object", "description": "An instance of highlighted summary text.", "properties": { "type": { "type": "string", "description": "The type of text - `highlight` or `plain`.", "enum": [ "highlight", "plain" ] }, "text": { "type": "string", "description": "The text of the title." } }, "additionalProperties": false } } } }, "additionalProperties": false } } }, "additionalProperties": false }, "pages": { "type": [ "object", "null" ], "description": "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.", "properties": { "type": { "type": "string", "description": "the type of object `pages`.", "enum": [ "pages" ] }, "page": { "type": "integer", "description": "The current page" }, "next": { "type": [ "object", "null" ], "properties": { "per_page": { "type": "integer", "description": "The number of results to fetch per page." }, "starting_after": { "type": [ "string", "null" ], "description": "The cursor to use in the next request to get the next page of results." } }, "additionalProperties": false }, "per_page": { "type": "integer", "description": "Number of results per page" }, "total_pages": { "type": "integer", "description": "Total number of pages" } }, "additionalProperties": false } }, "additionalProperties": false }, "meta": { "type": "object", "description": "Additional response metadata (status, paging).", "additionalProperties": true } }, "required": [ "data" ], "additionalProperties": false } ```
## Advanced: Direct CLI Use direct execution for single payload debugging. ```bash theme={null} deepline tools execute intercom_search_articles --payload '{}' --json ``` ### CLI flags | Flag | Description | | --------------------------- | --------------------------------------------------- | | `--json` | Print machine-readable output. | | `--wait` | Wait for terminal provider status when supported. | | `--debug` | Enable wait mode with additional status/log output. | | `--wait-timeout SECONDS` | Max seconds to wait in wait mode. | | `--poll-interval SECONDS` | Polling interval in seconds during wait mode. | | `--timeout SECONDS` | Request timeout in seconds. | | `--connect-timeout SECONDS` | Connection timeout in seconds. | ## Cost * Pricing model: `fixed` (per call). * Estimated Deepline credits: `0` per pricing unit. * Provider-native pricing may still exist outside Deepline credit billing. * Billing mode: `no_bill`.