Flambe docs
API referenceGrocery lists

List grocery lists

GET
/api/grocery-lists

Authorization

bearerAuth
AuthorizationBearer <token>

A Clerk session JWT. Obtain one with a Clerk frontend SDK (session.getToken()) or, for server-to-server use, with a Clerk machine token. The token's sub claim is the Flambe user id that scopes every request.

In: header

Query Parameters

limit?integer

Maximum items to return.

Range1 <= value <= 200
Default50
cursor?string

Opaque pagination cursor returned as next_cursor by the previous page. Base64-encoded DynamoDB ExclusiveStartKey; treat it as opaque.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/grocery-lists"
{  "grocery_lists": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "user_id": "string",      "name": "Saturday shop",      "type": "manual",      "description": "string",      "archived": false,      "due_date": "2019-08-24",      "items": [        {          "key": "string",          "name": "unsalted butter",          "quantity": 0,          "unit": "string",          "checked": false,          "recipe_id": "fa7d15d4-7670-4586-a94b-5079ed028135",          "aisle": "string"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}