Get your Shopping Lists

This endpoint offers you the ability to read reference details of all your shopping lists that exist in your Whisk account.

Get Shopping Lists

GET https://api.studio.whisk.com/list/v2

You can use just the base URL and the authentication header to retrieve basic information of all shopping list stored in your Whisk account:

Headers

Name
Type
Description

Authentication

string

User Access token with shopping_list:read scope to to authorize the API usage. For more information, see Authentication.

{
  "list": [
    {
      "id": "string",
      "name": "string",
      "primary": true
    }
  ],
  "items": [
    {
      "list": {
        "id": "string",
        "name": "string",
        "primary": true
      },
      "item_count": 0,
      "grouped_item_count": 0
    }
  ]
}

Sample Request and Response

curl -X GET "https://api.whisk.com/list/v2"
    -H "Accept: application/json" 
    -H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"

Last updated

Was this helpful?