Search docs articles
Full-text search across published help-center articles, ranked by relevance. Each result carries the article plus a snippet around the match. Requires the docs:read scope.
curl -X GET "https://productlane.com/api/v2/docs/articles/search?query=" \
-H "Authorization: Bearer $PRODUCTLANE_API_KEY"Authorization
AuthorizationstringheaderrequiredBearer authentication header of the form
Bearer <token>, where<token>is your auth token.
Parameters
limitintegerquerycursorstringqueryquerystringqueryrequiredSearch terms. Matched against titles, summaries, bodies and translations, and ranked by relevance.
visibilityenum<string>queryDefaults to public. Agent and internal articles stay off your docs site; pass one of them, or all, to include them.
unlistedis the former name foragent.One of:publicagentinternalunlistedallportal_instance_idstringqueryFilter to a single portal by its id (from GET /portal/instances). Pass
__main__for the Main (Root) portal. Omit to return items across all portals.languagestringqueryBCP-47 language code. Merges the matching translation onto each row. Requires the Pro plan and the language enabled in workspace settings.
Response
Successful response
dataobject[]requiredpageobjectrequired
{
"data": [
{
"id": "string",
"created_at": "string",
"updated_at": "string",
"title": "string",
"summary": "string",
"content": "string",
"icon": "string",
"url_name": "string",
"published": true,
"visibility": "public",
"visibility_tier": "public",
"kind": "doc",
"external_url": "string",
"archived": true,
"show_on_home_page": true,
"image_url": "string",
"group_id": "string",
"parent_article_id": "string",
"order": 0,
"portal_instance_id": "string",
"snippet": "string"
}
],
"page": {
"cursor": "string",
"has_more": true,
"limit": 0
}
}