Where do I find the syntax to make an api call to a custom field?

MikeM2
Member

Where do I find the syntax to make an api call to a custom field?   We created our own Organization_Status field which has a number of values (Status 1, Status 2, & Status 3 - to keep things simple. I got some basic customer information about all customers using the call "HUBSPOT's_API PREFIX & /contacts/v1/lists/all/contacts/all?hapikey= & MY KEY"   but I don't see the custom status values we created in the restults of that call.  

 

Thanks

 

0 Upvotes
1 Reply 1
dennisedson
Community Manager

Hello @MikeM2 !

If you go to the documentation, and look at the property parameter under the optional parameters, you will see that the default is to only pull in a few standard properties.  Any additional properties will need to be added to the request sent. 

Using your custom property name, it would look something like this

https://api.hubapi.com/contacts/v1/lists/all/contacts/all?hapikey=xxxxx&property=Organization_Status

 

Hope this helps!

 

 

Thanks,

Dennis




Check out our Community Developer Blog
where we feature our Community driven developer podcast and how to content
0 Upvotes