curl --request GET \
--url 'https://api-prod.usefini.com/v2/helpcenter/list/public' \
--header 'Authorization: Bearer fini_your_api_key'
const response = await fetch('https://api-prod.usefini.com/v2/helpcenter/list/public', {
method: 'GET',
headers: { Authorization: 'Bearer fini_your_api_key' }
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
import requests
response = requests.get(
"https://api-prod.usefini.com/v2/helpcenter/list/public",
headers={"Authorization": "Bearer fini_your_api_key"},
)
response.raise_for_status()
data = response.json()
[
{
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"userId": "22222222-2222-4222-8222-222222222222",
"companyId": "11111111-1111-4111-8111-111111111111",
"botId": "33333333-3333-4333-8333-333333333333",
"corsOrigin": "example-support",
"url": null,
"logo": "https://example.com/logo.png",
"appearanceSettings": {
"title": "Example Help Center",
"fontFamily": "inter",
"enabledLanguages": [
"de",
"fr"
]
},
"passwordProtected": true
}
]
Help Centers
List help centers
List the help centers owned by your workspace, including language and password-protection settings.
GET
/
v2
/
helpcenter
/
list
/
public
curl --request GET \
--url 'https://api-prod.usefini.com/v2/helpcenter/list/public' \
--header 'Authorization: Bearer fini_your_api_key'
const response = await fetch('https://api-prod.usefini.com/v2/helpcenter/list/public', {
method: 'GET',
headers: { Authorization: 'Bearer fini_your_api_key' }
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
import requests
response = requests.get(
"https://api-prod.usefini.com/v2/helpcenter/list/public",
headers={"Authorization": "Bearer fini_your_api_key"},
)
response.raise_for_status()
data = response.json()
[
{
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"userId": "22222222-2222-4222-8222-222222222222",
"companyId": "11111111-1111-4111-8111-111111111111",
"botId": "33333333-3333-4333-8333-333333333333",
"corsOrigin": "example-support",
"url": null,
"logo": "https://example.com/logo.png",
"appearanceSettings": {
"title": "Example Help Center",
"fontFamily": "inter",
"enabledLanguages": [
"de",
"fr"
]
},
"passwordProtected": true
}
]
Returns a top-level array of help centers in the API key’s workspace, newest first. This authenticated route is distinct from the anonymous
/v2/helpcenter/public route. It takes no query parameters.
passwordProtected indicates whether a shared article password is configured. Password hashes are not returned. appearanceSettings.enabledLanguages lists additional translated locales; English is the source and is not included in that list.
Headers
string
required
Bearer token containing your Fini workspace API key. Format:
Bearer fini_... The key needs read scope.Response
string
Help center ID used by analytics endpoints.
string
Agent supplying the public knowledge tree.
string
Help center subdomain/slug.
object
Optional title, colors, font, language, folder appearance, featured-article and popular-folder settings.
boolean
Whether the help center has a shared article password configured.
curl --request GET \
--url 'https://api-prod.usefini.com/v2/helpcenter/list/public' \
--header 'Authorization: Bearer fini_your_api_key'
const response = await fetch('https://api-prod.usefini.com/v2/helpcenter/list/public', {
method: 'GET',
headers: { Authorization: 'Bearer fini_your_api_key' }
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
import requests
response = requests.get(
"https://api-prod.usefini.com/v2/helpcenter/list/public",
headers={"Authorization": "Bearer fini_your_api_key"},
)
response.raise_for_status()
data = response.json()
[
{
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"userId": "22222222-2222-4222-8222-222222222222",
"companyId": "11111111-1111-4111-8111-111111111111",
"botId": "33333333-3333-4333-8333-333333333333",
"corsOrigin": "example-support",
"url": null,
"logo": "https://example.com/logo.png",
"appearanceSettings": {
"title": "Example Help Center",
"fontFamily": "inter",
"enabledLanguages": [
"de",
"fr"
]
},
"passwordProtected": true
}
]
Errors
An absent workspace identity is rejected. A workspace with no help centers returns an empty array. All requests can return 401 for an invalid or revoked key, or 403 when the required scope is missing.Was this page helpful?