Knowledge Base API Documentation

SOLVE
Highlighted
Occasional Contributor

Where is it? Thanks!

1 Accepted solution

Accepted Solutions
Highlighted
HubSpot Moderator

Hi, @michelkamp and @JamesClarke.

 

Unfortunately, there are no public APIs for the knowledge base tool at this time. Knowledge base articles can currently only be created or modified in the HubSpot UI.

 

We have heard this request come up before. While I don't know of any plans to release a Knowledge Base API in the near future, I will pass this feedback to the team and share any relevant details.

In the meantime, the best way to request this feature is to upvote and comment on this Ideas Forum post with your use cases. I've already upvoted it myself.

Isaac Takushi

HubSpot Developer Support
Reply
0 Upvotes
14 Replies 14
Highlighted
Community Manager

Hey @JamesClarke 

 

Are you referring to the API documentation from HubSpot? If so, you can find it here: https://developers.hubspot.com/docs/overview

 

If this doesn't answer your question, please let me know. The more details, and information you can provide, the better the Community can assist.

 

Thank you

Sharon



¿Sabías que la Comunidad está disponible en Español?
¡Participa hoy en conversaciones en el idioma de tu preferencia,cambiando el idioma en tus configuraciones!

Did you know that the Community is available in other languages?
Join regional conversations by changing your language settings !


Reply
0 Upvotes
Highlighted
Occasional Contributor

Hi Sharon,

 

Thanks for the link, I had come across this repository but couldn't find anything relating to the Knowledge Base. This is definitely where it would live if it had been created and the thread I linked  prevously suggests that perhaps it hasn't.

 

Unless I've oerlooked something? Is there somewhere specific that you think relates to the Knowledge Base API documents here?

 

Many thanks,

James

 

 

Reply
0 Upvotes
Highlighted
Community Manager

Hey @JamesClarke 

 

I can't see anything related to the Knowledge base in the API documents- However, is not clear to me what is your goal. Could you please provide more information on what you would like to accomplish? Smiley Happy

 

Thank you

Sharon



¿Sabías que la Comunidad está disponible en Español?
¡Participa hoy en conversaciones en el idioma de tu preferencia,cambiando el idioma en tus configuraciones!

Did you know that the Community is available in other languages?
Join regional conversations by changing your language settings !


Highlighted
Occasional Contributor

Hi Sharon,

 

The knowledge base sits on a sub-domain which is not suitable for our website and so would like to create our own knowledge base page driven by use of the Knowledge Base API. 

 

From what I can gather, this exists but I can't find any documentation. 

 

Thanks,

James

Highlighted
Community Manager

Hi @JamesClarke 

 

I have been in contact with the team and they confirmed the Site Search endpoint doesn't yet document the ability to search Knowledge Base articles, but technically it's currently capable of providing Knowledge Base search results.
There is no article-specific endpoint. The Content Search API is the only way to pull the Knowledge Base article search results. So you can query kb articles but cannot interact with them it would seem. 

 

I hope this helps.

Sharon 



¿Sabías que la Comunidad está disponible en Español?
¡Participa hoy en conversaciones en el idioma de tu preferencia,cambiando el idioma en tus configuraciones!

Did you know that the Community is available in other languages?
Join regional conversations by changing your language settings !


Reply
0 Upvotes
Highlighted
Occasional Contributor

Hi Sharon,

 

Many thanks for looking into this. Is it something that's on the road map to buld out?

 

Regards,

James 

Highlighted
Regular Contributor

James, could you create an iframe to view the subdomain to enable all of the search and native functionality of the tool without redirecting?

Reply
0 Upvotes
Highlighted
Occasional Contributor

Hi,

 

Thanks for this suggestion, it is what we've been trying to do but there is some issues with this whereby the autocomplete search results are nn-responsive. 

 

Any ideas would be appreciated.

 

Thanks,

 

Reply
0 Upvotes
Highlighted
Occasional Contributor

To update this ticket, we ended up doing some messing around with iframes as we didn't want to direct the user away from our website to use the knowledge base. This is how it now looks. https://www.clothes2order.com/help-support.php

 

If more time was spent on it, it could look a bit better. 

Reply
0 Upvotes
Highlighted
New Contributor

Hi @sharonlicari , any update on the Knowledge base API documenation. ?

My goal is to create KB articles using the hubspot API

 

thanks,

michel

 

Reply
0 Upvotes
Highlighted
New Contributor

any update on this ??

Reply
0 Upvotes
Highlighted
HubSpot Moderator

Hi, @michelkamp and @JamesClarke.

 

Unfortunately, there are no public APIs for the knowledge base tool at this time. Knowledge base articles can currently only be created or modified in the HubSpot UI.

 

We have heard this request come up before. While I don't know of any plans to release a Knowledge Base API in the near future, I will pass this feedback to the team and share any relevant details.

In the meantime, the best way to request this feature is to upvote and comment on this Ideas Forum post with your use cases. I've already upvoted it myself.

Isaac Takushi

HubSpot Developer Support
Reply
0 Upvotes
Highlighted
New Contributor

It would be so awesome to be able to pull down the knowledge base content. Please can you let us know if you develop this Smiley Happy 

Reply
0 Upvotes
Highlighted
HubSpot Moderator

Thanks for posting, @FriendlyManager.

 

I agree!

 

If you haven't already, please be sure to upvote and comment on the official feature request.

Isaac Takushi

HubSpot Developer Support
Reply
0 Upvotes