Search help center articles
curl --request GET \
--url https://api.gleap.io/v3/shared/helpcenter/searchimport requests
url = "https://api.gleap.io/v3/shared/helpcenter/search"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.gleap.io/v3/shared/helpcenter/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gleap.io/v3/shared/helpcenter/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gleap.io/v3/shared/helpcenter/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gleap.io/v3/shared/helpcenter/search")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/shared/helpcenter/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"domainRedirect": "<unknown>",
"redirectUrl": "<unknown>",
"session": {
"gleapHash": "<unknown>",
"gleapId": "<unknown>",
"userName": "<unknown>",
"userEmail": "<unknown>",
"userId": "<unknown>"
},
"project": {
"defaultDomain": "<string>",
"customDomain": "<unknown>",
"apiKey": "<unknown>",
"flowConfig": {
"localizationOptions": "<unknown>",
"operatorAvatarImage": "<unknown>",
"hideBranding": "<unknown>",
"backgroundColor": "<unknown>",
"headerColor": "<unknown>",
"color": "<unknown>",
"helpcenterConfig": "<unknown>"
},
"name": "<unknown>"
},
"data": "<unknown>"
}Help center
Search help center articles
Full-text search the published articles of a help center. Returns at most 30 hits, filtered to the
requested language and to the articles the current visitor session is allowed to see. Hits are returned
under data.hits, alongside the help center’s project configuration and any domainRedirect.
Authentication: the api-token header must carry the help center domain (e.g. acme-app.gleap.help or
your custom domain); a password header is required for password-protected help centers; optional
gleap-id/gleap-hash headers resolve the visitor session for audience filtering. Query parameters:
searchTerm (required), lang (defaults to en, falling back to the help center’s first configured
language), collectionId (restrict results to one collection).
GET
/
shared
/
helpcenter
/
search
Search help center articles
curl --request GET \
--url https://api.gleap.io/v3/shared/helpcenter/searchimport requests
url = "https://api.gleap.io/v3/shared/helpcenter/search"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.gleap.io/v3/shared/helpcenter/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gleap.io/v3/shared/helpcenter/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gleap.io/v3/shared/helpcenter/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gleap.io/v3/shared/helpcenter/search")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/shared/helpcenter/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"domainRedirect": "<unknown>",
"redirectUrl": "<unknown>",
"session": {
"gleapHash": "<unknown>",
"gleapId": "<unknown>",
"userName": "<unknown>",
"userEmail": "<unknown>",
"userId": "<unknown>"
},
"project": {
"defaultDomain": "<string>",
"customDomain": "<unknown>",
"apiKey": "<unknown>",
"flowConfig": {
"localizationOptions": "<unknown>",
"operatorAvatarImage": "<unknown>",
"hideBranding": "<unknown>",
"backgroundColor": "<unknown>",
"headerColor": "<unknown>",
"color": "<unknown>",
"helpcenterConfig": "<unknown>"
},
"name": "<unknown>"
},
"data": "<unknown>"
}