Tools

FriendChise includes a set of built-in operational tools for franchise teams. These endpoints expose the tool data to authenticated org members.

Get tools by kind

GET /api/orgs/[orgId]/task-tools?kind=[conversion|item-list|roster]

Returns all tools of a given kind for the organization.

Authentication

Requires org membership.

Query parameters

Response

{
  "items": [ ... ]
}

The shape of each item in items depends on kind:

• conversion — unit conversion sets (e.g. weight, volume, temperature)
• item-list — named item lists for inventory, prep, or ordering
• roster — roster templates for scheduling

Errors

List tool items (item list — paginated)

GET /api/orgs/[orgId]/tools/item-list

Returns a paginated list of items from the organization's item-list tool. Includes signed image URLs for items that have images.

Authentication

Requires org membership.

Query parameters

Response

{
  "items": [
    {
      "id": "item_01abc",
      "name": "Bread Flour",
      "unit": "kg",
      "imgUrl": "orgs/org_01abc/tools/item_01abc.jpg",
      "imageSignedUrl": "https://supabase.co/..."
    }
  ],
  "totalCount": 18,
  "totalPages": 1,
  "page": 1,
  "pageSize": 24,
  "search": ""
}

imageSignedUrl is null if the item has no image.

Get scan-to-task history

GET /api/orgs/[orgId]/tools/scan-to-task/history

Returns a cursor-paginated list of previous scan-to-task results for the organization, including drafted tasks and potential duplicates.

The scan-to-task feature processes an uploaded document or photo with an AI model and extracts a draft task (title, description, steps). This endpoint returns the results of past scans.

Authentication

Requires MANAGE_TASKS permission in the org.

Query parameters

Response

{
  "results": [
    {
      "id": "scan_01abc",
      "batchId": "batch_01abc",
      "fileName": "recipe-card.jpg",
      "fileKind": "image",
      "fileSize": 204800,
      "draft": {
        "title": "Vanilla Custard Filling",
        "description": "Whisk egg yolks and sugar...",
        "sourceText": "From the original recipe card."
      },
      "error": null,
      "taskId": null,
      "createdAt": "2026-08-15T14:30:00.000Z",
      "updatedAt": "2026-08-15T14:30:01.000Z",
      "duplicateCandidates": [
        {
          "taskId": "tsk_existing",
          "title": "Custard Filling",
          "score": 0.89
        }
      ]
    }
  ],
  "nextCursor": "scan_last_id"
}

Errors

Menu items (public)

GET /api/menu/[token]/items

Returns the items on a publicly shared menu. This endpoint does not require authentication — it is accessible to anyone with a valid menu token.

Path parameters

Response

Paginated list of menu items with signed image URLs.

{
  "items": [
    {
      "id": "item_01abc",
      "name": "Original Glazed",
      "description": "Classic yeast doughnut with vanilla glaze.",
      "imageSignedUrl": "https://..."
    }
  ],
  "totalCount": 12
}

Errors

AI Scan to Task

The scan-to-task workflow is now available through mobile-facing REST endpoints:

• POST /api/orgs/[orgId]/tools/scan-to-task/upload-url — MANAGE_TASKS, accepts { fileName, mimeType }, returns { signedUrl, path }, and reports 400, 401, 403, or 500 when signing fails.
• POST /api/orgs/[orgId]/tools/scan-to-task — MANAGE_TASKS, accepts { sources, instruction? }, returns { results }, and reports 400, 401, 403, 415, 429, or 500 on scan failure. Demo-limit responses return { "error": "Sign up to continue using this feature." }.
• POST /api/orgs/[orgId]/tools/scan-to-task/confirm — MANAGE_TASKS, accepts { resultId, fileName, title, description, summary, durationMin, peopleRequired, minWaitDays, maxWaitDays } with optional color and sourceText, returns 200 { taskId, resultId }, and can return 400, 403, 409, or 500.
• POST /api/orgs/[orgId]/tools/scan-to-task/clear — MANAGE_TASKS, accepts { resultId }, returns 200 { ok: true } when the scan result is cleared, and can return 400, 403, 404, or 500 if the payload is invalid, the caller lacks access, the result is missing, or the server errors.

See scan-to-task history for the results endpoint that is already available.