Lists API

Hello.

According to the API documentation, we need to provide an additionalProperties array with property names to get their values in the response.

But where can we get the list of all available properties for the list?

Hello,

According to the Lists API Documentation, it will default return the following properties:
hs_list_size, hs_last_record_added_at, hs_last_record_removed_at, hs_folder_name, and hs_list_reference_count.

For any other properties that you may want to add, you can check what list properties you have set up by going to your settings >> Data Management >> Properties, and then select the List Object.

Let me know if this helps, or if you have any other questions!


:check_mark: Was I able to help answer your question? Help the community by marking it as a solution.

Brandon Woodruff
Senior Software Developer @ PearagonStill have questions? Reach out at brandon@pearagon.com

Hey, @05629 can you link me to the specific doc you are working with, please? I want to make sure that I am looking at the same info you are. Thank you! — Jaycee

Hi @05629,

This is the endpoint to retrieve all properties. However, if you pass “lists” in {objectType} (as you would for contacts or companies), You won’t be able to retrieve the list of properties.

I found a workaround and wanted to share it with you: instead of passing “lists” in {objectType}, pass the “lists” object ID (0-45) — and you’ll see the magic happen.

Best regards,
Mohd Israr

Thanks a lot! That works.
I also tried this, but wasn’t able to find an object ID for the list. Is it in the docs?Can you share a link, please?

No, this is not mentioned in the docs. These are my own findings