Where is the Knowledge Base API Documentation in HubSpot?

Service Hub Knowledge Base Tool
, ,
21

Upvoted. This is kind of crucial to my use case and assumed this would be available on a professional account - UI data should be accessible over API.
@TitiCuisset Could you chat with your team and request an ETA on this being implemented, I think it will add alot of value to the service platform.

22

Hi @Bodyment

Thank you for reaching out.

The Team has given an update in the Ideas thread here. I recommend subscribing to the board (Options > Subscribe) to get notified for any update/change of status.

Thank you

Best

Tiphaine

23

Hi!
seems to have found it :smiley: Not documented. No warranty at all.
missing API in two steps:

  1. get a list of knowledge base article IDs
  2. get the contents of each id

But how to get all the content if this search API asks us for a term? An empty term is not allowed!
Tada! term=a_b_c_d_e_f_g_h_i_j_k_l_m_n_o_p_q_r_s_t_u_v_w_x_y_z

https://api.hubapi.com/contentsearch/v2/search?type=KNOWLEDGE_ARTICLE&term=a_b_c_d_e_f_g_h_i_j_k_l_m_n_o_p_q_r_s_t_u_v_w_x_y_z&portalId=YOUR_PORTAL_ID&limit=999

(without limits you will need to use offset etc)

We have 11 articles and using this nice term we are getting them all‌‌ =). Please make sure you are also getting the correct number of knowledge base articles, I mean total in the 2nd line of the JSON.

So you will get JSON like

{
 "total": 11,
 "offset": 0,
 "limit": 999,
 "results": [
 {
 "id": 85372448791,
 "score": 20.023497,
 "type": "KNOWLEDGE_ARTICLE",
<....>

Now we have all ID like 85372448791

Getting content:

https://api.hubapi.com/cms/v3/site-search/indexed-data/85372448791?type=KNOWLEDGE_ARTICLE

and you will get JSON with all data:

"html_all_nested.en": {
"name": "html_all_nested.en",
"value": "Be at least 99 years old",
"values": [
"Be at least 99 years old",
<....>
24

This answre doesn’t provide you with the full knowledge base article, just snippets of it.

25

Thank you!

26

4 years later, still no API. We stopped holding our breath and are just moving service away from hubspot. The service desk and knowledgebase products have been largely ignored for the last few years.

27

Hi @arlogilbert,
I understand how frustrating it can be to wait for an idea to turn into a feature.
I’m sorry to hear about your experience regarding this.
Please know that I have shared internally your valuable feedback to bring visibility to this.
I have also reached out to your Customer Success who will be in contact with you about this.
At the moment, there is no Knowledge Base API indeed.
Our Product Team keeps a close eye on the Ideas forum and this idea is still on their radar.
In the meanwhile, please let me know if there is anything else I can help you with?
I would be delighted to help you.
Thank you and have a good day!
Best,
Bérangère