Get a Shopping List
A method to fetch a shopping list.
Returns all available shopping lists for the user. This API available only for user access-token integration.
getGet Shopping Lists
get
https://api.whisk.com/list/v2
Get all lists for user (without list content). Requires shopping_list:read scope
Request
Response
Request
​
Response
200: OK
{"list": [{"id": "string","name": "string","primary": true}],"items": [{"list": {"id": "string","name": "string","primary": true},"item_count": 0,"grouped_item_count": 0}]}
401: Unauthorized
{"code": "auth.tokenRequired"}
"list": [{"id": "string","name": "string","primary": true}],
ATTRIBUTE | TYPE | DESCRIPTION |
lists* | array [ListsItemResponse] | ​ |
id | string | ​ |
primary | bool | ​ |
"items": [{"list": {"id": "string","name": "string","primary": true},"item_count": 0,"grouped_item_count": 0}]
ATTRIBUTE | TYPE | DESCRIPTION |
id* | string | ​ |
name* | string | ​ |
count | integer | The number of items in the Shopping List |
createdTime* | datetime | The time the Shopping List was created. |
updatedTime* | datetime | ​ |
curl "https://api.whisk.com/list/v2" \-H "Accept: application/json" \-H "Authorization: Bearer <User-Access-Token>"
Last updated 3 months ago