API referenceHouseholds
List the shared library
Every resource shared into the household, by any member.
Every resource shared into the household, by any member.
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
Path Parameters
id*string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/households/497f6eca-6276-4993-bfeb-53cbbbba6f08/library"{ "recipes": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user_id": "string", "title": "Brown Butter Chocolate Chip Cookies", "subtitle": "string", "description": "string", "notes": "", "tags": [ "dessert", "cookies" ], "ingredients": [ { "name": "all-purpose flour", "quantity": 2.5, "unit": "cups", "preparation": "sifted", "isOptional": false } ], "components": [ { "title": "Brown butter frosting", "description": "string", "notes": "string", "ingredients": [ { "name": "all-purpose flour", "quantity": 2.5, "unit": "cups", "preparation": "sifted", "isOptional": false } ], "instructions": [ "string" ] } ], "instructions": [ "string" ], "media": [ { "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767", "url": "http://example.com", "blur_hash": "string", "width": 0, "height": 0, "kind": "image" } ], "blur_hash": "string", "prep_time": 20, "cook_time": 12, "servings": 24, "difficulty": "easy", "rating": 0, "source_section": "string", "nutrition": { "calories": 0, "protein_g": 0, "fat_g": 0, "carbs_g": 0, "fiber_g": 0, "sugar_g": 0, "sodium_mg": 0, "per": "serving", "computed_at": "2019-08-24T14:15:22Z", "ingredients_hash": "string" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "collections": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user_id": "string", "name": "Weeknight dinners", "description": "string", "tags": [ "string" ], "recipes": [ "155ee1a9-63d3-4337-b4f5-95f5f75336c1" ], "recipe_count": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "mealplans": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user_id": "string", "name": "Week of Sep 14", "description": "string", "end_date": "2019-08-24", "meals": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "Dinner", "start_time": "18:00", "end_time": "19:30", "days_of_week": [ 0 ], "items": [ { "recipe_id": "fa7d15d4-7670-4586-a94b-5079ed028135", "name": "string", "portion": 0, "nutrition": { "calories": 0, "protein_g": 0, "fat_g": 0, "carbs_g": 0, "fiber_g": 0, "sugar_g": 0, "sodium_mg": 0, "per": "serving", "computed_at": "2019-08-24T14:15:22Z", "ingredients_hash": "string" } } ], "notes": "string", "nutrition": { "calories": 0, "protein_g": 0, "fat_g": 0, "carbs_g": 0, "fiber_g": 0, "sugar_g": 0, "sodium_mg": 0, "per": "serving", "computed_at": "2019-08-24T14:15:22Z", "ingredients_hash": "string" } } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "grocerylists": [ { "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" } ]}