Skip to content
SHAMPOO

Tool catalogue

scratch_list

Read · Ordinary · Tasks and notes

scratch_list

  • Category: tasks
  • Access: read
  • Audience: ordinary (an ordinary user normally calls this directly)

Purpose

List own scratch notes (label/project filter).

Arguments

Optional: include_archived, label, limit, project.

  • include_archived. Note: Include archived (default false).
  • label. Note: Optional substring filter.
  • limit. Note: Max rows (1-200, default 50).
  • project. Note: Optional project context filter.

Result

JSON object with scratch array.

Boundaries

Owner-private: owner credential only, no star bypass. Misses and foreign rows read as not found. Project is context, never a sharing scope.

Lifecycle / side effects

Active <-> archived; lifecycle only, no delete verb exists.

Errors

Bad ids/transitions rejected. Failures move nothing (atomic).

Example

{}

Result shape:

{
  "scratch": []
}

See also

scratch_get.

On this page