topic Re: API endpoint to retrieve Course info in APIs & Integrations

API endpoint to retrieve Course info

PTancredi — Wed, 05 Feb 2025 17:34:32 GMT

I'm looking to retreive information about the new Course object. I've found its endpoint at /crm/v3/objects/0-410 but the only properties returned are the create date, modified date, and id.

Is there any way to get additional properties (like name)?

Thanks

Re: API endpoint to retrieve Course info

SteveHTM — Thu, 06 Feb 2025 03:06:30 GMT

@PTancredi - Thanks for the question here, as this is a common concern. When you retrive the details of a given record, whatever the object type, you should also include in the API call a comma seperated list of the property names (internal names) that you would like returned as a part of the result.

I hope this helps.

Steve

Re: API endpoint to retrieve Course info

GRajput — Thu, 06 Feb 2025 09:31:05 GMT

Hi @PTancredi

I believe you have created a Custom object named Course and want to read all its properties. What you can do is add properties' internal name to get their details like I have used SKU and quantity in the curl provided below

curl --request GET \ --url 'https://api.hubapi.com/crm/v3/objects/objectType?limit=10&properties=sku&properties=quantity&archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN'

I hope this will help you out. Please mark it as Solution Accepted and upvote to help another Community member.
Thanks!

Re: API endpoint to retrieve Course info

PTancredi — Tue, 11 Feb 2025 18:18:51 GMT

Thanks, this is what I needed

Re: API endpoint to retrieve Course info

PTancredi — Tue, 11 Feb 2025 18:41:16 GMT

This is good info and feels like it should work but didn't actually work for me. I would expect the following call to return the "days" property but it doesn't. I tried several fields, both internal and external names, and still just get

https://api.hubapi.com/crm/v3/objects/0-410?property=days&archived=false

It still just returns these standard three properties for each item:

"properties": {

"hs_createdate": "2024-11-21T03:44:46.597Z",

"hs_lastmodifieddate": "2024-11-21T04:39:30.067Z",

"hs_object_id": "384802639680"

Re: API endpoint to retrieve Course info

PTancredi — Tue, 11 Feb 2025 19:31:28 GMT

Thanks, that helps but didn't work for me. See my comment to the other response.

Re: API endpoint to retrieve Course info

SteveHTM — Tue, 11 Feb 2025 19:40:02 GMT

"properties" not "property" in teh API string.

Steve

Re: API endpoint to retrieve Course info

PTancredi — Tue, 11 Feb 2025 21:38:55 GMT

Of course! Thanks. Happy (and a little chagrined) it was something simple