topic Get Custom Object by Id in CMS Development

Get Custom Object by Id

DTyshetskyy — Sun, 18 Sep 2022 23:53:22 GMT

Hi,

I am working with the custom objects and trying to ingest the whole object by id. Can't seem to be able to identify the way to do it.

The steaps are following:

1. getting the objectTypeId by calling:

https://api.hubapi.com/crm/v3/schemas

2. obtaining the list of objects under that category: https://api.hubapi.com/crm/v3/objects/<objectTypeId>

3. Trying to get the full custom object with all properties by calling:

https://api.hubapi.com/crm/v3/objects/<objectTypeId>/id

However as a result I am getting following response:
{
"id": "<id>",
"properties": {
"hs_createdate": "2022-09-15T22:28:55.910Z",
"hs_lastmodifieddate": "2022-09-15T22:28:55.910Z",
"hs_object_id": "<another_id>"
},
"createdAt": "2022-09-15T22:28:55.910Z",
"updatedAt": "2022-09-15T22:28:55.910Z",
"archived": false
}

What am I missing? The Custom object doc doesn't really explain this part of API much which is quite strange

Re: Get Custom Object by Id

LMeert — Mon, 19 Sep 2022 14:21:13 GMT

Hi @DTyshetskyy,

I think you've done most of the job there.
You're probably missing this simple thing : specify the list of properties you'd like to receive.

Have a look at the custom objects endpoint, when using the GET you need to add, as a query parameter, the list of properties you want the call to return :

Try to do the same for your your custom object records and you should get there!

Hope this helps !
If it does, please consider marking this answer as a solution 🙂

Best,

Ludwig

Re: Get Custom Object by Id

DTyshetskyy — Thu, 22 Sep 2022 21:50:39 GMT

Hi Ludwig,

Thank you for the reply.

It did work however the challenge for us is that we have fairly large custom objects with 100+ properties and the approach with passing every property name is quite a tedious one. On top of that it makes it unnecessarily diffucult to assemble the object from the response. Is it because you can't de-serialize the objects as a whole and require an explicit name?

Re: Get Custom Object by Id

LMeert — Fri, 23 Sep 2022 07:04:22 GMT

Hi @DTyshetskyy,

If you need to get the entire object, then it would make sense to interrogate the object schema first, and from that response, take the properties list and pass it in the get object by id call.

This way you don't have to put up with building the call by listing the properties yourself.

Now regarding the structure of the response, I agree this doesn not make reassembling the object easy, but I really don't think you've got a better shot at this.

Best,

Ludwig

Re: Get Custom Object by Id

DTyshetskyy — Mon, 26 Sep 2022 19:59:31 GMT

Thank you, Ludwig!