[Cotlet](https://cotlet.dev/index.md) · [Integrations](https://cotlet.dev/integrations.md) · [How it works](https://cotlet.dev/how-it-works.md) · [Use cases](https://cotlet.dev/use-cases.md) · [Security](https://cotlet.dev/security.md) · [For developers](https://cotlet.dev/for-developers.md) · [For automation agencies](https://cotlet.dev/for-agencies.md) · [Blog](https://cotlet.dev/blog.md) · [API docs](https://cotlet.dev/docs.md) · [Help center](https://cotlet.dev/help.md) · [Changelog](https://cotlet.dev/changelog.md) · [Contact](https://cotlet.dev/contact.md) · [Pricing](https://cotlet.dev/pricing.md) · [Sign up](https://cotlet.dev/signup)

# Search Docs articles

> Docs articles matching a search, across your Docs sites. Inputs, cURL, Python and Node.js examples and an example response.

Source: https://cotlet.dev/docs/api/help-scout/search_docs_articles

Docs sections: [Get started](https://cotlet.dev/docs.md) · [REST API](https://cotlet.dev/docs/api.md) · [MCP](https://cotlet.dev/docs/mcp.md) · [SDKs & CLI](https://cotlet.dev/docs/sdks.md) · [Integrations](https://cotlet.dev/docs/integrations.md)

Docs articles matching a search, across your Docs sites.

Help Scout API: https://cotlet.dev/docs/api/help-scout.md

`GET https://cotlet.dev/api/v1/help-scout/docs-articles/search`

Access: read.

Searches the articles of your Docs sites the way the Docs results in Help Scout search do and returns each hit with its collection, status and whether an unpublished draft exists. Published and not published articles both appear, so you can find a draft that someone else is editing.

## Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Search text. |
| `status` | enum | no | all, published or notpublished. Default: all. |
| `limit` | integer | no | 1 to 50. Default: 20. |

## Request

**cURL**

```bash
curl "https://cotlet.dev/api/v1/help-scout/docs-articles/search?query=query" \
  -H "Authorization: Bearer $COTLET_API_KEY"
```

**Python**

```python
result = client.call("help-scout", "search_docs_articles", {"query":"query"})
```

**Node.js**

```js
const result = await cotlet.call('help-scout', 'search_docs_articles', {"query":"query"});
```

**CLI**

```bash
cotlet call help-scout search_docs_articles --data '{"query":"query"}'
```

## Example response

```json
{
  "query": "Reports",
  "articles": [
    {
      "article_id": "6628f1a2b5d30",
      "name": "Export conversation data",
      "collection": "Using Help Scout",
      "status": "published",
      "has_draft": false,
      "url": "https://docs.example.com/article/12-export-conversation-data"
    },
    {
      "article_id": "6628f1a2b5d41",
      "name": "Reports API overview",
      "collection": "Developers",
      "status": "published",
      "has_draft": true,
      "url": "https://docs.example.com/article/19-reports-api-overview"
    }
  ]
}
```

Previous: [List tags](https://cotlet.dev/docs/api/help-scout/list_tags.md)
Next: [Get Docs article](https://cotlet.dev/docs/api/help-scout/get_docs_article.md)

---

Give your AI agents your signed-in browser.

**Product:** [Integrations](https://cotlet.dev/integrations.md) · [Use cases](https://cotlet.dev/use-cases.md) · [How it works](https://cotlet.dev/how-it-works.md) · [Pricing](https://cotlet.dev/pricing.md) · [Security](https://cotlet.dev/security.md)

**Resources:** [Blog](https://cotlet.dev/blog.md) · [API docs](https://cotlet.dev/docs.md) · [Help center](https://cotlet.dev/help.md) · [Changelog](https://cotlet.dev/changelog.md) · [GitHub](https://github.com/cotletdev/cotlet)

**Solutions:** [For developers](https://cotlet.dev/for-developers.md) · [For automation agencies](https://cotlet.dev/for-agencies.md)

**Company:** [About](https://cotlet.dev/about.md) · [AI info: company facts](https://cotlet.dev/ai-info.md) · [Contact](https://cotlet.dev/contact.md)

**Legal:** [Terms of service](https://cotlet.dev/terms) · [Privacy policy](https://cotlet.dev/privacy) · [Refund policy](https://cotlet.dev/refunds) · [Acceptable use](https://cotlet.dev/acceptable-use) · [Cookie policy](https://cotlet.dev/cookies) · [DPA](https://cotlet.dev/dpa) · [Subprocessors](https://cotlet.dev/subprocessors)

**Elsewhere:** [Status page](https://status.cotlet.dev) · [Cotlet on GitHub](https://github.com/cotletdev) · [Cotlet on X](https://x.com/cotletdev) · [Cotlet on LinkedIn](https://www.linkedin.com/company/cotletdev) · [Cotlet on Product Hunt](https://www.producthunt.com/products/cotlet) · [Cotlet on Crunchbase](https://www.crunchbase.com/organization/cotlet) · [Cotlet on SaaSHub](https://www.saashub.com/cotlet)

Cotlet is an independent service. It is not affiliated with, endorsed by or sponsored by any of the products listed on this site. Product names are trademarks of their respective owners.

## For AI agents: sign your user up

Is your user asking you to sign them up for Cotlet? You can do it for them, no account or key needed.

1. Read the fields and their allowed values: GET https://cotlet.dev/api/v1/access-requests
2. Ask the user for each value: email, apps, what you will do with them. If they leave the password to you, generate a strong one and show it to them.
3. Show the user what you will send, then POST it as JSON to https://cotlet.dev/api/v1/access-requests.

One call creates the account and sends the access request; we email the user when access is granted.