Get public category
curl --request GET \
--url https://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}import requests
url = "https://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}', 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://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}",
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://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}"
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://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}")
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{
"articles": [
{
"articleDescription": "<string>",
"articleFeatured": true,
"articleID": "<string>",
"articleOrder": 123,
"articleSlug": "<string>",
"articleTitle": "<string>",
"categoryID": "<string>",
"publishedAt": "2023-11-07T05:31:56Z"
}
],
"category": {
"categoryArticleCount": 123,
"categoryDescription": "<string>",
"categoryID": "<string>",
"categoryIconUrl": "<string>",
"categoryOrder": 123,
"categorySlug": "<string>",
"categoryTitle": "<string>"
},
"helpdesk": {
"helpdeskHostnames": [
"<string>"
],
"helpdeskID": "<string>",
"helpdeskLocale": "<string>",
"helpdeskName": "<string>",
"helpdeskSlug": "<string>",
"helpdeskStatus": "draft",
"helpdeskSupport": {
"chatEnabled": true,
"emailAddress": "<string>",
"websiteUrl": "<string>"
},
"helpdeskTheme": {
"colorHeaderBackground": "<string>",
"colorLoading": "<string>",
"colorPrimary": "<string>",
"faviconUrl": "<string>",
"headerTitle": "<string>",
"logoUrl": "<string>"
}
},
"siblingCategories": [
{
"categoryArticleCount": 123,
"categoryDescription": "<string>",
"categoryID": "<string>",
"categoryIconUrl": "<string>",
"categoryOrder": 123,
"categorySlug": "<string>",
"categoryTitle": "<string>"
}
]
}{
"errors": [
{
"error": "MissingHelpdeskHostnameError",
"error_code": 1106,
"message": "The X-Helpdesk-Host header is required.",
"statusCode": 400
}
]
}{
"errors": [
{
"error": "HelpdeskNotFoundError",
"error_code": 1107,
"message": "No help center answers on this address.",
"statusCode": 404
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Public
Get public category
Category page: the category, its published articles and its siblings.
The only input read from the request is :slug. The category is looked up
as the pair (resolved helpdeskID, slug) — never by slug alone, since
getting-started exists in most help centers and a global lookup would
answer with whichever tenant’s document the index reached first.
GET
/
v1
/
public
/
categories
/
{slug}
Get public category
curl --request GET \
--url https://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}import requests
url = "https://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}', 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://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}",
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://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}"
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://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugins-api.talqui.chat/helpdesk/v1/public/categories/{slug}")
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{
"articles": [
{
"articleDescription": "<string>",
"articleFeatured": true,
"articleID": "<string>",
"articleOrder": 123,
"articleSlug": "<string>",
"articleTitle": "<string>",
"categoryID": "<string>",
"publishedAt": "2023-11-07T05:31:56Z"
}
],
"category": {
"categoryArticleCount": 123,
"categoryDescription": "<string>",
"categoryID": "<string>",
"categoryIconUrl": "<string>",
"categoryOrder": 123,
"categorySlug": "<string>",
"categoryTitle": "<string>"
},
"helpdesk": {
"helpdeskHostnames": [
"<string>"
],
"helpdeskID": "<string>",
"helpdeskLocale": "<string>",
"helpdeskName": "<string>",
"helpdeskSlug": "<string>",
"helpdeskStatus": "draft",
"helpdeskSupport": {
"chatEnabled": true,
"emailAddress": "<string>",
"websiteUrl": "<string>"
},
"helpdeskTheme": {
"colorHeaderBackground": "<string>",
"colorLoading": "<string>",
"colorPrimary": "<string>",
"faviconUrl": "<string>",
"headerTitle": "<string>",
"logoUrl": "<string>"
}
},
"siblingCategories": [
{
"categoryArticleCount": 123,
"categoryDescription": "<string>",
"categoryID": "<string>",
"categoryIconUrl": "<string>",
"categoryOrder": 123,
"categorySlug": "<string>",
"categoryTitle": "<string>"
}
]
}{
"errors": [
{
"error": "MissingHelpdeskHostnameError",
"error_code": 1106,
"message": "The X-Helpdesk-Host header is required.",
"statusCode": 400
}
]
}{
"errors": [
{
"error": "HelpdeskNotFoundError",
"error_code": 1107,
"message": "No help center answers on this address.",
"statusCode": 404
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Path Parameters
Required string length:
1 - 160Pattern:
^[a-z0-9][a-z0-9-]*$⌘I