latestSwagger 2.02026-08-2193114213.9 KB
ae1e0fe6da1a
properties
Scroll endpoint for properties
Search endpoint has a limitation of 50_000 items that can be fetched. When we need to scroll out of this limit, we must use this specific endpoint. Use it if you need to iterate across all of your entities. Use the param "with_total=true" only on the first call, we have an optimisation that increases response when this attribute is unused It does not accept search parameters that are not mentioned in the documentation.
get/properties/scroll
Query parameters
with_totalboolean
Show the total count of entities
updated_at_fromstring date
Use to limit the earliest updated_at value for the entities list
updated_at_tostring date
Use to limit the latest updated_at value for the entities list
scroll_idstring
Pointer to the next page. You must use the data attribute of the previous response to correctly reach the next page.
perinteger
Entities per page
Response
Scroll endpoint for properties