Private preview of the new site. Not live.

properties.list

Service addresses of a customer, or every property of a shop.

WhoAgents can call this
RESTGET /v1/properties
MCP toolproperties_list
Writesno
AreaCustomers

When to use it

Service addresses of a customer, or every property of a shop.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
shop_idstring (uuid)no
customer_idstring (uuid)no
include_archivedbooleanno
limitintegerno
cursorstringno

Example

GET https://doingwork.work/v1/properties?shop_id=00000000-0000-4000-8000-000000000000&customer_id=00000000-0000-4000-8000-000000000000&include_archived=True&limit=1&cursor=...

Output

JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.