Search

Search

Endpoints for searching content and viewing search analytics.

Search Endpoints

Search the portal

Performs a full-text search across the portal.

This request can be sent anonymously, in which case it will only search public publications. If authenticated, it will search all publications available to the user.

Query Parameters
  • q
    string
    required

    The full-text search query. May contain supported search operators.

  • count
    integer
    default:
    10

    The maximum number of results to return. Defaults to 10. A negative number returns all results.

  • projectIds
    string

    A comma-separated list of project/publication IDs to search in.

  • lang
    string

    A four-letter language code to filter the search by language.

  • isReturnSnippets
    boolean
    default:
    false

    If true, returns highlighted snippets in the response.

Responses
GET/search
curl https://your-portal.clickhelp.co/api/v1/search \
  --header 'Authorization: Basic username:password'

[
  {
    "id": "…",
    "title": "…",
    "statusName": "…",
    "createdOn": "2026-01-23T22:10:04.180Z",
    "modifiedOn": "2026-01-23T22:10:04.180Z",
    "ownerUserName": "…",
    "assigneeUserName": "…",
    "projectId": "…",
    "fullUrl": "https://example.com",
    "smartLink": "https://example.com",
    "tocNodeId": "…",
    "ftsSnippetHtml": "…",
    "ftsTitleHtml": "…"
  }
]

The search results.