Add "order" key to article-API | Community
Skip to main content
Submitted

Add "order" key to article-API

Related products:Integrations, API & Custom Actions
  • May 22, 2024
  • 4 replies
  • 63 views

When you pulling all articles, you are loosing the order they have within a certain (parent) section.

https://developers.intercom.com/docs/references/rest-api/api.intercom.io/Articles/listArticles/

 

 

When you pull sections or collections, it is exporting the order (by exporting the order-value).

See API for collections: https://developers.intercom.com/docs/references/rest-api/api.intercom.io/Help-Center/collection/
(there is a misspelling in this one, it says “… The order of the section in relation to others sections within a collection. ...” )

API for sections: https://developers.intercom.com/docs/references/2.7/rest-api/api.intercom.io/Help-Center/listAllSections/

 

 

Can you please implement the order-key for articles (in the webinterface it is possible to order them, but its not reflected in the exported data via API)

4 replies

Jennifer K
Intercom Team
Forum|alt.badge.img+3
  • Intercom Team
  • June 6, 2024

Hi @Michael Kern 

Jennifer here from Intercom

Thank you for this suggestion, as input from our customers is really important when ideating new features and refining current solutions. 🙏


Whenever we do release new features, we'll announce them on the Product Changes page, so I'd recommend keeping an eye here. That being said, I'll let the team know again that you'd really like this feature! 💡


Jennifer K
Intercom Team
Forum|alt.badge.img+3
  • Intercom Team
  • June 6, 2024
NewDiscussion ongoing

  • New Participant
  • July 30, 2026

+1 — still true in v2.16. `collection` returns an `order` integer, `article` doesn't, and there's no reorder endpoint.

We render our own in-app Help Center from the Articles API. Our support team curates the order in the Intercom UI, but we can't read it back, so we fall back to created_at — an order nobody chose.

Intercom already stores the value for the UI's drag-and-drop. Just exposing `order` on the article object in GET responses would solve it.


  • New Participant
  • July 30, 2026

Following up after raising this with support. They said the team weighs complexity, impact, reach and roadmap alignment rather than votes alone, so here's this one against those.

 

Complexity: the value already exists. Drag and drop in the admin persists it, and you already return it as "order" on the collection object. Putting the same field on the article object in the GET responses is additive and read-only, so nothing breaks for existing consumers. Reading it is all we need.

 

Impact: we've built our own help centre in our product on the Articles API and turned the hosted Help Center off. Everything else works well. This one gap means the curation our support team does in Intercom is discarded and we fall back to created_at. There's no partial workaround for it.

 

Reach: anyone using the Articles API to render help content outside the hosted Help Center, which is a use case you actively promote. Right now the order your own admin encourages people to curate is the one thing they can't read back.

 

Roadmap alignment: 2.16 added drafts, versions, scheduled publishing, body_markdown and redirects, all of it making Articles more usable as a content source. Ordering is the obvious remaining hole in that.

 

There's precedent for low-vote API gaps getting closed too. exclude_from_article_suggestions shipped in 2.16, and the idea asking for it (12693) had one vote, no replies, and still shows as Submitted. Someone made this same request on idea 12891 three weeks ago as well.

 

Worth noting this was moved to Discussion ongoing in 2024 and has since reverted to Submitted, so the status understates where it got to.