topic Re: Read all data from Custom Object in APIs & Integrations

Read all data from Custom Object

shlahman — Mon, 13 Sep 2021 17:28:43 GMT

Hello,

Anyone can please advise how can I use the API in order to read all data from a Custom Object?

Thanks

Ariel

Re: Read all data from Custom Object

Teun — Mon, 13 Sep 2021 17:39:32 GMT

Hi!

What do you want to read? Do you need the name and ID? The association's between your custom object and other objects or simply all records the custom object has?
If you check the docs, you can find all endpoints that you need. You also have a 'run in postman' option that imports a collection with great examples.

https://developers.hubspot.com/docs/api/crm/crm-custom-objects

Re: Read all data from Custom Object

shlahman — Mon, 13 Sep 2021 17:43:34 GMT

Hi Teun,

Thanks for getting back to me so fast!

I would like to read the object data (not metadata) with all fields that avilabile in this object. Is there an option to read all the object data without providing specific ID?

Thanks,

Ariel

Re: Read all data from Custom Object

Teun — Mon, 13 Sep 2021 17:55:40 GMT

You always need the ID of the custom object you are retrieving, you do not need the record ID. If you need all properties the object has, you can retrieve its schema.
I am having issues opening the docs right now, but there is an example available in the overview of the docs.

Re: Read all data from Custom Object

webdew — Tue, 14 Sep 2021 12:33:07 GMT

Hi @shlahman ,

You can use this documentation regarding custom object for fetch all data :
Link : https://developers.hubspot.com/docs/api/crm/crm-custom-objects

This link will also help you regarding custom object
Link : https://www.webdew.com/blog/create-custom-objects-in-hubspot-using-api

<?php
$URL = 'https://api.hubapi.com/crm/v3/schemas/p<PORTALID>_<CUSTOMOBJECTKEY>?portalId=<PORTALID>';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $URL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = array();
$headers[] = 'Content-Type: application/json';

curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$result = curl_exec($ch);

if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
}
curl_close($ch);

return $result;
?>

Hope this helps!

If we were able to answer your query, kindly help the community by marking it as a solution.

Thanks and Regard.

Re: Read all data from Custom Object

AÖzkara — Mon, 25 Jul 2022 14:56:41 GMT

hi,

I am facing same issue about reading all record data from custom object. I have custom object id and I dont neet its scheme. I need its records.

I couldnt find the righht endpoint for this issue.

Could you help me about it?

Thanks.

Re: Read all data from Custom Object

DTyshetskyy — Sun, 18 Sep 2022 21:53:17 GMT

Hi guys, any update on this?
/crm/v3/schemas/{objectTypeId} mentioned in the doc, is only providing the schema for the object - metadata. Tried to run crm/v3/objects/{objectTypeId} - provides very basic info about the object with created_time etc. - no actual data

Re: Read all data from Custom Object

mwx_kk — Mon, 10 Oct 2022 11:58:04 GMT

Hi Teun,

I am facing the same issue: the docs linked above only describe how to retrieve meta-data from a custom object. What I need — the others here, too — is the data itself hold by the custom object.
Let's think of HubDB: requesting HubDB delivers the columns of a table. But when I need the data hold by that table I have to request its rows.
So, how do we get the data hold by a custom object?

Thanks in advance.

Betreff: Read all data from Custom Object

mwx_kk — Tue, 11 Oct 2022 06:26:10 GMT

Hi guys,

here is how I finally got my data:

Retrieve the schema of your custom object, i.e. /crm/v3/schemas/objectTypeId, there you find properties used by the data you want to get
Extract the name of each property and create a querystring for later use, like so "&properties=firstname&properties=lastname..."
Retrieve the object from /crm/v3/objects/objectTypeId, it holds the IDs of each data-set
Retrieve your data for each object-ID, like so: /crm/v3/objects/objectTypeId/objectId?portalId=1234567&properties=firstname&properties=lastname
Push each response.data in an array and use sendRequest to deliver it to your frontend

Re: Read all data from Custom Object

cowles123 — Tue, 18 Oct 2022 20:45:01 GMT

I believe I found the solution (they might have just added it).

You can find it within the object section of the custom object page (https://developers.hubspot.com/docs/api/crm/crm-custom-objects).
Go to /crm/v3/objects/{objectType}

Here you just need to add the custom object's internal name or the custom object's ID.

As some people have mentioned, they can only see metadata. To see additional data you need to specify the additional fields (internal name). See the picture below.

Re: Read all data from Custom Object

mwx_kk — Fri, 28 Oct 2022 05:56:04 GMT

Hey @cowles123 you are absolutely right. This is the right endpoint and one has to explicitly add all properties one wants to see. In the documentation one has to open "see all params" to find the properties param. Kind of weird ...

Thanks for your help. 😀

Re: Read all data from Custom Object

VStruyf — Mon, 31 Oct 2022 09:25:13 GMT

I also want to find all the data for a custom object, but I get the following error:

The scope needed for this API call isn't available for public use. If you have questions, contact support or post in our developer forum.

I use the endpoint: /crm/v3/objects/{objectType}

Re: Read all data from Custom Object

mwx_kk — Mon, 31 Oct 2022 09:30:12 GMT

Hi @VStruyf ,

seems you have to add either the scope to your private app key or you haven't the key present in your serverless function.

Re: Read all data from Custom Object

VStruyf — Mon, 31 Oct 2022 09:32:41 GMT

Which scope should be selected?

I also have the error when I try it here with the test call: https://developers.hubspot.com/docs/api/crm/crm-custom-objects

Re: Read all data from Custom Object

mwx_kk — Mon, 31 Oct 2022 09:36:54 GMT

You need at least these to request custom object:
crm.schemas.custom.read, crm.objects.custom.read

Re: Read all data from Custom Object

VStruyf — Mon, 31 Oct 2022 09:38:50 GMT

They are both selected.

Re: Read all data from Custom Object

mwx_kk — Mon, 31 Oct 2022 09:43:10 GMT

So, if you need other than these two scopes, select then.
Then update your secret, because the scope is encoded in that key.
And make sure to process.env your key in your serverless function and provide it in headers.

Re: Read all data from Custom Object

VStruyf — Mon, 31 Oct 2022 09:55:17 GMT

Still not working... and I don't see why

Re: Read all data from Custom Object

mwx_kk — Mon, 31 Oct 2022 10:42:49 GMT

Still the scope error message? Check all possible scopes you need, and then always update your secret.

Re: Read all data from Custom Object

VStruyf — Mon, 31 Oct 2022 12:21:35 GMT

Yes, still the same. These are the scopes I selected:

crm.lists.read
crm.objects.contacts.read
crm.schemas.custom.read
crm.objects.custom.read
crm.schemas.custom.write
crm.schemas.contacts.read