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

Highlighted
New Member

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

Reply
0 Upvotes
5 Replies 5
Highlighted
HubSpot Moderator

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=creat...

Reply
0 Upvotes
Highlighted
New Member

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.

Reply
0 Upvotes
Highlighted
HubSpot Moderator

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=creat...

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.

Reply
0 Upvotes
Highlighted
New Member

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”?

Reply
0 Upvotes
Highlighted
HubSpot Moderator

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

Reply
0 Upvotes