Get Home
GET/v1/home
Read the home briefing for the caller's selected brands and channels. Vendor and product blocks appear only when the caller has their corresponding read access.
Requires home.read.
Request and response fields at a glance
- Query parameters:
brandIds(array),saleChannelIds(array). - 200 response (application/json):
checkedAt(string, required),meta(object, required),sources(object, required),pulse(mixed, required),money(mixed, required),wholesale(mixed, required),retail(mixed, required),products(mixed, required),channels(array, required).