Query Catalog items & Custom Fields

Posts about the simPRO API. Help/support/how-to etc.
Forum rules
  • Check the documentation first. Before posting questions, please check the documentation to ensure it doesn't already cover what you need.
  • No spam. All automated messages, advertisements, and links to competitor websites will be deleted immediately.
  • Post in relevant sub-forums only. Messages posted in the wrong topic area will be removed and placed in the correct sub-forum by moderators.
  • Respect other users. No flaming or abusing fellow forum members. Users who continue to post inflammatory, abusive comments will be deleted from the forum after two warnings are issued by moderators.
  • Harassment. No threats or harassment of other users will be tolerated. Any instance of threatening or harassing behavior is grounds for deletion from the forums.
  • Adult content. No profanity or pornography is allowed. Posts containing adult material will be deleted.
  • Bandwidth. All images and signatures must be 500 x 500 pixels or smaller. Posts containing over-sized images and signatures will be removed.
  • Illegal content. No re-posting of copyrighted materials or other illegal content is allowed. Any posts containing illegal content or copyrighted materials will be deleted.
Post Reply
stoney123
Posts: 6
Joined: Wed Oct 16, 2024 7:26 am

Query Catalog items & Custom Fields

Post by stoney123 » Wed Oct 16, 2024 7:27 am

Hi

Is it possible to query Catalog items with a Custom field with a certain field via your API?

We have a custom field called "WEB-FRIENDLY" and we would like to find all Catalog items that have this field set to "YES".

https://developer.simprogroup.com/apido ... g/Catalogs

Thanks
SimproAPITeam
Posts: 831
Joined: Wed May 01, 2024 2:31 am

Re: Query Catalog items & Custom Fields

Post by SimproAPITeam » Fri Oct 18, 2024 6:34 am

Hi stoney123,
Adding these parameters to your search should help you get the catalog items you are looking for.

Code: Select all

/catalogs/?CustomFields.CustomField.Name=web-friendly&CustomFields.Value=yes
You can also search for CustomField.ID insted of Name if you have the ID.

Regards
Simpro API Team | Simpro Software Group
stoney123
Posts: 6
Joined: Wed Oct 16, 2024 7:26 am

Re: Query Catalog items & Custom Fields

Post by stoney123 » Tue Oct 22, 2024 10:29 am

Hi

This works perfectly, thank you!

I couldn't find this in the documentation under search query parameters, this might be helpful to add for other users (https://developer.simprogroup.com/apido ... 393873009b)

Thanks again for your help.
Post Reply