Flambe docs
API referenceHouseholds

Share a resource into a household

POST
/api/households/{id}/library/{resourceType}

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
Formatuuid
resourceType*string

Value in

  • "recipe"
  • "collection"
  • "mealplan"
  • "grocerylist"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/households/497f6eca-6276-4993-bfeb-53cbbbba6f08/library/recipe" \  -H "Content-Type: application/json" \  -d '{    "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f"  }'
{  "success": true}

Get sharing preferences GET

The caller's defaults for this household — for example, whether newly created recipes are shared automatically.

Leave a shared collection POST

Removes the caller's access to a collection that was shared with them. The owner's copy is untouched. Owners cannot leave their own collection — delete it instead.