Search articles
This API runs a full-text search across the workspace’s published articles. Results are ranked by relevance, with the title weighted highest, then content, slug, category name, and keywords. Each match includes highlighted snippets showing where the search term appears.
{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Workspace subdomain.
Headers
Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.
Query Parameters
The text to search for. Matching is performed from the start of each word.
"billing"
Retrieve paginated results by specifying the desired page number. Defaulting to 1 when omitted.
Set the number of results returned in the response. Defaulting to 30 when omitted.