Forum Discussion

grant_jenkins's avatar
grant_jenkins
Iron Contributor
Jun 02, 2025

Retrieve Term Navigation Properties using REST API

I've set up a Term set in the global term store and enabled Navigation so I can add URLs for each of the Terms. Note that I'm not going to use the Term set navigation in my site - it's only there to ...
apis
developer
Matthias_Glubrecht's avatar
Matthias_Glubrecht
Icon for Microsoft rankMicrosoft
Jun 11, 2025

Have you tried accessing the customProperties or the localCustomProperties?
GET /_api/v2.1/termStore/sets('{set-id}')/terms('{term-id}')/customProperties

GET /_api/v2.1/termStore/sets('{set-id}')/terms('{term-id}')/localCustomProperties

grant_jenkins's avatar
grant_jenkins
Iron Contributor
Jun 11, 2025

Hi Matthias_Glubrecht​. Thanks for your reply, but is says customProperties and localCustomProperties don't exist - the same as when I use /properties

{"error":{"code":"itemNotFound","message":"The property 'customProperties' is null or does not exist"}}

 

Did you try this yourself and is it working?

  • Matthias_Glubrecht's avatar
    Matthias_Glubrecht
    Icon for Microsoft rankMicrosoft
    Jun 11, 2025

    No, unfortunately I didn't have the time to try it myself. Seems that I was a little bit too optimistic. Sorry for that!
    I once had the requirement to read all terms from a term set, which is in fact possible using CSOM or JSOM. I remembered that in the "@pnp/sp-dev-fx-controls-react" library they had the same requirement to display a tree of terms, and I copied their solution which mimics a JSOM call by posting the XML that JSOM would generate to the server and evaluates the returned data to extract the terms including all localCustomProperties like "_Sys_Nav_SimpleLinkUrl" and "_Sys_Nav_HoverText".
    Maybe that's the only way?

Resources