HubSpot API / Get value of "hs_lead_status" in contacts list


#1

Hello!

When I make a request to the URL “GET / contacts / v1 / lists / all / contacts / all” I get a list of contacts with the data.
But, not all the information displayed.
I want to get the value parameter “hs_lead_status” (see: http://screencast.com/t/gpANpFIPco65).
This can be done?

Please help resolve the issue.

Thanks,
Alexey


#2

Hi @Alexey_Maksimov

You can include specific properties in the response using the property= parameter in the request URL. You can include the parameter multiple times to include multiple properties.

https://api.hubapi.com/contacts/v1/lists/all/contacts/all?hapikey=demo&property=email&property=createdate


#3

Hi @David

I want to get the value of “Lead Status”, when requesting a list of contacts.
for example :

I tried to add different parameters in the query.
But the parameter “Lead Status” could not get.


#4

You need to make sure that you’re using the name (not the label) for the property, but otherwise you’d just need to add that to the URL:

https://api.hubapi.com/contacts/v1/lists/all/contacts/all?hapikey=demo&property=email&property=createdate&property=hs_lead_status

Keep in mind that contacts will only include that property if they have a value set, so it’s possible that new records without a status won’t have that property.


#5

Hi @David
Thanks for the answer.
I would like to ask one more question.

The authentication method ( OAuth or API keys) can affect to the parameter “hs_lead_status”?


#6

The authentication method shouldn’t affect the call, you’d be able to get that property with either an API key or OAuth token.